fix(readme): update

2019-03-02 23:03:05 +01:00
parent 1d5766435a
commit 98cde0edb4
6 changed files with 75 additions and 49 deletions
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -26,6 +26,7 @@ mirror:
 snyk:
  stage: security
  script:
+    - npmci npm prepare
    - npmci command npm install -g snyk
    - npmci command npm install --ignore-scripts
    - npmci command snyk test
@@ -33,24 +34,39 @@ snyk:
  - docker
  - notpriv

+sast:
+  stage: security
+  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command npm run build
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
+        --volume "$PWD:/code"
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
+  artifacts:
+    reports:
+      sast: gl-sast-report.json
+  tags:
+  - docker
+  - priv
+
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true

 testLTS:
  stage: test
  script:
+  - npmci npm prepare
  - npmci node install lts
  - npmci npm install
  - npmci npm test
@@ -62,6 +78,7 @@ testLTS:
 testSTABLE:
  stage: test
  script:
+  - npmci npm prepare
  - npmci node install stable
  - npmci npm install
  - npmci npm test
@@ -118,6 +135,7 @@ pages:
  stage: metadata
  script:
    - npmci command npm install -g typedoc typescript
+    - npmci npm prepare
    - npmci npm install
    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
  tags:
@@ -130,13 +148,3 @@ pages:
    paths:
    - public
  allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true
--- a/npmextra.json
+++ b/npmextra.json
@@ -1,8 +1,17 @@
 {
-  "npmts": {
-  },
+  "npmts": {},
  "npmci": {
    "npmGlobalTools": [],
    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "gitzone",
+      "gitrepo": "tsrun",
+      "shortDescription": "run typescript programs efficiently",
+      "npmPackagename": "@gitzone/tsrun",
+      "license": "MIT"
+    }
  }
 }
--- a/readme.md
+++ b/readme.md
@@ -1,25 +1,20 @@
-# tsrun
-
+# @gitzone/tsrun
 run typescript programs efficiently

-## Availabililty
-
-[![npm](https://gitzone.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/@gitzone/tsrun)
-[![git](https://gitzone.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/gitzone/tsrun)
-[![git](https://gitzone.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/gitzone/tsrun)
-[![docs](https://gitzone.gitlab.io/assets/repo-button-docs.svg)](https://gitzone.gitlab.io/tsrun/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsrun)
+* [gitlab.com (source)](https://gitlab.com/gitzone/tsrun)
+* [github.com (source mirror)](https://github.com/gitzone/tsrun)
+* [docs (typedoc)](https://gitzone.gitlab.io/tsrun/)

 ## Status for master
-
-[![build status](https://GitLab.com/gitzone/tsrun/badges/master/build.svg)](https://GitLab.com/gitzone/tsrun/commits/master)
-[![coverage report](https://GitLab.com/gitzone/tsrun/badges/master/coverage.svg)](https://GitLab.com/gitzone/tsrun/commits/master)
+[![build status](https://gitlab.com/gitzone/tsrun/badges/master/build.svg)](https://gitlab.com/gitzone/tsrun/commits/master)
+[![coverage report](https://gitlab.com/gitzone/tsrun/badges/master/coverage.svg)](https://gitlab.com/gitzone/tsrun/commits/master)
 [![npm downloads per month](https://img.shields.io/npm/dm/@gitzone/tsrun.svg)](https://www.npmjs.com/package/@gitzone/tsrun)
-[![bitHound Dependencies](https://www.bithound.io/github/gitzonetools/tsrun/badges/dependencies.svg)](https://www.bithound.io/github/gitzonetools/tsrun/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/gitzonetools/tsrun/badges/code.svg)](https://www.bithound.io/github/gitzonetools/tsrun)
 [![Known Vulnerabilities](https://snyk.io/test/npm/@gitzone/tsrun/badge.svg)](https://snyk.io/test/npm/@gitzone/tsrun)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)

 ## Usage

@@ -31,13 +26,13 @@ To simply run a TypeScript file on the fly type
 tsrun myfiletorun.ts
 ```

-There are two options available:
-* `--nocache` will disable any caching. Caching speeds up execution, but causes problems in read only environments (e.g. sometimes docker containers are readonly)
-* `--web` will inject browser types. this is useful when testing code with polyfills on node, but that is meant for the browser later on.
+There are options available:

-For further information read the linked docs at the top of this README.
+- `--web` will inject browser types. this is useful when testing code with polyfills on node, but that is meant for the browser later on.

-> licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+For further information read the linked docs at the top of this readme.

-[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://git.zone)
+> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://gitzone.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
--- a/ts/index.ts
+++ b/ts/index.ts
@@ -16,7 +16,7 @@ if (process.argv.includes('--web')) {
  defaultTsNodeOptions.compilerOptions = {
    ...previousCompilerOptions,
    lib: [...previousCompilerOptions.lib, 'dom']
-  }
+  };
 }

 if (process.argv.includes('--nocache')) {
--- a/tslint.json
+++ b/tslint.json
@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
 }