@node-ts/code-standards
Advanced tools
Comparing version 0.0.5 to 0.0.6
{ | ||
"name": "@node-ts/code-standards", | ||
"version": "0.0.5", | ||
"version": "0.0.6", | ||
"repository": "github:node-ts/code-standards", | ||
@@ -5,0 +5,0 @@ "description": "A sane and opinionated set of linting rules for TypeScript", |
@@ -45,5 +45,5 @@ # @node-ts/code-standards | ||
```sh | ||
npm i @node-ts/code-standards tslint typescript --save-dev | ||
``` | ||
```sh | ||
npm i @node-ts/code-standards tslint typescript --save-dev | ||
``` | ||
@@ -54,24 +54,24 @@ 2. Copy `.editorconfig` into the root of your project. This will let your code editor confirm to many of the whitespacing rules automatically. See [Editor Config](https://editorconfig.org/) on setting up your code editor for the first time. | ||
```json | ||
{ | ||
"extends": "./node_modules/@node-ts/code-standards/tslint.json" | ||
} | ||
``` | ||
```json | ||
{ | ||
"extends": "./node_modules/@node-ts/code-standards/tslint.json" | ||
} | ||
``` | ||
4. Create a `tsconfig.json` file in the root of your project with the following contents. You may wish to extend this with further options | ||
```json | ||
{ | ||
"extends": "./node_modules/@node-ts/code-standards/tsconfig.json" | ||
} | ||
``` | ||
```json | ||
{ | ||
"extends": "./node_modules/@node-ts/code-standards/tsconfig.json" | ||
} | ||
``` | ||
5. Add the following to the `scripts` block in your project's `package.json`: | ||
```json | ||
{ | ||
"lint": "tslint --project tsconfig.json 'src/**/*.ts'", | ||
"lint:fix": "npm lint --fix" | ||
} | ||
``` | ||
```json | ||
{ | ||
"lint": "tslint --project tsconfig.json 'src/**/*.ts'", | ||
"lint:fix": "npm lint --fix" | ||
} | ||
``` | ||
@@ -78,0 +78,0 @@ ## IDE Configuration |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
12216