feat: egg-bin check (#87)

.autod.conf

@@ -14,11 +14,12 @@ module.exports = {
     'intelli-espower-loader',
     'power-assert',
     'ypkgfiles',
+    'eslint-plugin-eggache',
+    'eslint',
   ],
   devdep: [
     'autod',
     'eslint-config-egg',
-    'eslint',
     'egg-ci',
   ],
   keep: [

.eslintignore

@@ -1,3 +1,4 @@
 node_modules/
 coverage/
 test/fixtures/enzyme-example-mocha/
+test/fixtures/check-eggache/

README.md

@@ -192,6 +192,16 @@ Generate `pkg.dependencies` and `pkg.devDependencies` automatically, see [autod]
 $ egg-bin autod
 ```
 
+## check
+
+Check egg project for collect useful infomation to report issue.
+
+```bash
+$ egg-bin check
+```
+### Rules:
+- [eslint-plugin-eggache](https://github.com/eggjs/eslint-plugin-eggache)
+
 ## Custom egg-bin for your team
 
 You maybe need a custom egg-bin to implement more custom features if your team has develop a framework base on egg.

lib/check-eslintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "plugin:eggache/recommended",
+  "parserOptions": {
+    "ecmaVersion": 6
+  }
+}

lib/cmd/check.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const Command = require('../command');
+const path = require('path');
+
+class CheckCommand extends Command {
+  constructor(rawArgv) {
+    super(rawArgv);
+    this.usage = 'Usage: egg-bin check';
+    this.options = {
+      baseDir: {
+        description: 'directory of application, default to `process.cwd()`',
+        type: 'string',
+      },
+    };
+  }
+
+  get description() {
+    return 'Check egg project for collect useful infomation to report issue';
+  }
+
+  * run({ cwd, argv }) {
+    /* istanbul ignore next */
+    let baseDir = argv._[0] || argv.baseDir || cwd;
+    /* istanbul ignore next */
+    if (!path.isAbsolute(baseDir)) baseDir = path.join(cwd, baseDir);
+
+    // check eggache
+    const eslintBin = require.resolve('eslint/bin/eslint');
+    const eslintArgs = this.helper.unparseArgv({
+      _: [ '.' ],
+      config: require.resolve('../check-eslintrc'),
+      'no-eslintrc': true,
+      format: 'codeframe',
+    });
+    console.info('[egg-bin] run check: %s %s', eslintBin, eslintArgs.join(' '));
+    yield this.helper.forkNode(eslintBin, eslintArgs, { cwd: baseDir });
+  }
+}
+
+module.exports = CheckCommand;

package.json

@@ -15,29 +15,32 @@
     "debug": "^3.1.0",
     "detect-port": "^1.2.2",
     "egg-utils": "^2.3.0",
+    "eslint": "^4.17.0",
+    "eslint-plugin-eggache": "^1.0.0",
     "globby": "^7.1.1",
     "inspector-proxy": "^1.1.0",
     "intelli-espower-loader": "^1.0.1",
-    "mocha": "^4.0.1",
+    "mocha": "^5.0.0",
     "mz-modules": "^2.0.0",
-    "nyc": "^11.3.0",
+    "nyc": "^11.4.1",
     "power-assert": "^1.4.4",
-    "semver": "^5.4.1",
+    "semver": "^5.5.0",
     "test-exclude": "^4.1.1",
     "ypkgfiles": "^1.5.0"
   },
   "devDependencies": {
+    "autod": "^3.0.1",
     "babel": "^6.3.26",
     "babel-preset-airbnb": "^1.0.1",
     "babel-register": "^6.4.3",
     "coffee": "^4.1.0",
     "cross-env": "^3.1.3",
     "egg": "^1.8.0",
     "egg-ci": "^1.8.0",
-    "egg-mock": "^3.13.1",
+    "egg-mock": "^3.14.0",
     "enzyme": "^2.0.0",
     "eslint": "^4.12.1",
-    "eslint-config-egg": "^5.1.1",
+    "eslint-config-egg": "^6.0.0",
     "jsdom": "^8.0.1",
     "mm": "^2.2.0",
     "mz": "^2.7.0",

test/fixtures/check-eggache/config/config.default.js

@@ -0,0 +1,9 @@
+'use strict';
+
+module.exports = appInfo => {
+  const config = exports = {};
+  config.keys = appInfo.name;
+  return config;
+};
+
+exports.test = '12345';

test/fixtures/check-eggache/config/plugin.js

@@ -0,0 +1,7 @@
+'use strict';
+
+exports.view = {
+  enable: true,
+  package: '',
+  foo: 'bar',
+};

test/fixtures/check-eggache/other.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = '';
+
+exports.test = '12345';
+
+let a;

test/fixtures/check-eggache/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "check-eggache"
+}

test/lib/cmd/check.test.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const path = require('path');
+const coffee = require('coffee');
+
+const eggBin = require.resolve('../../../bin/egg-bin.js');
+
+describe('test/lib/cmd/check.test.js', () => {
+  it('should check eggache', function* () {
+    const cwd = path.join(__dirname, '../../fixtures/check-eggache');
+    yield coffee.fork(eggBin, [ 'check' ], { cwd })
+      // .debug()
+      .expect('stdout', /eggache\/no-override-exports/)
+      .expect('stdout', /eggache\/no-unexpected-plugin-keys/)
+      .notExpect('stdout', /no-unused-vars/)
+      .notExpect('stdout', /\/other.js/)
+      .expect('code', 1)
+      .end();
+  });
+
+  it('should check eggache with --baseDir', function* () {
+    const cwd = path.join(__dirname, '../../fixtures/check-eggache');
+    yield coffee.fork(eggBin, [ 'check', '--baseDir', cwd ])
+      // .debug()
+      .expect('stdout', /eggache\/no-override-exports/)
+      .expect('stdout', /eggache\/no-unexpected-plugin-keys/)
+      .notExpect('stdout', /no-unused-vars/)
+      .notExpect('stdout', /\/other.js/)
+      .expect('code', 1)
+      .end();
+  });
+});