https://github.com/valor-software/tslint-rules-valorsoft
https://github.com/valor-software/tslint-rules-valorsoft
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/valor-software/tslint-rules-valorsoft
- Owner: valor-software
- License: mit
- Created: 2017-12-25T16:50:33.000Z (over 8 years ago)
- Default Branch: development
- Last Pushed: 2018-02-28T08:28:09.000Z (over 8 years ago)
- Last Synced: 2025-09-01T03:41:05.143Z (10 months ago)
- Language: TypeScript
- Size: 12.7 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tslint-rules-valorsoft
## Install
Install the package using NPM:
npm install tslint-rules-valorsoft --save-dev
Update your `tslint.json` file to extend this package:
```json
{
"rulesDirectory": [
"tslint-rules-valorsoft"
],
"rules": {
"no-cross-dependencies": [true, "path/to/module"],
"ng-on-changes-interface": true,
"no-empty-spec": true,
"no-input-string-binding": true
}
}
```
### Rules
The package includes the following rules:
| Rule | Description | Options |
| --- | --- | --- |
| `no-cross-dependencies` | Disallows import of data from these modules to that module directly via `import` or `require`.
Instead only internal may be imported from that module. | [See below](#no-cross-dependencies) |
| `ng-on-changes-interface` | Use appropriate type `SimpleChanges` for `ngOnChanges`. | None |
| `no-empty-spec` | Disallows empty spec blocks. | None |
| `no-input-string-binding` | Do not use Input string binding. | None |
### Options
#### `no-cross-dependencies`
The `no-cross-dependencies` rule takes an array of paths. This is the path of the module - relative to the root of the project.
For example:
```json
"rules": {
"no-cross-dependencies": [true, "path/to/module1", "path/to/module2"]
}
```
## Development
```sh
# lint
npm run lint
# build
npm run build
# test
npm run test
```