A starter project with tests for creating own rules for TSLint
Includes:
Main language: TypeScript
Package manager: yarn
yarn install
- to install dependencies
dev
- runs the lint for sandboxtest
- runs rules testsbuild
- compile project to dist folderDelivery it to node_modules
(as npm package or just copy) and configure tslint.json
of your project.
{
"rulesDirectory": [
...
"node_modules/rules"
],
"rules": {
...
"no-multiline-ternary": true
}
}
.
dist - Output folder, compiled rules will be there
helpers
linter.ts - Used for running linter in specs
rules - Rules and specs
sandbox.ts - Develop and test you rules here
tsconfig.dev.json - Config for running lint only for sandbox
tsconfig.json - TS configuration for current project
tsconfig.spec.json - TS configuration for jest
tslint.json - TS Lint configuration for current project
package.json
README.md
yarn.lock
@types/*
- contains type definitions for specific library.jest
- testing framework to write unit specs.ts-jest
- it lets you use Jest to test projects written in TypeScript.tslint
- it checks TypeScript code for readability, maintainability, and functionality errors.typescript
- is a superset of JavaScript that have static type-checking and ECMAScript features.