Merge pull request #19 from xpepermint/master

Support package.json configuration, fix return codes

Author: xpepermint

README.md

@@ -166,6 +166,25 @@ Install the [ts-node](https://www.npmjs.com/package/ts-node) NPM package then us
 hayspec --require ts-node/register
 ```
 
+#### Project configuration
+
+Hayspec configuration options can be saved inside the `package.json` file under the the `hayspec` key.
+
+```
+{
+  "hayspec": {
+    "require": [
+      "ts-node/register"
+    ],
+    "match": [
+      "./src/**/*.test.*"
+    ]
+  }
+}
+```
+
+Note that these options can be overriden by providing CLI arguments. 
+
 ## Hayspec packages
 
 | Package | Description | Version

packages/hayspec-cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hayspec/cli",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "CLI for Hayspec framework.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -11,7 +11,15 @@
     "clean": "rm -Rf ./dist",
     "transpile": "npm run clean; tsc",
     "prepare": "npm run transpile",
-    "test": "npm run transpile && nyc ava"
+    "test": "npm run transpile && nyc ava --verbose"
+  },
+  "hayspec": {
+    "require": [
+      "ts-node/register"
+    ],
+    "match": [
+      "./src/**/*.hay.*"
+    ]
   },
   "ava": {
     "compileEnhancements": false,
@@ -61,15 +69,14 @@
     "ava": "1.0.0-beta.6",
     "nyc": "^12.0.2",
     "ts-node": "^7.0.1",
-    "typescript": "^3.0.1"
+    "typescript": "^3.1.1"
   },
   "dependencies": {
-    "@hayspec/init": "^0.5.0",
-    "@hayspec/reporter": "^0.5.0",
-    "@hayspec/runner": "^0.5.0",
-    "@hayspec/spec": "^0.5.0",
+    "@hayspec/init": "^0.7.0",
+    "@hayspec/reporter": "^0.7.0",
+    "@hayspec/runner": "^0.7.0",
+    "@hayspec/spec": "^0.7.0",
     "inquirer": "^6.0.0",
     "yargs": "^11.0.0"
-  },
-  "gitHead": "03535c698ebd35ec94c63869f18cdde2380f739f"
+  }
 }

packages/hayspec-cli/src/commands/init.ts

@@ -1,12 +1,13 @@
 import * as inquirer from 'inquirer';
 import { Generator } from '@hayspec/init';
 import { Printer } from '@hayspec/reporter';
+import { getConfig } from '../lib/env';
 
 /**
  * Initializes project directory.
  */
 export default async function (argv) {
-  const { name, description } = argv;
+  const { name, description } = getConfig(argv);
   const root = process.cwd();
   const printer = new Printer();
 
@@ -52,8 +53,10 @@ export default async function (argv) {
       printer.colorize('gray', `$ npm test`)
     );
     printer.end();
-
+    process.exit(0);
+  
   } catch (e) {
     console.error(e);
+    process.exit(2);
   }
 }

packages/hayspec-cli/src/commands/test.ts

@@ -1,12 +1,13 @@
 import { Runner } from '@hayspec/runner';
 import { Spec, Stage } from '@hayspec/spec';
 import { DefaultReporter } from '@hayspec/reporter';
+import { getConfig } from '../lib/env';
 
 /**
  * Runs tests.
  */
 export default async function (argv) {
-  const { match } = argv;
+  const { match } = getConfig(argv);
   const reporter = new DefaultReporter();
   const stage = new Stage(reporter);
   const test = new Spec(stage);
@@ -18,5 +19,11 @@ export default async function (argv) {
     test.spec(message, result.spec);
   });
 
-  await test.perform();
+  try {
+    await test.perform();
+    process.exit(reporter.failedCount ? 1 : 0);
+  } catch (e) {
+    console.log(e);
+    process.exit(2);
+  }
 }

packages/hayspec-cli/src/index.ts

@@ -1,13 +1,14 @@
 import * as yargs from 'yargs';
 import initHandler from './commands/init';
 import testHandler from './commands/test';
+import { getConfig } from './lib/env';
 
 /**
  * Interface definition.
  */
 const { argv } = yargs
   .usage('Usage: $0 --help')
-  .command('init', 'Initializes project directory.',  (yargs) => yargs
+  .command('init', 'Initializes project directory.', (yargs) => yargs
     .option('name', {
       string: true,
       description: 'Project name',
@@ -21,7 +22,6 @@ const { argv } = yargs
     .option('match', {
       array: true,
       description: 'Match pattern',
-      default: ['./src/cro**/*.test.*'],
     })
     .option('require', {
       array: true,
@@ -35,6 +35,4 @@ const { argv } = yargs
 /**
  * Upgrading environment.
  */
-if (Array.isArray(argv.require)) {
-  argv.require.forEach((v) => require(v));
-}
+getConfig(argv).require.forEach((v) => require(v));

packages/hayspec-cli/src/lib/env.ts

@@ -0,0 +1,26 @@
+import * as pt from 'path';
+
+/**
+ * Returns package.json data.
+ */
+export function getPackage() {
+  try {
+    return require(pt.join(process.cwd(), 'package.json')) || {};
+  } catch (e) {
+    return {};
+  }
+}
+
+/**
+ * Returns Hayspec options.
+ */
+export function getConfig(argv?: any) {
+  const defaults = getPackage()['hayspec'] || {};
+  const custom = argv || {};
+  return {
+    name: custom['name'] || defaults['name'] || '',
+    description: custom['description'] || defaults['description'] || '',
+    require: custom['require'] || defaults['require'] || [],
+    match: custom['match'] || defaults['match'] || [],
+  };
+}

…/hayspec-cli/src/tests/assets/foo.hay.ts …spec-cli/src/tests/assets/invalid.hay.tspackages/hayspec-cli/src/tests/assets/foo.hay.ts renamed to packages/hayspec-cli/src/tests/assets/invalid.hay.ts packages/hayspec-cli/src/tests/assets/foo.hay.ts renamed to packages/hayspec-cli/src/tests/assets/invalid.hay.ts

@@ -3,13 +3,12 @@ import { Spec } from '@hayspec/spec';
 const spec = new Spec();
 
 spec.test('foo', async (context) => {
-  context.is(true, true);
+  context.true(true);
 });
 
 spec.test('bar', async (context) => {
-  context.is(true, true);
-  context.is(true, true);
-  context.is(true, false);
+  context.true(false);
+  context.false(true);
 });
 
 export default spec;

packages/hayspec-cli/src/tests/assets/valid.hay.ts

@@ -0,0 +1,14 @@
+import { Spec } from '@hayspec/spec';
+
+const spec = new Spec();
+
+spec.test('foo', async (context) => {
+  context.true(true);
+});
+
+spec.test('bar', async (context) => {
+  context.true(true);
+  context.true(true);
+});
+
+export default spec;

packages/hayspec-cli/src/tests/index.test.ts

@@ -4,16 +4,28 @@ import * as cproc from 'child_process';
 
 const exec = util.promisify(cproc.exec);
 
-test('runs tests', async (t) => {
-  const command = './bin/hayspec test --require ts-node/register --match ./src/tests/assets/**/*.hay.*';
+test('initializes current folder', async (t) => {
+  const command = `mkdir -p ./node_modules/.tmp/test; cd ./node_modules/.tmp/test; ../../../bin/hayspec init --name foo --description bar; echo code: $?`;
   const { stdout, stderr } = await exec(command);
-  t.true(stdout.indexOf('src/tests/assets/foo.hay.ts') !== -1);
+  t.true(stdout.indexOf('Continue by running the commands below:') !== -1);
+  t.true(stdout.indexOf('code: 0') !== -1);
   t.true(stderr === '');
 });
 
-test('initializes current folder', async (t) => {
-  const command = `mkdir -p ./node_modules/.tmp/test; cd ./node_modules/.tmp/test; ../../../bin/hayspec init --name foo --description bar`;
+test('runs valid tests', async (t) => {
+  const command = './bin/hayspec test --require ts-node/register --match ./src/tests/assets/**/valid.hay.*; echo code: $?';
   const { stdout, stderr } = await exec(command);
-  t.true(stdout.indexOf('Continue by running the commands below:') !== -1);
+  t.true(stdout.indexOf('src/tests/assets/valid.hay.ts') !== -1);
+  t.true(stdout.indexOf('src/tests/assets/invalid.hay.ts') === -1);
+  t.true(stdout.indexOf('code: 0') !== -1);
+  t.true(stderr === '');
+});
+
+test('runs invalid tests', async (t) => {
+  const command = './bin/hayspec test --require ts-node/register --match ./src/tests/assets/**/invalid.hay.*; echo code: $?';
+  const { stdout, stderr } = await exec(command);
+  t.true(stdout.indexOf('src/tests/assets/valid.hay.ts') === -1);
+  t.true(stdout.indexOf('src/tests/assets/invalid.hay.ts') !== -1);
+  t.true(stdout.indexOf('code: 1') !== -1);
   t.true(stderr === '');
 });

packages/hayspec-cli/src/tests/lib/env.test.ts

@@ -0,0 +1,24 @@
+import test from 'ava';
+import { getConfig } from '../../lib/env';
+
+test('method `getConfig` returns package.json hayspec configuration', async (t) => {
+  t.deepEqual(getConfig(), {
+    name: '',
+    description: '',
+    require: ['ts-node/register'],
+    match: ['./src/**/*.hay.*'],
+  });
+});
+
+test('method `getConfig` merges reveived configuration', async (t) => {
+  t.deepEqual(getConfig({
+    extension: [],
+    require: ['bar'],
+    match: ['foo'],
+  }), {
+    name: '',
+    description: '',
+    require: ['bar'],
+    match: ['foo'],
+  });
+});