/tslint-config-fluct

TSLint configurations that are used by fluct division of VOYAGE GROUP, Inc.

Primary LanguageTypeScriptMIT LicenseMIT

tslint-config-fluct

Build Status

Basic Principles for Settings

  • Fill the rest of space which are not covered by TypeScript compiler.
    • So we recommends to use this as warning.
  • Ban a dangerous style.
  • Sort a style to avoid errors and to increase productivity.

How To Use

1. install to your project

  • As npm package (TBD. see #5)
  • Specify tar.gz to a dependency field in your package.json.
    • "tslint-config-fluct": "https://github.com/voyagegroup/tslint-config-fluct/archive/<COMMIT_HASH>.tar.gz".
    • Please replace <COMMIT_HASH> with tag name (e.g. v1.2.3), or an arbitary commit hash.
      • You can specify master or other branch directly. But we don't recommend it strongly.

2. Set up your tslint.json

{
    "extends": [
        "./node_modules/tslint-config-fluct/config/basic.json", // builtin basic rules.
        "./node_modules/tslint-config-fluct/config/typecheck.js" // builtin typecheck rules.
    ],

    "defaultSeverity": "warning",

    "rules": {
    }
}
  1. Import via extends fields in your tslint.json
  2. Set defaultSeverity.
  3. Enable/Disable more rules via rules by the requirement for your project.

see also: TSLint's document

License

Dependencies

  • yarn
    • We uses the latest now.