eslint-config

This ESLint config extends Airbnb's config (based on their style guide) to work with TypeScript.

Since the upstream config is well-maintained and justified, we try to stick as close to it as possible. All divergences are annotated, and tend towards increased ES2020 support, Prettier adoption, and TypeScript compatibility, rather than stylistic preferences.

Install

$ npm i -D eslint typescript @kensho-technologies/eslint-config

Usage

Add an ESLint config that extends the config to a project, e.g.:

{
  "extends": "@kensho-technologies/eslint-config"
}

Add scripts in package.json to run the linter, e.g.:

{
  "scripts": {
    "fix": "eslint --fix .",
    "test": "eslint ."
  }
}

License

Licensed under the Apache 2.0 License. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2020-present Kensho Technologies, LLC. The present date is determined by the timestamp of the most recent commit in the repository.