fix(readme): update
This commit is contained in:
		| @@ -26,6 +26,7 @@ mirror: | |||||||
| snyk: | snyk: | ||||||
|   stage: security |   stage: security | ||||||
|   script: |   script: | ||||||
|  |     - npmci npm prepare | ||||||
|     - npmci command npm install -g snyk |     - npmci command npm install -g snyk | ||||||
|     - npmci command npm install --ignore-scripts |     - npmci command npm install --ignore-scripts | ||||||
|     - npmci command snyk test |     - npmci command snyk test | ||||||
| @@ -33,24 +34,39 @@ snyk: | |||||||
|   - docker |   - docker | ||||||
|   - notpriv |   - 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 | # 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: | testLTS: | ||||||
|   stage: test |   stage: test | ||||||
|   script: |   script: | ||||||
|  |   - npmci npm prepare | ||||||
|   - npmci node install lts |   - npmci node install lts | ||||||
|   - npmci npm install |   - npmci npm install | ||||||
|   - npmci npm test |   - npmci npm test | ||||||
| @@ -62,6 +78,7 @@ testLTS: | |||||||
| testSTABLE: | testSTABLE: | ||||||
|   stage: test |   stage: test | ||||||
|   script: |   script: | ||||||
|  |   - npmci npm prepare | ||||||
|   - npmci node install stable |   - npmci node install stable | ||||||
|   - npmci npm install |   - npmci npm install | ||||||
|   - npmci npm test |   - npmci npm test | ||||||
| @@ -118,6 +135,7 @@ pages: | |||||||
|   stage: metadata |   stage: metadata | ||||||
|   script: |   script: | ||||||
|     - npmci command npm install -g typedoc typescript |     - npmci command npm install -g typedoc typescript | ||||||
|  |     - npmci npm prepare | ||||||
|     - npmci npm install |     - npmci npm install | ||||||
|     - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/ |     - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/ | ||||||
|   tags: |   tags: | ||||||
| @@ -130,13 +148,3 @@ pages: | |||||||
|     paths: |     paths: | ||||||
|     - public |     - public | ||||||
|   allow_failure: true |   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 |  | ||||||
|   | |||||||
| @@ -1,8 +1,17 @@ | |||||||
| { | { | ||||||
|   "npmts": { |   "npmts": {}, | ||||||
|   }, |  | ||||||
|   "npmci": { |   "npmci": { | ||||||
|     "npmGlobalTools": [], |     "npmGlobalTools": [], | ||||||
|     "npmAccessLevel": "public" |     "npmAccessLevel": "public" | ||||||
|  |   }, | ||||||
|  |   "gitzone": { | ||||||
|  |     "module": { | ||||||
|  |       "githost": "gitlab.com", | ||||||
|  |       "gitscope": "gitzone", | ||||||
|  |       "gitrepo": "tsrun", | ||||||
|  |       "shortDescription": "run typescript programs efficiently", | ||||||
|  |       "npmPackagename": "@gitzone/tsrun", | ||||||
|  |       "license": "MIT" | ||||||
|  |     } | ||||||
|   } |   } | ||||||
| } | } | ||||||
| @@ -26,4 +26,4 @@ | |||||||
|     "typescript": "^3.3.3333" |     "typescript": "^3.3.3333" | ||||||
|   }, |   }, | ||||||
|   "private": false |   "private": false | ||||||
| } | } | ||||||
							
								
								
									
										41
									
								
								readme.md
									
									
									
									
									
								
							
							
						
						
									
										41
									
								
								readme.md
									
									
									
									
									
								
							| @@ -1,25 +1,20 @@ | |||||||
| # tsrun | # @gitzone/tsrun | ||||||
|  |  | ||||||
| run typescript programs efficiently | run typescript programs efficiently | ||||||
|  |  | ||||||
| ## Availabililty | ## Availabililty and Links | ||||||
|  | * [npmjs.org (npm package)](https://www.npmjs.com/package/@gitzone/tsrun) | ||||||
| [](https://www.npmjs.com/package/@gitzone/tsrun) | * [gitlab.com (source)](https://gitlab.com/gitzone/tsrun) | ||||||
| [](https://GitLab.com/gitzone/tsrun) | * [github.com (source mirror)](https://github.com/gitzone/tsrun) | ||||||
| [](https://github.com/gitzone/tsrun) | * [docs (typedoc)](https://gitzone.gitlab.io/tsrun/) | ||||||
| [](https://gitzone.gitlab.io/tsrun/) |  | ||||||
|  |  | ||||||
| ## Status for master | ## Status for master | ||||||
|  | [](https://gitlab.com/gitzone/tsrun/commits/master) | ||||||
| [](https://GitLab.com/gitzone/tsrun/commits/master) | [](https://gitlab.com/gitzone/tsrun/commits/master) | ||||||
| [](https://GitLab.com/gitzone/tsrun/commits/master) |  | ||||||
| [](https://www.npmjs.com/package/@gitzone/tsrun) | [](https://www.npmjs.com/package/@gitzone/tsrun) | ||||||
| [](https://www.bithound.io/github/gitzonetools/tsrun/master/dependencies/npm) |  | ||||||
| [](https://www.bithound.io/github/gitzonetools/tsrun) |  | ||||||
| [](https://snyk.io/test/npm/@gitzone/tsrun) | [](https://snyk.io/test/npm/@gitzone/tsrun) | ||||||
| [](https://nodejs.org/dist/latest-v6.x/docs/api/) | [](https://nodejs.org/dist/latest-v10.x/docs/api/) | ||||||
| [](https://nodejs.org/dist/latest-v6.x/docs/api/) | [](https://nodejs.org/dist/latest-v10.x/docs/api/) | ||||||
| [](http://standardjs.com/) | [](https://prettier.io/) | ||||||
|  |  | ||||||
| ## Usage | ## Usage | ||||||
|  |  | ||||||
| @@ -31,13 +26,13 @@ To simply run a TypeScript file on the fly type | |||||||
| tsrun myfiletorun.ts | tsrun myfiletorun.ts | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| There are two options available: | There are 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. |  | ||||||
|  |  | ||||||
| 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 | **©** [Lossless GmbH](https://lossless.gmbh) | For further information read the linked docs at the top of this readme. | ||||||
| > | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) |  | ||||||
|  |  | ||||||
| [](https://git.zone) | > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) | ||||||
|  | | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html) | ||||||
|  |  | ||||||
|  | [](https://maintainedby.lossless.com) | ||||||
|   | |||||||
| @@ -16,7 +16,7 @@ if (process.argv.includes('--web')) { | |||||||
|   defaultTsNodeOptions.compilerOptions = { |   defaultTsNodeOptions.compilerOptions = { | ||||||
|     ...previousCompilerOptions, |     ...previousCompilerOptions, | ||||||
|     lib: [...previousCompilerOptions.lib, 'dom'] |     lib: [...previousCompilerOptions.lib, 'dom'] | ||||||
|   } |   }; | ||||||
| } | } | ||||||
|  |  | ||||||
| if (process.argv.includes('--nocache')) { | if (process.argv.includes('--nocache')) { | ||||||
|   | |||||||
							
								
								
									
										16
									
								
								tslint.json
									
									
									
									
									
								
							
							
						
						
									
										16
									
								
								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" | ||||||
| } | } | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user