Boilerplate refinement and general clean up

.eslintignore

@@ -1,3 +1,2 @@
-node_modules/
 build/
 coverage/

.eslintrc.js

@@ -12,6 +12,10 @@ module.exports = {
     node: true,
     jest: true,
   },
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
   settings: {
     'import/resolver': {
       node: {

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npm run prettier-format && npm run lint
+ npm run pretty:fix && npm run lint && npm run test

.prettierignore

@@ -0,0 +1 @@
+build/

.vscode/settings.json

@@ -4,22 +4,12 @@
     "source.fixAll.eslint": true
   },
   "eslint.validate": ["javascript", "typescript"],
-  "editor.formatOnPaste": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
-  "[javascript]": {
-    "editor.formatOnSave": true
-  },
-  "[typescript]": {
-    "editor.formatOnSave": true
-  },
+  "editor.formatOnPaste": true,
   "[markdown]": {
-    "editor.formatOnSave": false
-  },
-  "search.exclude": {
-    "**/node_modules": true,
-    "**/bower_components": true,
-    "**/dist": true,
-    "**/coverage": true
+    "editor.formatOnSave": false,
+    "editor.formatOnPaste": false,
   },
-  "typescript.referencesCodeLens.enabled": true
+  "typescript.referencesCodeLens.enabled": true,
 }

README.md

@@ -30,7 +30,7 @@ cd <project_name>
 npm install
 ```
 
-- Build and run the project
+- Generate production build and run the project
 
 ```bash
 npm start
@@ -42,6 +42,26 @@ npm start
 npm run dev
 ```
 
+- Linting
+
+```bash
+npm run lint
+npm run lint:fix
+```
+
+- Code formatting
+
+```bash
+npm run pretty
+npm run pretty:fix
+```
+
+- Testing
+
+```bash
+npm test
+```
+
 ## Sources
 
 #### Official TypeScript-Node-Starter:

package.json

@@ -2,13 +2,14 @@
   "name": "typescript-node-starter",
   "version": "1.0.0",
   "description": "A minimal boilerplate for Node.js web applications written in TypeScript.",
-  "main": "index.js",
+  "main": "./build/index.js",
   "scripts": {
     "start": "npm run build && node build/index.js",
     "build": "rimraf ./build && tsc",
     "dev": "nodemon",
-    "prettier-format": "prettier --config .prettierrc 'src/**/*.ts' --write",
-    "lint": "eslint . --ext .ts",
+    "pretty": "prettier --config .prettierrc 'src/**/*.ts'",
+    "pretty:fix": "npm run pretty -- --write",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
     "lint:fix": "npm run lint -- --fix",
     "test": "jest",
     "test:watch": "jest --watchAll",
@@ -19,7 +20,7 @@
     "url": "git+https://github.com/nicksp/typescript-node-starter.git"
   },
   "keywords": [],
-  "author": "",
+  "author": "Nick Khan",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/nicksp/typescript-node-starter/issues"

tsconfig.json

@@ -1,3 +1,7 @@
+/**
+ * This is a typescript configuration file.
+ * See options https://www.typescriptlang.org/tsconfig
+ */
 {
   "compilerOptions": {
     "target": "es6",
@@ -11,6 +15,7 @@
     "types": ["node", "jest"],
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
+    "allowUnreachableCode": false,
     "resolveJsonModule": true,
     "noImplicitAny": true,
     "sourceMap": true