chore: general quality of life improvements (#25)

nicojs · web-flow · commit f78820cf9bf0 · 2020-10-19T08:48:34.000+02:00
* Use `mochaHooks`
* Use `.mocharc` config file
* Use `dist` outdir

BREAKING CHANGE: JS output files are now located in the `dist` directory. This only has an effect if you're requiring directly from it.
diff --git a/.mocharc.jsonc b/.mocharc.jsonc
@@ -0,0 +1,3 @@
+{
+    "require": ["source-map-support/register", "dist/test/setup.js"]
+}
diff --git a/.npmignore b/.npmignore
@@ -1,7 +1,5 @@
 **/*
 !bin/**
 !src/**
-src/**/*.map
-src/**/*.ts
-!src/**/*.d.ts
+!dist/src/**
 !readme.md
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -12,14 +12,12 @@
             "args": [
                 "--no-timeouts",
                 "--colors",
-                "${workspaceRoot}/test/helpers/*.js",
-                "${workspaceRoot}/test/unit/*.js"
+                "${workspaceRoot}/dist/test/unit/*.js"
             ],
             "internalConsoleOptions": "openOnSessionStart",
             "sourceMaps": true,
             "outFiles": [
-                "${workspaceRoot}/test/**/*.js",
-                "${workspaceRoot}/src/**/*.js"
+                "${workspaceRoot}/dist/**/*.js"
             ]
         },
         {
@@ -30,14 +28,12 @@
             "args": [
                 "--no-timeouts",
                 "--colors",
-                "${workspaceRoot}/test/helpers/*.js",
-                "${workspaceRoot}/test/integration/*.js"
+                "${workspaceRoot}/dist/test/integration/*.js"
             ],
             "internalConsoleOptions": "openOnSessionStart",
             "sourceMaps": true,
             "outFiles": [
-                "${workspaceRoot}/test/**/*.js",
-                "${workspaceRoot}/src/**/*.js"
+                "${workspaceRoot}/dist/**/*.js"
             ]
         }
     ]
diff --git a/bin/link-parent-bin b/bin/link-parent-bin
@@ -4,4 +4,4 @@
 
 process.title = 'parent-bin';
 
-require('../src/cli');
+require('../dist/src/cli');
diff --git a/package.json b/package.json
@@ -2,8 +2,7 @@
   "name": "link-parent-bin",
   "version": "1.0.2",
   "description": "",
-  "main": "src/ParentBinLinker.js",
-  "typings": "src/ParentBinLinker.d.ts",
+  "main": "dist/src/ParentBinLinker.js",
   "bin": {
     "link-parent-bin": "bin/link-parent-bin"
   },
@@ -15,15 +14,14 @@
     "node": ">=10"
   },
   "scripts": {
-    "clean": "node tasks/clean.js",
-    "prebuild": "npm run clean",
+    "all": "npm run clean && npm run build && npm run test",
+    "clean": "rimraf dist reports",
     "build": "tsc -p .",
-    "pretest": "npm run build",
-    "test": "npm run unitTest && npm run integrationTest",
-    "unitTest": "mocha test/helpers/*.js test/unit/**/*.js",
-    "integrationTest": "mocha test/helpers/*.js test/integration/**/*.js",
+    "test": "npm run test:unit && npm run test:integration",
+    "test:unit": "mocha dist/test/unit/**/*.js",
+    "test:integration": "mocha dist/test/integration/**/*.js",
     "start": "tsc -w",
-    "preversion": "npm test",
+    "preversion": "npm run all",
     "version": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
     "postversion": "npm publish && git push && git push --tags",
     "release:patch": "npm version patch -m \"chore(release): %s\"",
diff --git a/src/program.ts b/src/program.ts
@@ -17,7 +17,7 @@ export const program = {
         return program
             .storeOptionsAsProperties(false)
             .usage('[options]')
-            .version(require('../package.json').version)
+            .version(require('../../package.json').version)
             .option('-c, --child-directory-root <child-directory>', 'The directory that hosts the child packages relative to the parent root.', 'packages')
             .option('-d, --link-dev-dependencies <true|false>', describeLinking('devDependencies', true), parseBoolean, true)
             .option('-s, --link-dependencies <true|false>', describeLinking('dependencies', false), parseBoolean, false)
diff --git a/tasks/clean.js b/tasks/clean.js
diff --git a/test/helpers/chaiSetup.ts b/test/helpers/chaiSetup.ts
diff --git a/test/helpers/initSourceMapSupport.ts b/test/helpers/initSourceMapSupport.ts
diff --git a/test/helpers/log4jsConfig.ts b/test/helpers/log4jsConfig.ts
diff --git a/test/integration/sample.spec.ts b/test/integration/sample.spec.ts
@@ -11,7 +11,7 @@ const rm = (location: string) => new Promise((res, rej) => rimraf(location, err
     }
 }));
 
-const resolve = (relativePath: string) => path.resolve(__dirname, '../../sample', relativePath);
+const resolve = (relativePath: string) => path.resolve(__dirname, '../../../sample', relativePath);
 
 const execInSample = (cmd: string, cwd = '') => {
     console.log(`exec: ${cmd}`);
diff --git a/test/setup.ts b/test/setup.ts
@@ -0,0 +1,23 @@
+import * as chai from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+import * as sinonChai from 'sinon-chai';
+import * as log4js from 'log4js';
+import * as sinon from 'sinon';
+
+log4js.configure({
+    appenders: {
+        console: { type: 'stdout' }
+    },
+    categories: {
+        default: { appenders: ['console'], level: 'fatal' }
+    }
+});
+
+chai.use(chaiAsPromised);
+chai.use(sinonChai);
+
+export const mochaHooks = {
+    afterEach() {
+        sinon.restore();
+    }
+}
diff --git a/test/unit/ParentBinLinker.spec.ts b/test/unit/ParentBinLinker.spec.ts
@@ -29,8 +29,6 @@ describe('ParentBinLinker', () => {
         linkStub = sinon.stub(link, 'link');
     });
 
-    afterEach(() => sinon.restore());
-
     describe('linkBinsToChildren', () => {
 
         it('should reject when `readFile` rejects', () => {
diff --git a/test/unit/link.spec.ts b/test/unit/link.spec.ts
@@ -28,9 +28,6 @@ describe('link', () => {
         sinon.stub(log4js, 'getLogger').returns(logStub);
     });
 
-    afterEach(() => {
-        sinon.restore();
-    });
 
     describe('when platform !== win32', () => {
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -2,6 +2,7 @@
     "compilerOptions": {
         "module": "commonjs",
         "target": "es5",
+        "outDir": "dist",
         "noImplicitAny": true,
         "sourceMap": true,
         "noImplicitReturns": true,

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "require": ["source-map-support/register", "dist/test/setup.js"]`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@`
`4`	`4`
`5`	`5`	`process.title = 'parent-bin';`
`6`	`6`
`7`		`-require('../src/cli');`
	`7`	`+require('../dist/src/cli');`