Skip to content

Commit

Permalink
AEnsure rules conflicting with Prettier are always turned off.
Browse files Browse the repository at this point in the history
  • Loading branch information
mmeij committed Jun 12, 2021
1 parent 5db3db6 commit 89439fa
Show file tree
Hide file tree
Showing 7 changed files with 27 additions and 7 deletions.
3 changes: 2 additions & 1 deletion base.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ module.exports = {
// @TODO: Consider configuring https://www.npmjs.com/package/eslint-plugin-jsdoc
// @TODO: Consider configuring https://www.npmjs.com/package/eslint-plugin-eslint-comments
extends: [
'./rules/prettier',
'./rules/base',
'./rules/babel',
'./rules/import',
'./rules/import-sort',
// @NOTE: Always extend the Prettier rules last.
'./rules/prettier',
],
// @NOTE: Consider switching back to ESLint's default parser (Espree) once
// it supports class fields.
Expand Down
5 changes: 4 additions & 1 deletion node.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,8 @@ module.exports = {
node: true,
},
// @TODO: Consider configuring https://www.npmjs.com/package/eslint-plugin-node
extends: [],
extends: [
// @NOTE: Always extend the Prettier rules last.
'./rules/prettier',
],
};
7 changes: 6 additions & 1 deletion react.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
module.exports = {
overrides: [
{
extends: ['./rules/react', './rules/react-hooks'],
extends: [
'./rules/react',
'./rules/react-hooks',
// @NOTE: Always extend the Prettier rules last.
'./rules/prettier',
],
files: ['*.jsx', '*.tsx'],
parserOptions: {
babelOptions: {
Expand Down
1 change: 0 additions & 1 deletion rules/base.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ module.exports = {
complexity: ['warn', 20],
'consistent-return': 'error',
'consistent-this': 'off', // @TODO
curly: ['warn', 'all'], // @PRETTIER @AUTOFIX
'default-case-last': 'off', // @TODO
'default-case': 'off',
'default-param-last': 'off', // @TODO
Expand Down
6 changes: 5 additions & 1 deletion rules/prettier.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Rules regarding eslint-plugin-prettier.
// Rules regarding eslint-plugin-prettier and eslint-config-prettier.
// See: https://www.npmjs.com/package/eslint-plugin-prettier
// See: https://www.npmjs.com/package/eslint-config-prettier
module.exports = {
extends: [
// @TODO: See if we can move away from running Prettier through ESLint.
Expand All @@ -9,7 +10,10 @@ module.exports = {
// See: https://github.com/prettier/eslint-plugin-prettier#recommended-configuration
'plugin:prettier/recommended',
],
// @NOTE: Please take extra caution when turning rules back on here as these
// get the final say. Plugins might require them to be turned off.
rules: {
curly: ['warn', 'all'], // @PRETTIER @AUTOFIX
// Override: Warn instead of error on code formatting issues.
'prettier/prettier': 'warn',
},
Expand Down
6 changes: 5 additions & 1 deletion typeinfo.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ module.exports = {
{
// @NOTE: These rules are not included in the default configuration
// because they require project-specific (TypeScript) configuration.
extends: ['./rules/typeinfo'],
extends: [
'./rules/typeinfo',
// @NOTE: Always extend the Prettier rules last.
'./rules/prettier',
],
files: ['*.ts', '*.tsx'],
},
],
Expand Down
6 changes: 5 additions & 1 deletion typescript.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@ module.exports = {
overrides: [
{
// @TODO: Consider configuring https://www.npmjs.com/package/eslint-plugin-tsdoc
extends: ['./rules/typescript'],
extends: [
'./rules/typescript',
// @NOTE: Always extend the Prettier rules last.
'./rules/prettier',
],
files: ['*.ts', '*.tsx'],
// Reconfigure the parser for .ts/.tsx files to support TypeScript.
// Babel's ESLint parser is not used here because it cannot provide
Expand Down

0 comments on commit 89439fa

Please sign in to comment.