Skip to content

Commit

Permalink
feat: add egg-bin autod --check command (#70)
Browse files Browse the repository at this point in the history
* chore: remove hotfix spawn-wrap codest
  • Loading branch information
fengmk2 committed Aug 2, 2017
1 parent e76c9ca commit 0f0c7ab
Show file tree
Hide file tree
Showing 10 changed files with 90 additions and 56 deletions.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ Add `egg-bin` to `package.json` scripts:
"test": "npm run lint -- --fix && npm run test-local",
"cov": "egg-bin cov",
"lint": "eslint .",
"ci": "npm run lint && npm run cov"
"pkgfiles": "egg-bin pkgfiles",
"autod": "egg-bin autod",
"ci": "npm run lint && npm run autod -- --check && npm run pkgfiles -- --check && npm run cov"
}
}
```
Expand Down Expand Up @@ -170,6 +172,14 @@ Generate `pkg.files` automatically before npm publish, see [ypkgfiles] for detai
$ egg-bin pkgfiles
```

### autod

Generate `pkg.dependencies` and `pkg.devDependencies` automatically, see [autod] for detail

```bash
$ egg-bin autod
```

## 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.
Expand Down Expand Up @@ -256,3 +266,4 @@ run nsp check at /foo/bar with {}
[power-assert]: https://github.com/power-assert-js/power-assert
[ypkgfiles]: https://github.com/popomore/ypkgfiles
[common-bin]: https://github.com/node-modules/common-bin
[autod]: https://github.com/node-modules/autod
28 changes: 28 additions & 0 deletions lib/cmd/autod.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
'use strict';

const Command = require('../command');

class AutodCommand extends Command {
constructor(rawArgv) {
super(rawArgv);
this.usage = 'Usage: egg-bin autod';
this.options = {
check: {
description: 'dependencies checker',
},
};
}

get description() {
return 'Generate pkg.dependencies and pkg.devDependencies automatically';
}

* run({ cwd, argv }) {
const args = [];
if (argv.check) args.push('--check');
const autodBin = require.resolve('autod/bin/autod.js');
yield this.helper.forkNode(autodBin, args, { cwd });
}
}

module.exports = AutodCommand;
39 changes: 0 additions & 39 deletions lib/cmd/cov.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ const debug = require('debug')('egg-bin:cov');
const path = require('path');
const rimraf = require('mz-modules/rimraf');
const testExclude = require('test-exclude');
const fs = require('mz/fs');

const Command = require('./test');
const EXCLUDES = Symbol('cov#excludes');
Expand Down Expand Up @@ -77,15 +76,10 @@ class CovCommand extends Command {
env: Object.assign({ NODE_ENV: 'test' }, env),
};

// FIXME: remove hotfix after https://github.com/tapjs/spawn-wrap/pull/57 merged
yield hotfixSpawnWrap();

// save coverage-xxxx.json to $PWD/coverage
const covArgs = this.getCovArgs(context);
debug('covArgs: %j', covArgs);
yield this.helper.forkNode(nycCli, covArgs, opt);

yield rollbackSpawnWrap();
}

/**
Expand Down Expand Up @@ -123,36 +117,3 @@ class CovCommand extends Command {
}

module.exports = CovCommand;

const src = 'var command = path.basename(options.file, \'.exe\')';
const target = 'var command = path.basename(options.file).replace(/\.exe$/i, \'\')';

function* hotfixSpawnWrap() {
if (process.platform === 'win32') {
yield replaceSpawnWrap(src, target);
}
}

function* rollbackSpawnWrap() {
if (process.platform === 'win32') {
yield replaceSpawnWrap(target, src);
}
}

function* replaceSpawnWrap(src, target) {
let spawnWrapPath;
try {
spawnWrapPath = require.resolve('spawn-wrap/index.js');
} catch (_) {
spawnWrapPath = path.join(__dirname, '../../node_modules/nyc/node_modules/spawn-wrap/index.js');
}
if (!(yield fs.exists(spawnWrapPath))) return;

let content = yield fs.readFile(spawnWrapPath, 'utf8');
// https://github.com/tapjs/spawn-wrap/pull/57
if (content.includes(src)) {
content = content.replace(src, target);
console.warn('[egg-bin] hotfix spawn-wrap');
yield fs.writeFile(spawnWrapPath, content);
}
}
21 changes: 10 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"mocha": "bin/mocha.js"
},
"dependencies": {
"autod": "^2.9.0",
"change-case": "^3.0.1",
"co-mocha": "^1.2.0",
"common-bin": "^2.4.0",
Expand All @@ -16,32 +17,30 @@
"egg-utils": "^2.2.0",
"globby": "^6.1.0",
"intelli-espower-loader": "^1.0.1",
"mocha": "^3.4.2",
"mz": "^2.6.0",
"mocha": "^3.5.0",
"mz-modules": "^1.0.0",
"nyc": "^11.0.2",
"nyc": "^11.1.0",
"power-assert": "^1.4.4",
"test-exclude": "^4.1.1",
"ypkgfiles": "^1.4.0"
},
"devDependencies": {
"autod": "^2.8.0",
"babel": "^6.3.26",
"babel-preset-airbnb": "^1.0.1",
"babel-register": "^6.4.3",
"coffee": "^4.0.1",
"coffee": "^4.1.0",
"cross-env": "^3.1.3",
"egg-ci": "^1.8.0",
"enzyme": "^2.0.0",
"eslint": "^3.0.0",
"eslint-config-egg": "^4.2.1",
"eslint": "^4.3.0",
"eslint-config-egg": "^5.0.0",
"jsdom": "^8.0.1",
"mm": "^2.1.0",
"mz": "^2.6.0",
"react": "^0.14.7",
"react-addons-test-utils": "^0.14.7",
"react-dom": "^0.14.7",
"semver": "^5.3.0"
"semver": "^5.4.1"
},
"repository": {
"type": "git",
Expand All @@ -54,13 +53,13 @@
"author": "fengmk2 <fengmk2@gmail.com> (https://fengmk2.com)",
"scripts": {
"lint": "eslint .",
"pkgfiles": "node bin/egg-bin.js pkgfiles --check",
"pkgfiles": "node bin/egg-bin.js pkgfiles",
"test": "npm run lint -- --fix && npm run test-local",
"test-local": "node bin/egg-bin.js test -t 3600000",
"cov": "nyc -r lcov -r text-summary npm run test-local",
"ci-test-only": "TESTS=test/lib/cmd/cov.test.js npm run test-local",
"ci": "npm run lint && npm run pkgfiles && npm run ci-test-only && npm run cov",
"autod": "autod"
"ci": "npm run lint && npm run pkgfiles -- --check && npm run autod -- --check && npm run ci-test-only && npm run cov",
"autod": "node bin/egg-bin.js autod"
},
"engines": {
"node": ">= 6.0.0"
Expand Down
3 changes: 3 additions & 0 deletions test/fixtures/autod-exists/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'use strict';

require('urllib');
6 changes: 6 additions & 0 deletions test/fixtures/autod-exists/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"name": "autod-exists",
"dependencies": {
"urllib": "*"
}
}
3 changes: 3 additions & 0 deletions test/fixtures/autod-missing/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
'use strict';

require('urllib');
3 changes: 3 additions & 0 deletions test/fixtures/autod-missing/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"name": "autod-missing"
}
25 changes: 25 additions & 0 deletions test/lib/cmd/autod.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
'use strict';

const path = require('path');
const coffee = require('coffee');

const eggBin = require.resolve('../../../bin/egg-bin.js');

describe('test/lib/cmd/autod.test.js', () => {
it('should autod check fail', function* () {
const cwd = path.join(__dirname, '../../fixtures/autod-missing');
yield coffee.fork(eggBin, [ 'autod', '--check' ], { cwd })
.debug()
.expect('code', 1)
.expect('stderr', /\[ERROR\] Missing dependencies: \["urllib"\]/)
.end();
});

it('should autod check pass', function* () {
const cwd = path.join(__dirname, '../../fixtures/autod-exists');
yield coffee.fork(eggBin, [ 'autod', '--check' ], { cwd })
.debug()
.expect('code', 0)
.end();
});
});
5 changes: 0 additions & 5 deletions test/lib/cmd/cov.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ describe('test/lib/cmd/cov.test.js', () => {
child.expect('stdout', /Statements {3}: 80% \( 4[\/|\\]5 \)/);
}

if (process.platform === 'win32') {
child.expect('stderr', /\[egg-bin] hotfix spawn-wrap/);
}

child.expect('code', 0)
.end(err => {
assert.ifError(err);
Expand All @@ -57,7 +53,6 @@ describe('test/lib/cmd/cov.test.js', () => {
if (!process.env.NYC_ROOT_ID) {
child.expect('stdout', /Statements {3}: 80% \( 4[\/|\\]5 \)/);
}
child.expect('stderr', /\[egg-bin] hotfix spawn-wrap/);
child.expect('code', 0)
.end(err => {
assert.ifError(err);
Expand Down

0 comments on commit 0f0c7ab

Please sign in to comment.