Merge branch 'feature/fix-windows-issues' into develop

dweber019 · dweber019 · commit 3a0d37595c60 · 2017-07-10T18:02:17.000+02:00
diff --git a/knexfile.ts b/knexfile.ts
diff --git a/nodemon.json b/nodemon.json
@@ -1,10 +1,9 @@
 {
     "delay": "0",
     "execMap": {
-        "ts": "./node_modules/.bin/ts-node"
+        "ts": "ts-node"
     },
     "events": {
-        "start": "./node_modules/.bin/tslint -c ./tslint.json -t stylish 'src/**/*.ts'",
-        "restart": "osascript -e 'display notification \"restarting server\" with title \"node.js application\"'"
+        "start": "tslint -c ./tslint.json -t stylish 'src/**/*.ts'"
     }
 }
diff --git a/package.json b/package.json
@@ -4,34 +4,34 @@
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
   "main": "src/app.ts",
   "scripts": {
-    "banner": "npm run ts-node:fast -- ./src/console/lib/banner.ts",
-    "ts-node": "./node_modules/.bin/ts-node",
-    "ts-node:fast": "./node_modules/.bin/ts-node -F",
+    "setup": "yarn install && npm run banner setup && npm run db:migrate && npm run db:seed",
+    "serve": "npm run banner serve && \"./node_modules/.bin/nodemon\" --watch src --watch .env",
+    "build": "npm run banner build && npm run lint && npm run clean:dist && npm run transpile && npm run copy:assets",
+    "start": "node dist/app.js",
     "pretest": "./node_modules/.bin/tslint -c ./tslint.json -t stylish './test/unit/**/*.ts'",
+    "test": "npm run banner test && cross-env NODE_ENV=test \"./node_modules/.bin/jest\" --testPathPattern=unit",
     "test:pretty": "npm run test -- --verbose",
     "test:coverage": "npm run test -- --coverage",
     "pretest:black-box": "./node_modules/.bin/tslint -c ./tslint.json -t stylish './test/black-box/**/*.ts'",
-    "test:black-box": "npm run banner test && NODE_ENV=test ./node_modules/.bin/jest ./test/black-box -i",
+    "test:black-box": "npm run banner test && cross-env NODE_ENV=test \"./node_modules/.bin/jest\" --testPathPattern=black-box -i",
     "test:black-box:pretty": "npm run test:black-box -- --verbose",
+    "db:migrate": "npm run banner migrate && \"./node_modules/.bin/knex\" migrate:latest",
+    "db:migrate:rollback": "npm run banner rollback && \"./node_modules/.bin/knex\" migrate:rollback",
+    "db:seed": "npm run banner seed && \"./node_modules/.bin/knex\" seed:run",
+    "db:reset": "npm run console db:reset",
+    "console": "npm run ts-node:fast -- ./src/console/lib/commander.ts",
+    "console:dev": "npm run ts-node -- ./src/console/lib/commander.ts",
+    "console:help": "npm run ts-node:fast -- ./src/console/lib/commander.ts --help",
     "lint": "./node_modules/.bin/tslint -c ./tslint.json -p tsconfig.json 'src/**/*.ts' --format stylish",
     "transpile": "./node_modules/.bin/tsc",
+    "clean": "npm run banner clean && npm run clean:dist",
     "clean:dist": "./node_modules/.bin/trash './dist'",
     "copy:assets": "npm run copy:swagger && npm run copy:public",
     "copy:swagger": "./node_modules/.bin/copyup ./src/api/swagger.json ./dist",
     "copy:public": "./node_modules/.bin/copyup ./src/public/* ./dist",
-    "db:migrate": "npm run banner migrate && npm run ts-node:fast -- ./node_modules/.bin/knex migrate:latest",
-    "db:migrate:rollback": "npm run banner rollback && npm run ts-node:fast -- ./node_modules/.bin/knex migrate:rollback",
-    "db:seed": "npm run banner seed && npm run ts-node:fast -- ./node_modules/.bin/knex seed:run",
-    "db:reset": "npm run console db:reset",
-    "console": "npm run ts-node:fast -- ./src/console/lib/commander.ts",
-    "console:dev": "npm run ts-node -- ./src/console/lib/commander.ts",
-    "console:help": "npm run ts-node:fast -- ./src/console/lib/commander.ts --help",
-    "setup": "npm run banner setup && yarn install && npm run db:migrate && npm run db:seed",
-    "serve": "npm run banner serve && ./node_modules/.bin/nodemon --watch 'src/**/*.ts' --watch 'src/**/*.json' --watch '.env'",
-    "clean": "npm run banner clean && npm run clean:dist",
-    "test": "npm run banner test && NODE_ENV=test ./node_modules/.bin/jest ./test/unit",
-    "build": "npm run banner build && npm run lint && npm run clean:dist && npm run transpile && npm run copy:assets",
-    "start": "node dist/app.js"
+    "banner": "npm run ts-node:fast -- ./src/console/lib/banner.ts",
+    "ts-node": "./node_modules/.bin/ts-node",
+    "ts-node:fast": "./node_modules/.bin/ts-node -F"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",
   "engines": {
@@ -146,5 +146,8 @@
     "testEnvironment": "node",
     "setupTestFrameworkScriptFile": "./test/unit/lib/setup.ts"
   },
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "cross-env": "^5.0.1"
+  }
 }
diff --git a/src/console/lib/commander.ts b/src/console/lib/commander.ts
@@ -15,6 +15,7 @@ import * as path from 'path';
 import * as commander from 'commander';
 import * as figlet from 'figlet';
 import * as chalk from 'chalk';
+import { isWindows } from './../../core/helpers/Path';
 
 // It also loads the .env file into the 'process.env' variable.
 import { config } from 'dotenv';
@@ -35,10 +36,10 @@ figlet('console', (error: any, data: any) => {
         }
 
         const files = matches
-            .filter(m => m.indexOf('/lib') < 0)
+            .filter(m => m.search(/\/lib/g) <= 0)
             .map(m => ({
                 path: m,
-                name: m.replace(__dirname.replace('/lib', ''), '').replace('.ts', '').substring(1)
+                name: m.replace((isWindows() ? __dirname.replace(/\\/g, '/') : __dirname).replace('/lib', ''), '').replace('.ts', '').substring(1)
             }));
 
         const commands = files.map(f => require(f.path)[f.name]);
diff --git a/src/core/ApiInfo.ts b/src/core/ApiInfo.ts
@@ -1,5 +1,4 @@
 import * as express from 'express';
-import * as path from 'path';
 import { Environment } from './helpers/Environment';
 import { SwaggerUI } from './SwaggerUI';
 import { ApiMonitor } from './ApiMonitor';
@@ -8,7 +7,7 @@ import { ApiMonitor } from './ApiMonitor';
 export class ApiInfo {
 
     public static getRoute(): string {
-        return path.join(process.env.APP_URL_PREFIX, process.env.API_INFO_ROUTE);
+        return process.env.APP_URL_PREFIX + process.env.API_INFO_ROUTE;
     }
 
     public setup(app: express.Application): void {
diff --git a/src/core/ApiMonitor.ts b/src/core/ApiMonitor.ts
@@ -1,13 +1,12 @@
 import * as express from 'express';
 import * as monitor from 'express-status-monitor';
-import * as path from 'path';
 import { Environment } from './helpers/Environment';
 
 
 export class ApiMonitor {
 
     public static getRoute(): string {
-        return path.join(process.env.MONITOR_ROUTE);
+        return process.env.MONITOR_ROUTE;
     }
 
     public setup(app: express.Application): void {
diff --git a/src/core/IoC.ts b/src/core/IoC.ts
@@ -13,6 +13,7 @@ import { Types, Core, Targets } from '../constants';
 import { events, EventEmitter } from './api/events';
 import { Logger } from './Logger';
 import { IocConfig } from '../config/IocConfig';
+import { getFolderwrapping } from './helpers/Path';
 
 
 export class IoC {
@@ -184,13 +185,13 @@ export class IoC {
     }
 
     private getBasePath(): string {
-        const baseFolder = __dirname.indexOf('/src/') >= 0 ? '/src/' : '/dist/';
+        const baseFolder = __dirname.indexOf(getFolderwrapping('src')) >= 0 ? getFolderwrapping('src') : getFolderwrapping('dist');
         const baseRoot = __dirname.substring(0, __dirname.indexOf(baseFolder));
         return path.join(baseRoot, baseFolder, 'api');
     }
 
     private getFiles(path: string, done: (files: any[]) => void): void {
-        const isTypeScript = __dirname.indexOf('/src/') >= 0;
+        const isTypeScript = __dirname.indexOf(getFolderwrapping('src')) >= 0;
         if (!isTypeScript) {
             path = path.replace('.ts', '.js');
         }
diff --git a/src/core/Logger.ts b/src/core/Logger.ts
@@ -1,3 +1,5 @@
+import { getFolderwrapping, isWindows } from './helpers/Path';
+
 /**
  * core.log.Log
  * ------------------------------------------------
@@ -30,10 +32,11 @@ export class Logger {
     private static Adapters: Map<string, interfaces.LoggerAdapterConstructor> = new Map();
 
     private static parsePathToScope(path: string): string {
-        if (path.indexOf('/') >= 0) {
+        const pathDelimiter = isWindows() ? '\\' : '/';
+        if (path.indexOf(pathDelimiter) >= 0) {
             path = path.replace(process.cwd(), '');
-            path = path.replace('/src/', '');
-            path = path.replace('/dist/', '');
+            path = path.replace(getFolderwrapping('src'), '');
+            path = path.replace(getFolderwrapping('dist'), '');
             path = path.replace('.ts', '');
             path = path.replace('.js', '');
             path = path.replace(/\//g, ':');
diff --git a/src/core/SwaggerUI.ts b/src/core/SwaggerUI.ts
@@ -2,20 +2,21 @@ import * as express from 'express';
 import * as path from 'path';
 import * as swaggerUi from 'swagger-ui-express';
 import { Environment } from './helpers/Environment';
+import { getFolderwrapping } from './helpers/Path';
 
 
 export class SwaggerUI {
 
     public static getRoute(): string {
-        return path.join(process.env.APP_URL_PREFIX, process.env.SWAGGER_ROUTE);
+        return process.env.APP_URL_PREFIX + process.env.SWAGGER_ROUTE;
     }
 
     public setup(app: express.Application): void {
         if (Environment.isTruthy(process.env.SWAGGER_ENABLED)) {
-            const baseFolder = __dirname.indexOf('/src/') >= 0 ? '/src/' : '/dist/';
+            const baseFolder = __dirname.indexOf(getFolderwrapping('src')) >= 0 ? getFolderwrapping('src') : getFolderwrapping('dist');
             const basePath = __dirname.substring(0, __dirname.indexOf(baseFolder));
             const swaggerFile = require(path.join(basePath, process.env.SWAGGER_FILE));
-            const packageJson = require(path.join(basePath, '/package.json'));
+            const packageJson = require(path.join(basePath, 'package.json'));
 
             // Add npm infos to the swagger doc
             swaggerFile.info = {
diff --git a/src/core/helpers/Path.ts b/src/core/helpers/Path.ts
@@ -0,0 +1,2 @@
+export const isWindows = (): boolean => /^win/.test(process.platform);
+export const getFolderwrapping = (input: string): string => isWindows() ? `\\${input}\\` : `/${input}/`;
diff --git a/src/types/knexfile.d.ts b/src/types/knexfile.d.ts
diff --git a/yarn.lock b/yarn.lock
@@ -1136,6 +1136,13 @@ create-error@~0.3.1:
   version "0.3.1"
   resolved "https://registry.yarnpkg.com/create-error/-/create-error-0.3.1.tgz#69810245a629e654432bf04377360003a5351a23"
 
+cross-env@^5.0.1:
+  version "5.0.1"
+  resolved "https://registry.yarnpkg.com/cross-env/-/cross-env-5.0.1.tgz#ff4e72ea43b47da2486b43a7f2043b2609e44913"
+  dependencies:
+    cross-spawn "^5.1.0"
+    is-windows "^1.0.0"
+
 cross-spawn-async@^2.1.1:
   version "2.2.5"
   resolved "https://registry.yarnpkg.com/cross-spawn-async/-/cross-spawn-async-2.2.5.tgz#845ff0c0834a3ded9d160daca6d390906bb288cc"
@@ -1150,6 +1157,14 @@ cross-spawn@^4.0.0:
     lru-cache "^4.0.1"
     which "^1.2.9"
 
+cross-spawn@^5.1.0:
+  version "5.1.0"
+  resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-5.1.0.tgz#e8bd0efee58fcff6f8f94510a0a554bbfa235449"
+  dependencies:
+    lru-cache "^4.0.1"
+    shebang-command "^1.2.0"
+    which "^1.2.9"
+
 cryptiles@2.x.x:
   version "2.0.5"
   resolved "https://registry.yarnpkg.com/cryptiles/-/cryptiles-2.0.5.tgz#3bdfecdc608147c1c67202fa291e7dca59eaa3b8"
@@ -2305,6 +2320,10 @@ is-windows@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/is-windows/-/is-windows-0.2.0.tgz#de1aa6d63ea29dd248737b69f1ff8b8002d2108c"
 
+is-windows@^1.0.0:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/is-windows/-/is-windows-1.0.1.tgz#310db70f742d259a16a369202b51af84233310d9"
+
 isarray@0.0.1:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf"
@@ -4064,6 +4083,16 @@ setprototypeof@1.0.3:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/setprototypeof/-/setprototypeof-1.0.3.tgz#66567e37043eeb4f04d91bd658c0cbefb55b8e04"
 
+shebang-command@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea"
+  dependencies:
+    shebang-regex "^1.0.0"
+
+shebang-regex@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3"
+
 shellwords@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.0.tgz#66afd47b6a12932d9071cbfd98a52e785cd0ba14"

Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,9 @@`
`1`	`1`	`{`
`2`	`2`	`"delay": "0",`
`3`	`3`	`"execMap": {`
`4`		`- "ts": "./node_modules/.bin/ts-node"`
	`4`	`+ "ts": "ts-node"`
`5`	`5`	`},`
`6`	`6`	`"events": {`
`7`		`- "start": "./node_modules/.bin/tslint -c ./tslint.json -t stylish 'src/*/.ts'",`
`8`		`- "restart": "osascript -e 'display notification \"restarting server\" with title \"node.js application\"'"`
	`7`	`+ "start": "tslint -c ./tslint.json -t stylish 'src/*/.ts'"`
`9`	`8`	`}`
`10`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ import { Types, Core, Targets } from '../constants';`
`13`	`13`	`import { events, EventEmitter } from './api/events';`
`14`	`14`	`import { Logger } from './Logger';`
`15`	`15`	`import { IocConfig } from '../config/IocConfig';`
	`16`	`+import { getFolderwrapping } from './helpers/Path';`
`16`	`17`
`17`	`18`
`18`	`19`	`export class IoC {`
`@@ -184,13 +185,13 @@ export class IoC {`
`184`	`185`	`}`
`185`	`186`
`186`	`187`	`private getBasePath(): string {`
`187`		`- const baseFolder = __dirname.indexOf('/src/') >= 0 ? '/src/' : '/dist/';`
	`188`	`+ const baseFolder = __dirname.indexOf(getFolderwrapping('src')) >= 0 ? getFolderwrapping('src') : getFolderwrapping('dist');`
`188`	`189`	`const baseRoot = __dirname.substring(0, __dirname.indexOf(baseFolder));`
`189`	`190`	`return path.join(baseRoot, baseFolder, 'api');`
`190`	`191`	`}`
`191`	`192`
`192`	`193`	`private getFiles(path: string, done: (files: any[]) => void): void {`
`193`		`- const isTypeScript = __dirname.indexOf('/src/') >= 0;`
	`194`	`+ const isTypeScript = __dirname.indexOf(getFolderwrapping('src')) >= 0;`
`194`	`195`	`if (!isTypeScript) {`
`195`	`196`	`path = path.replace('.ts', '.js');`
`196`	`197`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export const isWindows = (): boolean => /^win/.test(process.platform);`
	`2`	+export const getFolderwrapping = (input: string): string => isWindows() ? `\\${input}\\` : `/${input}/`;