eslint-config-wt-browser

Hubspot Marketing WebTeam ESLing rules for Browsers

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

https://www.npmjs.com/package/eslint-config-wt-browser

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 it also include StyleLint as a linter for CSS/SCSS files.

Setup

• Install as dev dependency

npm i -D eslint-config-wt-browser

• Add to .eslintrc in project root directory

{
  "extends": "eslint-config-wt-browser"
}

• Extend the eslint on a project basis by adding rules to .eslintrc e.g.

{
  "extends": "eslint-config-wt-browser",
  "settings": {
    "import/resolver": "webpack"
  }
}

• Extend the style-lint rules on a project basis by adding a.stylelintrc.json:

{
  "extends": "./node_modules/eslint-config-wt-browser/.stylelintrc.json",
  "ignoreFiles": [
    // any folders to ignore
    // e.g. "./dist/**/*.{css,scss,sass}"
  ]
}

Migrating from an exisiting .eslint config

• Remove node_modules
• Delete package-lock.json
• npm i
• Re open your vscode/editor workspace
• Check if js linting and sass linting works

Reference https://eslint.org/docs/developer-guide/shareable-configs

Where to use it

This package is intended to be used as a starting point for ESLint rules for FrontEnd projects, and should be used in browser environments.