resolves #116

Author: etsuo

README.md

@@ -170,7 +170,7 @@ This is a new tiny community, so if you don't get a response right away, it migh
 
 ## Dependencies:
 
-* TypeScript >= 2.2
+* TypeScript >= 2.6
 * NodeJS >= 8.0
 
 (among other things)
@@ -268,3 +268,31 @@ There are some properties in the environmental config that are used by the syste
 ```
 Naturally, anything you define is available to you. You get access to the configuration through `SakuraApi.instsance.config`.
 
+# Some tips for contributing to SakuraApi
+
+## Dependencies
+To build this project you must have:
+
+* npm 5+
+* node
+* docker
+* a bash compatible terminal
+
+## Building the Project
+
+* `npm run build`: builds the project and outputs the build to `lib/`
+* `npm start`: builds the project and continually monitors for changes, which trigger builds
+* `npm run start:test`: builds the project and continually monitors for changes, which trigger tests to be re-run (continual testing)
+* `doc:generate`: serves up the doc files -- do not commit these unless you are responsible for publishing a release 
+
+## Testing
+
+* `npm test`: runs the full suite of tests
+* `npm run test:db`: runs the full suite of tests and preserves the DB (`docker ps`, connect via port 37001). This is helpful if you need to inspect the state of the database during test development
+* `npm run test:debug`: runs tests with `DEBUG=sapi:*,-sapi:*:verbose` set
+* `npm run test:verbose`: runs tests with `DEBUG=sapi:*` set
+* `npm run test:vverbose`: runs tests with `DEBUG=*` set
+
+## Lint
+
+* `npm run lint`

package.json

@@ -10,32 +10,23 @@
     "lib/index.*"
   ],
   "scripts": {
-    "build": "rm -rf lib/ ; tsc && rsync -r --exclude=*.ts spec/ lib/spec",
-    "coverage": "npm run docker:compose-test && npm run build && istanbul cover --include-all-sources node_modules/jasmine/bin/jasmine.js && docker-compose down && (open coverage/lcov-report/index.html || echo '')",
+    "build": "./scripts/build.sh",
+    "coverage": "./scripts/coverage.sh",
     "doc:generate": "./scripts/doc:generate.sh",
-    "doc:serve": "nodemon --config nodemon.typedoc.json -e ts --exec 'npm run doc:generate && npm run http-server docs/ -- -a localhost -c-1'",
-    "docker:compose-test": "(docker volume prune -f || echo \"skipped docker volume prune\") ; docker-compose up -d --remove-orphans",
-    "http-server": "http-server",
+    "doc:serve": "./scripts/doc:serve.sh",
+    "docker:compose-test": "./scripts/docker:compose-test.sh",
     "install": "chmod +x scripts/*.* || true",
-    "istanbul": "istanbul",
-    "jasmine": "jasmine",
-    "lint": "npm run build && npm run lint:code && npm run lint:tests",
-    "lint:code": "echo 'CODE LINT' ; npm run tslint -- -t stylish -c tslint.json -p tsconfig.json",
-    "lint:tests": "echo 'TEST LINT' ; npm run tslint -- -t stylish -c tslint.spec.json -p tsconfig.json",
-    "nsp": "nsp",
-    "prepublish": "npm test && npm run nsp check",
-    "say:fail": "say 'fail' || echo ''",
-    "say:pass": "say 'pass' || echo ''",
+    "lint": "./scripts/lint.sh",
+    "prepublish": "npm test && npx nsp check",
+    "say:fail": "say 'fail' || echo 'fail'",
+    "say:pass": "say 'pass' || echo 'pass'",
     "start": "nodemon --exec \"npm run build; echo build done\"",
     "start:test": "nodemon --exec \"npm test\"",
-    "test": "npm run docker:compose-test && npm run build && ((npm run jasmine && npm run say:pass) || npm run say:fail) && docker-compose down",
-    "test:db": "npm run docker:compose-test && npm run build && ((npm run jasmine && npm run say:pass) || npm run say:fail)",
-    "test:trace": "npm test",
+    "test": "./scripts/test.sh",
+    "test:db": "./scripts/test.sh saveDb",
     "test:debug": "DEBUG=sapi:*,-sapi:*:verbose npm test",
     "test:verbose": "DEBUG=sapi:* npm test",
-    "test:vverbose": "DEBUG=* npm test",
-    "tsc": "tsc",
-    "tslint": "tslint"
+    "test:vverbose": "DEBUG=* npm test"
   },
   "repository": {
     "type": "git",

scripts/build.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+set -ex
+
+rm -rf lib/
+npx tsc
+rsync -r --exclude=*.ts spec/ lib/spec

scripts/coverage.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -ex
+npm run docker:compose-test
+npm run build
+npx istanbul cover --include-all-sources node_modules/jasmine/bin/jasmine.js
+docker-compose down
+(open coverage/lcov-report/index.html || echo '')

scripts/doc:serve.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+set -ex
+nodemon --config nodemon.typedoc.json -e ts --exec 'npm run doc:generate && npx http-server docs/ -- -a localhost -c-1'

scripts/docker:compose-test.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -ex
+docker volume prune -f || echo \"skipped docker volume prune\"
+docker-compose up -d --remove-orphans

scripts/lint.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+npm run build
+npx tslint -t stylish -c tslint.json -p tsconfig.json

scripts/test.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -ex
+
+TEST_TYPE=${1:-clearDb}
+
+npm run docker:compose-test
+npm run build
+((npx jasmine && npm run say:pass) || npm run say:fail)
+
+if [ $TEST_TYPE != "saveDb" ]; then
+  docker-compose down
+fi

tslint.json

@@ -3,19 +3,23 @@
   "defaultSeverity": "warning",
   "rules": {
     "curly": true,
+    "interface-name": false,
     "max-classes-per-file": false,
-    "member-access": [
-      true,
-      "no-public"
-    ],
     "max-line-length": [
       true,
       128
     ],
+    "member-access": [
+      true,
+      "no-public"
+    ],
     "no-implicit-dependencies": [
       true,
       "dev"
     ],
+    "no-object-literal-type-assertion": false,
+    "prefer-for-of": false,
+    "prefer-object-spread": false,
     "quotemark": [
       true,
       "single",
@@ -28,14 +32,10 @@
         "singleline": "never"
       }
     ],
-    "interface-name": false,
-    "prefer-object-spread": false,
     "variable-name": [
       true,
       "allow-leading-underscore"
-    ],
-    "no-object-literal-type-assertion": false,
-    "prefer-for-of": false
+    ]
   },
   "jsRules": {
     "curly": true