[eslint] merge custom rules into a single plugin (#33733)

I'd like to add another custom eslint rule, but there isn't a very good place to do that right now. We have the `eslint-plugin-kibana-custom` package, which is super simple but isn't in the `@kbn` namespace and isn't included in the root eslint config, and `@kbn/eslint-plugin-license-header` is too specific, so I've merged those two packages into `@kbn/eslint-plugin-eslint`, which is a little redundant but allows is to refer to the rules within it as `@kbn/eslint/{rule}`, which feels nice. Thoughts? _**NOTE:**_ merging the eslint rules from the two packages means enabling prettier for the code from `@kbn/eslint-plugin-license-header`, all those changes are made in 42c7da6. [View the changes without the prettier updates](b647f2b...74e07a0)
elastic · Mar 23, 2019 · 96206bd · 96206bd
1 parent 6cbecd2
commit 96206bd
Show file tree

Hide file tree

Showing 41 changed files with 196 additions and 191 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -18,7 +18,6 @@ bower_components
 /src/core/lib/kbn_internal_native_observable
 /packages/*/target
 /packages/eslint-config-kibana
-/packages/eslint-plugin-kibana-custom
 /packages/kbn-es-query/src/kuery/ast/kuery.js
 /packages/kbn-es-query/src/kuery/ast/legacy_kuery.js
 /packages/kbn-pm/dist

diff --git a/.eslintrc.js b/.eslintrc.js
@@ -34,6 +34,7 @@ const ELASTIC_LICENSE_HEADER = `
 
 module.exports = {
   extends: ['@elastic/eslint-config-kibana', '@elastic/eslint-config-kibana/jest'],
+  plugins: ['@kbn/eslint-plugin-eslint'],
 
   settings: {
     'import/resolver': {
@@ -55,7 +56,7 @@ module.exports = {
     {
       files: [
         '.eslintrc.js',
-        'packages/eslint-plugin-kibana-custom/**/*',
+        'packages/kbn-eslint-plugin-eslint/**/*',
         'packages/kbn-config-schema/**/*',
         'packages/kbn-pm/**/*',
         'packages/kbn-es/**/*',
@@ -87,7 +88,7 @@ module.exports = {
     {
       files: ['x-pack/test/functional/apps/**/*', 'x-pack/plugins/apm/**/*'],
       rules: {
-        'kibana-custom/no-default-export': 'off',
+        '@kbn/eslint/no-default-export': 'off',
         'import/no-named-as-default': 'off',
       },
     },
@@ -242,7 +243,7 @@ module.exports = {
         'packages/kbn-plugin-generator/**/*',
         'packages/kbn-plugin-helpers/**/*',
         'packages/kbn-eslint-import-resolver-kibana/**/*',
-        'packages/kbn-eslint-plugin-license-header/**/*',
+        'packages/kbn-eslint-plugin-eslint/**/*',
         'x-pack/gulpfile.js',
         'x-pack/dev-tools/mocha/setup_mocha.js',
         'x-pack/scripts/*',
@@ -267,15 +268,14 @@ module.exports = {
      */
     {
       files: ['**/*.js'],
-      plugins: ['@kbn/eslint-plugin-license-header'],
       rules: {
-        '@kbn/license-header/require-license-header': [
+        '@kbn/eslint/require-license-header': [
           'error',
           {
             license: APACHE_2_0_LICENSE_HEADER,
           },
         ],
-        '@kbn/license-header/disallow-license-headers': [
+        '@kbn/eslint/disallow-license-headers': [
           'error',
           {
             licenses: [ELASTIC_LICENSE_HEADER],
@@ -289,15 +289,14 @@ module.exports = {
      */
     {
       files: ['x-pack/**/*.js'],
-      plugins: ['@kbn/eslint-plugin-license-header'],
       rules: {
-        '@kbn/license-header/require-license-header': [
+        '@kbn/eslint/require-license-header': [
           'error',
           {
             license: ELASTIC_LICENSE_HEADER,
           },
         ],
-        '@kbn/license-header/disallow-license-headers': [
+        '@kbn/eslint/disallow-license-headers': [
           'error',
           {
             licenses: [APACHE_2_0_LICENSE_HEADER],

diff --git a/package.json b/package.json
@@ -254,11 +254,10 @@
     "@babel/parser": "^7.3.4",
     "@babel/types": "^7.3.4",
     "@elastic/eslint-config-kibana": "0.15.0",
-    "@elastic/eslint-plugin-kibana-custom": "1.1.0",
     "@elastic/makelogs": "^4.4.0",
     "@kbn/es": "1.0.0",
     "@kbn/eslint-import-resolver-kibana": "2.0.0",
-    "@kbn/eslint-plugin-license-header": "1.0.0",
+    "@kbn/eslint-plugin-eslint": "1.0.0",
     "@kbn/plugin-generator": "1.0.0",
     "@kbn/test": "1.0.0",
     "@octokit/rest": "^15.10.0",

diff --git a/packages/eslint-plugin-kibana-custom/index.js b/packages/eslint-plugin-kibana-custom/index.js
diff --git a/packages/eslint-plugin-kibana-custom/package.json b/packages/eslint-plugin-kibana-custom/package.json
diff --git a/...ges/eslint-plugin-kibana-custom/README.md → packages/kbn-eslint-plugin-eslint/README.md b/...ges/eslint-plugin-kibana-custom/README.md → packages/kbn-eslint-plugin-eslint/README.md
diff --git a/...kbn-eslint-plugin-license-header/index.js → packages/kbn-eslint-plugin-eslint/index.js b/...kbn-eslint-plugin-license-header/index.js → packages/kbn-eslint-plugin-eslint/index.js
@@ -21,5 +21,6 @@ module.exports = {
   rules: {
     'require-license-header': require('./rules/require_license_header'),
     'disallow-license-headers': require('./rules/disallow_license_headers'),
+    'no-default-export': require('./rules/no_default_export'),
   },
 };
diff --git a/...s/kbn-eslint-plugin-license-header/lib.js → packages/kbn-eslint-plugin-eslint/lib.js b/...s/kbn-eslint-plugin-license-header/lib.js → packages/kbn-eslint-plugin-eslint/lib.js
@@ -31,14 +31,14 @@ exports.normalizeWhitespace = function normalizeWhitespace(string) {
   return string.replace(/\s+/g, ' ');
 };
 
-exports.init = function (context, program, initStep) {
+exports.init = function(context, program, initStep) {
   try {
     return initStep();
   } catch (error) {
     if (error.failedAssertion) {
       context.report({
         node: program,
-        message: error.message
+        message: error.message,
       });
     } else {
       throw error;

diff --git a/...eslint-plugin-license-header/package.json → ...ges/kbn-eslint-plugin-eslint/package.json b/...eslint-plugin-license-header/package.json → ...ges/kbn-eslint-plugin-eslint/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@kbn/eslint-plugin-license-header",
+  "name": "@kbn/eslint-plugin-eslint",
   "version": "1.0.0",
   "private": true,
   "license": "Apache-2.0",

diff --git a/...les/__tests__/disallow_license_headers.js → ...les/__tests__/disallow_license_headers.js b/...les/__tests__/disallow_license_headers.js → ...les/__tests__/disallow_license_headers.js
@@ -21,15 +21,14 @@ const { RuleTester } = require('eslint');
 const rule = require('../disallow_license_headers');
 const dedent = require('dedent');
 
-const RULE_NAME = '@kbn/license-header/disallow-license-headers';
-
 const ruleTester = new RuleTester({
   parser: 'babel-eslint',
   parserOptions: {
-    ecmaVersion: 2015
-  }
+    ecmaVersion: 2015,
+  },
 });
-ruleTester.run(RULE_NAME, rule, {
+
+ruleTester.run('@kbn/eslint/disallow-license-headers', rule, {
   valid: [
     {
       code: dedent`
@@ -38,11 +37,11 @@ ruleTester.run(RULE_NAME, rule, {
         console.log('foo')
       `,
 
-      options: [{
-        licenses: [
-          '// license'
-        ]
-      }],
+      options: [
+        {
+          licenses: ['// license'],
+        },
+      ],
     },
     {
       code: dedent`
@@ -51,12 +50,12 @@ ruleTester.run(RULE_NAME, rule, {
         console.log('foo')
       `,
 
-      options: [{
-        licenses: [
-          '/* license */',
-        ]
-      }],
-    }
+      options: [
+        {
+          licenses: ['/* license */'],
+        },
+      ],
+    },
   ],
 
   invalid: [
@@ -70,8 +69,8 @@ ruleTester.run(RULE_NAME, rule, {
       errors: [
         {
           message: '"licenses" option is required',
-        }
-      ]
+        },
+      ],
     },
 
     // license cannot contain multiple block comments
@@ -80,16 +79,16 @@ ruleTester.run(RULE_NAME, rule, {
         console.log('foo')
       `,
 
-      options: [{
-        licenses: [
-          '/* one *//* two */'
-        ]
-      }],
+      options: [
+        {
+          licenses: ['/* one *//* two */'],
+        },
+      ],
       errors: [
         {
           message: '"licenses[0]" option must only include a single comment',
-        }
-      ]
+        },
+      ],
     },
 
     // license cannot contain multiple line comments
@@ -98,16 +97,16 @@ ruleTester.run(RULE_NAME, rule, {
         console.log('foo')
       `,
 
-      options: [{
-        licenses: [
-          `// one\n// two`
-        ]
-      }],
+      options: [
+        {
+          licenses: [`// one\n// two`],
+        },
+      ],
       errors: [
         {
           message: '"licenses[0]" option must only include a single comment',
-        }
-      ]
+        },
+      ],
     },
 
     // license cannot contain expressions
@@ -116,20 +115,22 @@ ruleTester.run(RULE_NAME, rule, {
         console.log('foo')
       `,
 
-      options: [{
-        licenses: [
-          '// old license',
-          dedent`
+      options: [
+        {
+          licenses: [
+            '// old license',
+            dedent`
             /* license */
             console.log('hello world');
-          `
-        ]
-      }],
+          `,
+          ],
+        },
+      ],
       errors: [
         {
           message: '"licenses[1]" option must only include a single comment',
-        }
-      ]
+        },
+      ],
     },
 
     // license is not a single comment
@@ -138,18 +139,16 @@ ruleTester.run(RULE_NAME, rule, {
         console.log('foo')
       `,
 
-      options: [{
-        licenses: [
-          '// old license',
-          '// older license',
-          `console.log('hello world');`
-        ]
-      }],
+      options: [
+        {
+          licenses: ['// old license', '// older license', `console.log('hello world');`],
+        },
+      ],
       errors: [
         {
           message: '"licenses[2]" option must only include a single comment',
-        }
-      ]
+        },
+      ],
     },
-  ]
+  ],
 });