@h1nyc/eslint-config-precise

@h1nyc/eslint-config-precise

The @h1nyc/eslint-config-precise package is a set of linting and prettier rules for use in the H1-Precise family of products. The rules have been heavily borrowed from Google's TypeScript Style Guide. This package has not been configured for use in React projects, a seperate package will be created for that.

This configuration relies heavily on the goolge gts. GTS supplies most of the basline rules and styles used by this package. Additopnal rule configurations are set using the index.js script.

Usage

To use this package in your project follow the follow steps.

1. Add the following package as dev dependencies to your project

• eslint
• eslint-import-resolver-typescript
• eslint-plugin-filename-rules
• eslint-plugin-import
• gts
• lint-staged
• prettier

1. Update and run the startup.sh script in the repository root's folder. gts has some harcoded dependencies baked into the package. This script will create yarn links to resolve all of that.
2. Add this package to your project.
3. Add the following scripts to your package.json file:

• "lint": "gts lint"
• "clean": "gts clean"
• "fix": "gts fix"
• "precommit": "lint-staged"

1. Add the following configuration to your package.json file -- will enable pre-commit hooks.

  "lint-staged": {
    "*.{js,ts}": [
      "gts fix"
    ]
  }

Once set up you should be able to run gts lint to apply the rules to your project. gts fix can be run to fix those issues which can be automatically fixed.

Custom rules are defined in the index.js file and can be mondified there.