chore: add prettier (#234)

eslint-community · Dec 9, 2021 · c4fdffe · c4fdffe
1 parent 6d56188
commit c4fdffe
Show file tree

Hide file tree

Showing 72 changed files with 2,495 additions and 1,216 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -2,10 +2,15 @@
 
 module.exports = {
   root: true,
+  parserOptions: {
+    ecmaVersion: 2021,
+    sourceType: 'script',
+  },
   extends: [
     'not-an-aardvark/node',
-    'plugin:unicorn/recommended',
     'plugin:node/recommended',
+    'plugin:prettier/recommended',
+    'plugin:unicorn/recommended',
   ],
   rules: {
     'comma-dangle': [

diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = {
+  singleQuote: true,
+};
diff --git a/build/generate-readme-table.js b/build/generate-readme-table.js
@@ -10,35 +10,47 @@ const END_TABLE_MARKER = '\n<!-- __END AUTOGENERATED TABLE__ -->';
 
 const expectedTableLines = Object.keys(rules)
   .sort()
-  .reduce((lines, ruleId) => {
-    const rule = rules[ruleId];
-
-    lines.push([
-      `[${ruleId}](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/${ruleId}.md)`,
-      rule.meta.docs.recommended ? '✔️' : '',
-      rule.meta.fixable ? '🛠' : '',
-      rule.meta.hasSuggestions ? '💡' : '',
-      rule.meta.docs.description,
-    ].join(' | '));
-
-    return lines;
-  }, ['Name | ✔️ | 🛠 | 💡 | Description', '----- | ----- | ----- | ----- | -----'])
+  .reduce(
+    (lines, ruleId) => {
+      const rule = rules[ruleId];
+
+      lines.push(
+        [
+          `[${ruleId}](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/${ruleId}.md)`,
+          rule.meta.docs.recommended ? '✔️' : '',
+          rule.meta.fixable ? '🛠' : '',
+          rule.meta.hasSuggestions ? '💡' : '',
+          rule.meta.docs.description,
+        ].join(' | ')
+      );
+
+      return lines;
+    },
+    [
+      'Name | ✔️ | 🛠 | 💡 | Description',
+      '----- | ----- | ----- | ----- | -----',
+    ]
+  )
   .join('\n');
 
 const readmeContents = fs.readFileSync(README_LOCATION, 'utf8');
 
 if (!readmeContents.includes(BEGIN_TABLE_MARKER)) {
-  throw new Error(`Could not find '${BEGIN_TABLE_MARKER}' marker in README.md.`);
+  throw new Error(
+    `Could not find '${BEGIN_TABLE_MARKER}' marker in README.md.`
+  );
 }
 
 if (!readmeContents.includes(END_TABLE_MARKER)) {
   throw new Error(`Could not find '${END_TABLE_MARKER}' marker in README.md.`);
 }
 
-const linesStartIndex = readmeContents.indexOf(BEGIN_TABLE_MARKER) + BEGIN_TABLE_MARKER.length;
+const linesStartIndex =
+  readmeContents.indexOf(BEGIN_TABLE_MARKER) + BEGIN_TABLE_MARKER.length;
 const linesEndIndex = readmeContents.indexOf(END_TABLE_MARKER);
 
-const updatedReadmeContents = readmeContents.slice(0, linesStartIndex) +
+const updatedReadmeContents =
+  readmeContents.slice(0, linesStartIndex) +
   expectedTableLines +
   readmeContents.slice(linesEndIndex);
 

diff --git a/docs/rules/fixer-return.md b/docs/rules/fixer-return.md
@@ -14,9 +14,9 @@ Examples of **incorrect** code for this rule:
 /* eslint eslint-plugin/fixer-return: error */
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
-      fix (fixer) {
+      fix(fixer) {
         fixer.insertTextAfter(node, 'foo');
       },
     });
@@ -30,9 +30,9 @@ Examples of **correct** code for this rule:
 /* eslint eslint-plugin/fixer-return: error */
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
-      fix (fixer) {
+      fix(fixer) {
         return fixer.insertTextAfter(node, 'foo');
       },
     });
@@ -44,9 +44,9 @@ module.exports = {
 /* eslint eslint-plugin/fixer-return: error */
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
-      fix (fixer) {
+      fix(fixer) {
         if (foo) {
           return; // no autofix in this situation
         }

diff --git a/docs/rules/meta-property-ordering.md b/docs/rules/meta-property-ordering.md
@@ -15,7 +15,6 @@ This rule has an array option:
 Examples of **incorrect** code for this rule:
 
 ```js
-
 /* eslint eslint-plugin/meta-property-ordering: ["error",
   ["type", "docs", "fixable", "schema", "messages"]
 ] */
@@ -27,7 +26,7 @@ module.exports = {
     type: 'problem',
     fixable: 'code',
   },
-  create () {},
+  create() {},
 };
 
 // invalid; extra properties must be placed afterwards.
@@ -38,7 +37,7 @@ module.exports = {
     docs: '',
     fixable: 'code',
   },
-  create () {},
+  create() {},
 };
 ```
 
@@ -57,7 +56,7 @@ module.exports = {
     messages: ['zoo'],
     fooooooooo: 'foo',
   },
-  create () {},
+  create() {},
 };
 ```
 

diff --git a/docs/rules/no-deprecated-context-methods.md b/docs/rules/no-deprecated-context-methods.md
@@ -37,9 +37,9 @@ Examples of **incorrect** code for this rule:
 
 ```js
 module.exports = {
-  create (context) {
+  create(context) {
     return {
-      Program (ast) {
+      Program(ast) {
         const firstToken = context.getFirstToken(ast);
       },
     };
@@ -51,11 +51,11 @@ Examples of **correct** code for this rule:
 
 ```js
 module.exports = {
-  create (context) {
+  create(context) {
     const sourceCode = context.getSourceCode();
 
     return {
-      Program (ast) {
+      Program(ast) {
         const firstToken = sourceCode.getFirstToken(ast);
       },
     };

diff --git a/docs/rules/no-deprecated-report-api.md b/docs/rules/no-deprecated-report-api.md
@@ -19,18 +19,17 @@ Examples of **incorrect** code for this rule:
 
 ```js
 module.exports = {
-  create (context) {
+  create(context) {
     context.report(node, 'This node is bad.');
   },
 };
-
 ```
 
 Examples of **correct** code for this rule:
 
 ```js
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({ node, message: 'This node is bad.' });
 
     context.report({ node, loc, message: 'This node is bad.' });

diff --git a/docs/rules/no-identical-tests.md b/docs/rules/no-identical-tests.md
@@ -14,10 +14,7 @@ Examples of **incorrect** code for this rule:
 /* eslint eslint-plugin/no-identical-tests: error */
 
 new RuleTester().run('foo', bar, {
-  valid: [
-    { code: 'foo' },
-    { code: 'foo' },
-  ],
+  valid: [{ code: 'foo' }, { code: 'foo' }],
   invalid: [],
 });
 ```
@@ -28,10 +25,7 @@ Examples of **correct** code for this rule:
 /* eslint eslint-plugin/no-identical-tests: error */
 
 new RuleTester().run('foo', bar, {
-  valid: [
-    { code: 'foo' },
-    { code: 'bar' },
-  ],
+  valid: [{ code: 'foo' }, { code: 'bar' }],
   invalid: [],
 });
 ```

diff --git a/docs/rules/no-missing-placeholders.md b/docs/rules/no-missing-placeholders.md
@@ -26,7 +26,7 @@ Examples of **incorrect** code for this rule:
 /* eslint eslint-plugin/no-missing-placeholders: error*/
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
       node,
       message: '{{something}} is wrong.',
@@ -49,7 +49,7 @@ Examples of **correct** code for this rule:
 /* eslint eslint-plugin/no-missing-placeholders: error*/
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
       node,
       message: 'something is wrong.',

diff --git a/docs/rules/no-only-tests.md b/docs/rules/no-only-tests.md
@@ -30,7 +30,9 @@ ruleTester.run('my-rule', myRule, {
     {
       code: 'const invalid = 42;',
       only: true,
-      errors: [/* ... */],
+      errors: [
+        /* ... */
+      ],
     },
   ],
 });
@@ -45,14 +47,13 @@ const { RuleTester } = require('eslint');
 const ruleTester = new RuleTester();
 
 ruleTester.run('my-rule', myRule, {
-  valid: [
-    'const valid = 42;',
-    { code: 'const valid = 42;' },
-  ],
+  valid: ['const valid = 42;', { code: 'const valid = 42;' }],
   invalid: [
     {
       code: 'const invalid = 42;',
-      errors: [/* ... */],
+      errors: [
+        /* ... */
+      ],
     },
   ],
 });

diff --git a/docs/rules/no-unused-placeholders.md b/docs/rules/no-unused-placeholders.md
@@ -14,7 +14,7 @@ Examples of **incorrect** code for this rule:
 /* eslint eslint-plugin/no-unused-placeholders: error*/
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
       node,
       message: 'something is wrong.',
@@ -32,7 +32,7 @@ Examples of **correct** code for this rule:
 /* eslint eslint-plugin/no-unused-placeholders: error*/
 
 module.exports = {
-  create (context) {
+  create(context) {
     context.report({
       node,
       message: 'something is wrong.',

diff --git a/docs/rules/no-useless-token-range.md b/docs/rules/no-useless-token-range.md
@@ -16,7 +16,7 @@ Examples of **incorrect** code for this rule:
 /* eslint eslint-plugin/no-useless-token-range: error */
 
 module.exports = {
-  create (context) {
+  create(context) {
     const sourceCode = context.getSourceCode();
 
     const rangeStart = sourceCode.getFirstToken(node).range[0];
@@ -31,7 +31,7 @@ Examples of **correct** code for this rule:
 /* eslint eslint-plugin/no-useless-token-range: error */
 
 module.exports = {
-  create (context) {
+  create(context) {
     const sourceCode = context.getSourceCode();
 
     const rangeStart = node.range[0];

diff --git a/docs/rules/prefer-message-ids.md b/docs/rules/prefer-message-ids.md
@@ -15,9 +15,9 @@ Examples of **incorrect** code for this rule:
 /* eslint eslint-plugin/prefer-message-ids: error */
 
 module.exports = {
-  create (context) {
+  create(context) {
     return {
-      CallExpression (node) {
+      CallExpression(node) {
         context.report({
           node,
           message: 'Some error message.',
@@ -39,9 +39,9 @@ module.exports = {
       someMessageId: 'Some error message',
     },
   },
-  create (context) {
+  create(context) {
     return {
-      CallExpression (node) {
+      CallExpression(node) {
         context.report({
           node,
           messageId: 'someMessageId',