feat: add binary to scaffold new runner (#17)

Fixes #10

Author: Mark1626

README.md

@@ -88,6 +88,18 @@ module.exports = ({ testPath }) => {
 };
 ```
 
+## Create runner from binary
+
+```shell
+yarn create jest-runner my-runner
+
+# Or with npm
+npm init jest-runner my-runner
+```
+
+**Note:** You will have to update the package name in `package.json` of the
+generated runner
+
 ## Add your runner to Jest config
 
 Once you have your Jest runner you can add it to your Jest config.

generator/config.js

@@ -0,0 +1,21 @@
+module.exports = {
+  dirs: ['src'],
+  createList: [
+    {
+      input: '_package.json',
+      output: 'package.json',
+    },
+    {
+      input: '_README.md',
+      output: 'README.md',
+    },
+    {
+      input: 'index.js',
+      output: 'src/index.js',
+    },
+    {
+      input: 'run.js',
+      output: 'src/run.js',
+    },
+  ],
+};

generator/fixtures/_README.md

@@ -0,0 +1,43 @@
+# generated-jest-runner
+
+## Usage
+
+### Install
+
+Install `jest`_(it needs Jest 21+)_ and `generated-jest-runner`
+
+```bash
+yarn add --dev jest generated-jest-runner
+
+# or with NPM
+
+npm install --save-dev jest generated-jest-runner
+```
+
+## Add your runner to Jest config
+
+Once you have your Jest runner you can add it to your Jest config.
+
+In your `package.json`
+
+```json
+{
+  "jest": {
+    "runner": "generated-jest-runner"
+  }
+}
+```
+
+Or in `jest.config.js`
+
+```js
+module.exports = {
+  runner: require.resolve('generated-jest-runner'),
+};
+```
+
+### Run Jest
+
+```bash
+yarn jest
+```

generator/fixtures/_package.json

@@ -0,0 +1,16 @@
+{
+    "name": "generated-jest-runner",
+    "version": "1.0.0",
+    "description": "A generated jest runner",
+    "main": "src/index.js",
+    "scripts": {
+        "test": "jest"
+    },
+    "jest": {
+        "runner": "./test/runner"
+    },
+    "dependencies": {
+        "jest": "^24.6.0",
+        "create-jest-runner": "^0.5.0"
+    }
+}

generator/fixtures/index.js

@@ -0,0 +1,3 @@
+const { createJestRunner } = require('create-jest-runner');
+
+module.exports = createJestRunner(require.resolve('./run'));

generator/fixtures/run.js

@@ -0,0 +1,18 @@
+const fs = require('fs');
+const { pass, fail } = require('create-jest-runner');
+
+module.exports = ({ testPath }) => {
+  const start = Date.now();
+  const contents = fs.readFileSync(testPath, 'utf8');
+  const end = Date.now();
+
+  if (contents.includes('⚔️🏃')) {
+    return pass({ start, end, test: { path: testPath } });
+  }
+  const errorMessage = 'Company policies require ⚔️ 🏃 in every file';
+  return fail({
+    start,
+    end,
+    test: { path: testPath, errorMessage, title: 'Check for ⚔️ 🏃' },
+  });
+};

generator/index.js

@@ -0,0 +1,53 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+
+const fs = require('fs');
+const path = require('path');
+const { blue, red, green, yellow, magenta } = require('chalk');
+const config = require('./config');
+
+const createIfNotExists = folder => {
+  if (!fs.existsSync(folder)) {
+    console.log(`Creating new jest-runner in ${green(folder)}`);
+    fs.mkdirSync(folder);
+  } else {
+    throw new Error('Folder already exists');
+  }
+};
+
+const scaffoldRunner = () => {
+  try {
+    const fixturesPath = path.resolve(__dirname, 'fixtures');
+    let outputDirname;
+    const projectName = process.argv[2];
+    if (projectName) {
+      outputDirname = path.resolve('.', projectName);
+      createIfNotExists(outputDirname);
+    } else {
+      throw new Error('Project name not specified');
+    }
+
+    config.dirs.forEach(item => {
+      console.log(`Creating ${blue('directory')} ${magenta(item)}`);
+      fs.mkdirSync(path.resolve(outputDirname, item));
+    });
+
+    config.createList.forEach(file => {
+      const filePath = path.resolve(outputDirname, file.output);
+      const content = fs.readFileSync(path.resolve(fixturesPath, file.input));
+      console.log(`Creating ${yellow('file')} ${magenta(file.output)}`);
+      fs.writeFileSync(filePath, content);
+    });
+    console.log(green('Scaffolding successfull'));
+    console.log(blue('Run cd npm/yarn install'));
+    console.log(red('Update the package name package.json'));
+  } catch (e) {
+    console.log(`${red('Scaffolding failed')} ${e}`);
+  }
+};
+
+scaffoldRunner();
+
+module.exports = {
+  scaffoldRunner,
+};

package.json

@@ -19,6 +19,7 @@
     "format": "prettier --single-quote --trailing-comma all --write \"!(build)/**/*.js\""
   },
   "dependencies": {
+    "chalk": "^2.4.2",
     "jest-worker": "^24.0.0",
     "throat": "^4.1.0"
   },
@@ -36,5 +37,8 @@
     "execa": "^1.0.0",
     "jest": "^24.0.0",
     "prettier": "^1.7.4"
+  },
+  "bin": {
+    "create-jest-runner": "./generator/index.js"
   }
 }