@10stars/styleguide-ts

TSLint Config

TSLint shareable config

TODO

• [ ] Add jest tests

Install

npm i -g \
  @10stars/styleguide-ts \
  prettier \
  typescript \
  tslint \
  tslint-config-prettier \
  tslint-plugin-prettier \
  tslint-react \
  tslint-react-hooks

Usage

• If you use our bundler, then:
  • You DO NOT need to change your:
    • tslint.json and tsconfig.json

Read below if you use your own bundler

TSLint Configuration File Formats

Add tslint config from styleguide-ts/index.js to your tslint.json:

{
  // if you:
  //   - are on a MacOS
  //   - installed the package globally
  //   - do NOT use our bundler
  "extends": ["/usr/local/lib/node_modules/@10stars/styleguide-ts"]
}

Add base-tsconfig.json to your tsconfig.json:

{
  // if you:
  //   - are on a MacOS
  //   - installed the package globally
  //   - do NOT use our bundler
  "extends": [
    "/usr/local/lib/node_modules/@10stars/styleguide-ts/base-tsconfig.json"
  ]
}

NOT IMPORTANT - Usage in CLI

tslint --config @10stars/styleguide-ts

Note: It is not necessary to create the tslint.json file.