@huangjunsen/eslint-config 1.0.0 → 1.0.2

package/__tests__/validate-js-configs.test.js

@@ -1,259 +1,259 @@
-/**
- * 验证 JS
- */
-
-const assert = require('assert');
-const eslint = require('eslint');
-const path = require('path');
-const sumBy = require('lodash/sumBy');
-
-function isObject(obj) {
-  return typeof obj === 'object' && obj !== null;
-}
-
-describe('Validate JS configs', () => {
-  it('Validate eslint-config-encode', async () => {
-    const configPath = './index.js';
-    const filePath = path.join(__dirname, './fixtures/index.js');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false, // 如果不关这个参数，会将目录下的 eslintrc 与 overrideConfigFile merge
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.notEqual(sumBy(results, 'errorCount'), 0);
-    assert.notEqual(sumBy(results, 'warningCount'), 0);
-  });
-
-  it('Validate eslint-config-encode/es5', async () => {
-    const configPath = './es5.js';
-    const filePath = path.join(__dirname, './fixtures/es5.js');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.notEqual(sumBy(results, 'errorCount'), 0);
-    assert.equal(sumBy(results, 'warningCount'), 0);
-
-    // 验证 es5 覆盖的规则是否正常，取 comma-dangle 进行测试
-    const { messages } = results[0];
-    const errorReportedByReactPlugin = messages.filter((result) => {
-      return result.ruleId === 'comma-dangle';
-    });
-    assert.notEqual(errorReportedByReactPlugin.length, 0);
-  });
-
-  it('Validate eslint-config-encode/vue', async () => {
-    const configPath = './vue.js';
-    const filePath = path.join(__dirname, './fixtures/vue.vue');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.notEqual(sumBy(results, 'errorCount'), 0);
-    assert.equal(sumBy(results, 'warningCount'), 0);
-
-    // 验证 eslint-plugin-vue 工作是否正常
-    const { messages } = results[0];
-    const errorReportedByReactPlugin = messages.filter((result) => {
-      return result.ruleId && result.ruleId.indexOf('vue/') !== -1;
-    });
-    assert.notEqual(errorReportedByReactPlugin.length, 0);
-  });
-
-  it('Validate eslint-config-encode/essential', async () => {
-    const configPath = './essential/index.js';
-    const filePath = path.join(__dirname, './fixtures/index.js');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.equal(sumBy(results, 'errorCount'), 0);
-    assert.notEqual(sumBy(results, 'warningCount'), 0);
-
-    // 验证黑名单中的规则已关闭
-    const { messages } = results[0];
-
-    // 验证 semi 被关闭
-    const semiErrors = messages.filter((result) => {
-      return result.ruleId === 'semi';
-    });
-    assert.equal(semiErrors.length, 0);
-
-    // 验证 comma-spacing 被降级
-    const commaSpacingErrors = messages.filter((result) => {
-      return result.ruleId === 'comma-spacing';
-    });
-    assert.equal(commaSpacingErrors[0].severity, 1);
-  });
-
-  it('Validate eslint-config-encode/essential/es5', async () => {
-    const configPath = './essential/es5.js';
-    const filePath = path.join(__dirname, './fixtures/es5.js');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.notEqual(sumBy(results, 'errorCount'), 0);
-    assert.notEqual(sumBy(results, 'warningCount'), 0);
-    // 验证 es5 覆盖的规则是否正常，取 comma-dangle 进行测试
-    const { messages } = results[0];
-    const errorReportedByReactPlugin = messages.filter((result) => {
-      return result.ruleId === 'comma-dangle';
-    });
-    assert.notEqual(errorReportedByReactPlugin.length, 0);
-
-    // 验证黑名单中的规则已关闭，取 semi 进行测试
-    const errorReportedByReactPluginBlackList = messages.filter((result) => {
-      return result.ruleId === 'semi';
-    });
-    assert.equal(errorReportedByReactPluginBlackList.length, 0);
-  });
-
-  it('Validate eslint-config-encode/essential/react', async () => {
-    const configPath = './essential/react.js';
-    const filePath = path.join(__dirname, './fixtures/react.jsx');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.notEqual(sumBy(results, 'errorCount'), 0);
-    assert.notEqual(sumBy(results, 'warningCount'), 0);
-    // 验证 react plugin 工作是否正常
-    const { messages } = results[0];
-    const errorReportedByReactPlugin = messages.filter((result) => {
-      return result.ruleId && result.ruleId.indexOf('react/') !== -1;
-    });
-    assert.notEqual(errorReportedByReactPlugin.length, 0);
-
-    // 验证黑名单中的规则已关闭，取 react/jsx-indent 进行测试
-    const errorReportedByReactPluginBlackList = messages.filter((result) => {
-      return result.ruleId === 'react/jsx-indent';
-    });
-    assert.equal(errorReportedByReactPluginBlackList.length, 0);
-  });
-
-  it('Validate eslint-config-encode/essential/vue', async () => {
-    const configPath = './essential/vue.js';
-    const filePath = path.join(__dirname, './fixtures/vue.vue');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-
-    // 验证 lint 工作是否正常
-    const results = await cli.lintFiles([filePath]);
-    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
-    assert.notEqual(sumBy(results, 'errorCount'), 0);
-    assert.equal(sumBy(results, 'warningCount'), 0);
-
-    // 验证 vue plugin 工作是否正常
-    const { messages } = results[0];
-    const errorReportedByReactPlugin = messages.filter((result) => {
-      return result.ruleId && result.ruleId.indexOf('vue/') !== -1;
-    });
-    assert.notEqual(errorReportedByReactPlugin.length, 0);
-
-    // 验证黑名单中的规则已关闭
-    const errorReportedByReactPluginBlackList = messages.filter((result) => {
-      return result.ruleId === 'indent';
-    });
-    assert.equal(errorReportedByReactPluginBlackList.length, 0);
-  });
-
-  it('Validate eslint-config-encode/node', async () => {
-    const configPath = './node.js';
-    const filePath = path.join(__dirname, './fixtures/node.js');
-
-    const cli = new eslint.ESLint({
-      overrideConfigFile: configPath,
-      useEslintrc: false,
-      ignore: false,
-    });
-
-    // 验证导出的 config 是否正常
-    const config = await cli.calculateConfigForFile(filePath);
-    assert.ok(isObject(config));
-    assert.strictEqual(config.env.node, true);
-    assert.strictEqual(config.plugins.includes('node'), true);
-
-    // 验证已开启的 link 规则是否校验正常
-    const results = await cli.lintFiles([filePath]);
-    const { messages, errorCount, warningCount } = results[0];
-    const ruleIds = Array.from(messages.map((item) => item.ruleId));
-    assert.strictEqual(ruleIds.includes('node/prefer-promises/fs'), true);
-    assert.strictEqual(ruleIds.includes('no-unused-vars'), true);
-    assert.strictEqual(ruleIds.includes('node/no-new-require'), true);
-    assert.strictEqual(ruleIds.includes('semi'), true);
-    assert.strictEqual(ruleIds.includes('quotes'), true);
-    assert.strictEqual(errorCount, 7);
-    assert.strictEqual(warningCount, 4);
-
-    // 验证已关闭的 link 规则是否校验正常，以 node/exports-style 为例
-    assert.strictEqual(ruleIds.includes('node/exports-style'), false);
-  });
-});
+/**
+ * 验证 JS
+ */
+
+const assert = require('assert');
+const eslint = require('eslint');
+const path = require('path');
+const sumBy = require('lodash/sumBy');
+
+function isObject(obj) {
+  return typeof obj === 'object' && obj !== null;
+}
+
+describe('Validate JS configs', () => {
+  it('Validate eslint-config-encode', async () => {
+    const configPath = './index.js';
+    const filePath = path.join(__dirname, './fixtures/index.js');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false, // 如果不关这个参数，会将目录下的 eslintrc 与 overrideConfigFile merge
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+  });
+
+  it('Validate eslint-config-encode/es5', async () => {
+    const configPath = './es5.js';
+    const filePath = path.join(__dirname, './fixtures/es5.js');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.equal(sumBy(results, 'warningCount'), 0);
+
+    // 验证 es5 覆盖的规则是否正常，取 comma-dangle 进行测试
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId === 'comma-dangle';
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+  });
+
+  it('Validate eslint-config-encode/vue', async () => {
+    const configPath = './vue.js';
+    const filePath = path.join(__dirname, './fixtures/vue.vue');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.equal(sumBy(results, 'warningCount'), 0);
+
+    // 验证 eslint-plugin-vue 工作是否正常
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('vue/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+  });
+
+  it('Validate eslint-config-encode/essential', async () => {
+    const configPath = './essential/index.js';
+    const filePath = path.join(__dirname, './fixtures/index.js');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.equal(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+
+    // 验证黑名单中的规则已关闭
+    const { messages } = results[0];
+
+    // 验证 semi 被关闭
+    const semiErrors = messages.filter((result) => {
+      return result.ruleId === 'semi';
+    });
+    assert.equal(semiErrors.length, 0);
+
+    // 验证 comma-spacing 被降级
+    const commaSpacingErrors = messages.filter((result) => {
+      return result.ruleId === 'comma-spacing';
+    });
+    assert.equal(commaSpacingErrors[0].severity, 1);
+  });
+
+  it('Validate eslint-config-encode/essential/es5', async () => {
+    const configPath = './essential/es5.js';
+    const filePath = path.join(__dirname, './fixtures/es5.js');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+    // 验证 es5 覆盖的规则是否正常，取 comma-dangle 进行测试
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId === 'comma-dangle';
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+
+    // 验证黑名单中的规则已关闭，取 semi 进行测试
+    const errorReportedByReactPluginBlackList = messages.filter((result) => {
+      return result.ruleId === 'semi';
+    });
+    assert.equal(errorReportedByReactPluginBlackList.length, 0);
+  });
+
+  it('Validate eslint-config-encode/essential/react', async () => {
+    const configPath = './essential/react.js';
+    const filePath = path.join(__dirname, './fixtures/react.jsx');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.notEqual(sumBy(results, 'warningCount'), 0);
+    // 验证 react plugin 工作是否正常
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('react/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+
+    // 验证黑名单中的规则已关闭，取 react/jsx-indent 进行测试
+    const errorReportedByReactPluginBlackList = messages.filter((result) => {
+      return result.ruleId === 'react/jsx-indent';
+    });
+    assert.equal(errorReportedByReactPluginBlackList.length, 0);
+  });
+
+  it('Validate eslint-config-encode/essential/vue', async () => {
+    const configPath = './essential/vue.js';
+    const filePath = path.join(__dirname, './fixtures/vue.vue');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+
+    // 验证 lint 工作是否正常
+    const results = await cli.lintFiles([filePath]);
+    assert.equal(sumBy(results, 'fatalErrorCount'), 0);
+    assert.notEqual(sumBy(results, 'errorCount'), 0);
+    assert.equal(sumBy(results, 'warningCount'), 0);
+
+    // 验证 vue plugin 工作是否正常
+    const { messages } = results[0];
+    const errorReportedByReactPlugin = messages.filter((result) => {
+      return result.ruleId && result.ruleId.indexOf('vue/') !== -1;
+    });
+    assert.notEqual(errorReportedByReactPlugin.length, 0);
+
+    // 验证黑名单中的规则已关闭
+    const errorReportedByReactPluginBlackList = messages.filter((result) => {
+      return result.ruleId === 'indent';
+    });
+    assert.equal(errorReportedByReactPluginBlackList.length, 0);
+  });
+
+  it('Validate eslint-config-encode/node', async () => {
+    const configPath = './node.js';
+    const filePath = path.join(__dirname, './fixtures/node.js');
+
+    const cli = new eslint.ESLint({
+      overrideConfigFile: configPath,
+      useEslintrc: false,
+      ignore: false,
+    });
+
+    // 验证导出的 config 是否正常
+    const config = await cli.calculateConfigForFile(filePath);
+    assert.ok(isObject(config));
+    assert.strictEqual(config.env.node, true);
+    assert.strictEqual(config.plugins.includes('node'), true);
+
+    // 验证已开启的 link 规则是否校验正常
+    const results = await cli.lintFiles([filePath]);
+    const { messages, errorCount, warningCount } = results[0];
+    const ruleIds = Array.from(messages.map((item) => item.ruleId));
+    assert.strictEqual(ruleIds.includes('node/prefer-promises/fs'), true);
+    assert.strictEqual(ruleIds.includes('no-unused-vars'), true);
+    assert.strictEqual(ruleIds.includes('node/no-new-require'), true);
+    assert.strictEqual(ruleIds.includes('semi'), true);
+    assert.strictEqual(ruleIds.includes('quotes'), true);
+    assert.strictEqual(errorCount, 7);
+    assert.strictEqual(warningCount, 4);
+
+    // 验证已关闭的 link 规则是否校验正常，以 node/exports-style 为例
+    assert.strictEqual(ruleIds.includes('node/exports-style'), false);
+  });
+});

package/es5.js

@@ -1,10 +1,10 @@
-module.exports = {
-  extends: [
-    './rules/base/best-practices',
-    './rules/base/possible-errors',
-    './rules/base/style',
-    './rules/base/variables',
-    './rules/es5',
-  ].map(require.resolve),
-  root: true,
-};
+module.exports = {
+  extends: [
+    './rules/base/best-practices',
+    './rules/base/possible-errors',
+    './rules/base/style',
+    './rules/base/variables',
+    './rules/es5',
+  ].map(require.resolve),
+  root: true,
+};

package/essential/es5.js

@@ -1,12 +1,12 @@
-module.exports = {
-  extends: [
-    '../es5',
-    './rules/set-style-to-warn',
-    './rules/blacklist',
-  ].map(require.resolve),
-  rules: {
-    // 逗号风格 - ES5 中不加最后一个逗号
-    // @unessential
-    'comma-dangle': ['warn', 'never'],
-  },
-};
+module.exports = {
+  extends: [
+    '../es5',
+    './rules/set-style-to-warn',
+    './rules/blacklist',
+  ].map(require.resolve),
+  rules: {
+    // 逗号风格 - ES5 中不加最后一个逗号
+    // @unessential
+    'comma-dangle': ['warn', 'never'],
+  },
+};

package/essential/index.js

@@ -1,12 +1,12 @@
-/**
- * essential 级别出口文件仅将会必要的规则设置为 error 级别
- */
-
-module.exports = {
-  extends: [
-    '../index',
-    './rules/set-style-to-warn',
-    './rules/blacklist',
-    './rules/es6-blacklist',
-  ].map(require.resolve),
-};
+/**
+ * essential 级别出口文件仅将会必要的规则设置为 error 级别
+ */
+
+module.exports = {
+  extends: [
+    '../index',
+    './rules/set-style-to-warn',
+    './rules/blacklist',
+    './rules/es6-blacklist',
+  ].map(require.resolve),
+};