@storybrandhq/eslint-config

Shared ESLint rules across StoryBrand apps.

Rules

Restricted Syntax

• Cannot set document.cookie directly

  document.cookie = '...'; // No ❌

  import { setCookie } from '@storybrandhq/gtm-cookie-consent';
  
  setCookie('...'); // Yes ✅

Restricted Imports

• Cannot use the js-cookie package

  import Cookies from 'js-cookie'; // No ❌

  import { setCookie, getCookie } from '@storybrandhq/gtm-cookie-consent'; // Yes ✅

Install

npm

npm i -D @storybrandhq/eslint-config

yarn

yarn add -D @storybrandhq/eslint-config eslint

Usage

.eslintrc.json

{
  "extends": ["@storybrandhq/eslint-config"]
}

.eslintrc.js

module.exports = {
  extends: ['@storybrandhq/eslint-config'],
}

.eslintrc.yml / .eslintrc.yaml

extends:
  - '@storybrandhq/eslint-config'

package.json

{
  "eslintConfig": {
    "extends": ["@storybrandhq/eslint-config"]
  }
}

eslint.config.js (ESLint 9+)

const storybrandConfig = require('@storybrandhq/eslint-config')
 
module.exports = [
  {
    rules: storybrandConfig.rules,
  },
]