@hs-web-team/eslint-config-ts

Hubspot Marketing WebTeam ESLint rules for TypeScript

This is a list of TypeScript rules that are recommended for use with Hubspot Marketing WebTeam projects.

https://www.npmjs.com/package/@hs-web-team/eslint-config-ts

Index

• Introduction
• Setup
• Migrating from an exisiting .eslint config
• Where to use it

Introduction

This is a set of ESLint rules that are recommended for use with Hubspot Marketing WebTeam projects, and can be used in conjunction with the browser or node linting packages.

Note that this package will only apply rules to TypeScript files (.ts and .tsx). It will not apply rules to JavaScript files (.js and .jsx). You must use the browser or node linting packages to use ESLint rules for vanilla JavaScript files.

Setup

1. Install as dev dependency

npm i -D @hs-web-team/eslint-config-ts

2. Add to .eslintrc in project root directory

{
  "extends": "@hs-web-team/eslint-config-ts"
}

or when used with the browser/node rules:

{
  "extends": [
    "@hs-web-team/eslint-config-browser", // or "@hs-web-team/eslint-config-node"
    "@hs-web-team/eslint-config-ts"
  ],
}

Migrating from an existing .eslint config

1. Remove node_modules
2. Delete package-lock.json
3. npm install
4. Re open your vscode/editor workspace
5. Check if ts linting is working

References

Shareable ESLint Configs Reference

Where to use it

This package is intended to be used in projects that use TypeScript, in conjunction with either the Node or Browser linting packages.