fix: add cjs override for esm projects (fixes #59) #63
Conversation
aladdin-add
changed the title
globals: module in generated .eslintrc.js (fixes #59)/* globals module*/ in generated .eslintrc.js (fixes #59)
lib/init/config-file.js
Outdated
| @@ -83,7 +83,7 @@ async function writeYAMLConfigFile(config, filePath) { | |||
| async function writeJSConfigFile(config, filePath) { | |||
| debug(`Writing JS config file: ${filePath}`); | |||
|
|
|||
| const stringifiedContent = `module.exports = ${stringify(config, { cmp: sortByKey, space: 4 })}\n`; | |||
| const stringifiedContent = `/* globals module */\nmodule.exports = ${stringify(config, { cmp: sortByKey, space: 4 })}\n`; | |||
There was a problem hiding this comment.
If we add /* globals module */ unconditionally, then the user will get the A config file was generated, but the config file itself may not follow your linting rules. message we're trying to avoid, this time if they choose What type of modules does your project use? · commonjs because of the no-redeclare rule.
There was a problem hiding this comment.
I'm having a hard time understanding what you're saying here.
The error message is always output for JS config files, I don't think the point was to eliminate that message. The point was to eliminate a linting error.
Are you saying something else is already declaring module?
There was a problem hiding this comment.
yes, it's happening when
globals: {module: true}orenv: { commonjs: true}- rule
no-redeclarewas enabled
In this case, it will introduce a new linting error.
There was a problem hiding this comment.
I can see a few options to resolve it:
- adding
/*eslint env: node*/, the drawback is thatenvwill go away in the new config. - adding
/* eslint-disable-next-line no-undef*/. the comment will be removed by the fixer if the gloabalmodulehas been declared in the eslintrc, e.g.eslint-config-airbnb. - adding a config item for the
.eslintrc.cjs, something like
module.exports = {
...,
overrides: [{files: [".eslintrc.cjs"], globals: {"module": true}}],
};There was a problem hiding this comment.
Solution 3 with overrides sounds good to me.
see the discussion: #59 (comment)
aladdin-add
changed the title
/* globals module*/ in generated .eslintrc.js (fixes #59)
aladdin-add
force-pushed
the
issue59
branch
2 times, most recently
from
8c285e1
to
e84bfaa
Compare
see the discussion: #59 (comment)