@wistia/eslint-config 0.0.10

package/.commitlintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+};

package/.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+  },
+  parser: '@babel/eslint-parser',
+  parserOptions: {
+    requireConfigFile: false,
+  },
+  extends: ['prettier'],
+  plugins: ['prettier'],
+  rules: {
+    // prettier configuration
+    'prettier/prettier': 'error',
+  },
+};

package/.github/workflows/commitlint.yml

@@ -0,0 +1,23 @@
+name: Commitlint
+
+on: pull_request
+
+jobs:
+  run-commitlint:
+    name: Run commitlint
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+
+    steps:
+      - name: Check out Git respository
+        uses: actions/checkout@v2.3.4
+        with:
+          # by default this only fetches the latest commit,
+          # but more commits are needed to validate a range of commit messages
+          fetch-depth: 0
+
+      - name: Validate commit messages
+        uses: wagoid/commitlint-github-action@v4
+        with:
+          configFile: .commitlintrc.js
+          helpURL: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

package/.github/workflows/lint.yml

@@ -0,0 +1,41 @@
+name: Lint
+
+on: pull_request
+
+env:
+  NODE_VERSION: 14.15.4
+
+jobs:
+  run-linters:
+    name: Run linters
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+
+    steps:
+      - name: Set up Node.js environment
+        uses: actions/setup-node@v2-beta
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+
+      - name: Check out Git respository
+        uses: actions/checkout@v2.3.4
+
+      - name: Cache node_modules
+        uses: actions/cache@v2
+        id: cache-modules
+        with:
+          path: '**/node_modules'
+          key: ${{ runner.os }}-node${{ env.NODE_VERSION }}-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node${{ env.NODE_VERSION }}-
+
+      - name: Install Node.js dependencies
+        if: steps.cache-modules.outputs.cache-hit != 'true'
+        run: yarn --frozen-lockfile
+
+      - name: Run eslint & stylelint
+        uses: wearerequired/lint-action@v1
+        with:
+          github_token: ${{ secrets.github_token }}
+          eslint: true
+          eslint_extensions: js

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

package/.prettierrc.js

@@ -0,0 +1,5 @@
+module.exports = {
+  printWidth: 100,
+  singleQuote: true,
+  trailingComma: 'all',
+};

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Wistia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# @wistia/eslint-config
+
+Wistia's ESLint configurations

package/base.js

@@ -0,0 +1,10 @@
+const commonRules = require('./eslintRules/common');
+
+module.exports = {
+  parser: '@babel/eslint-parser',
+  extends: ['airbnb-base', 'prettier'],
+  plugins: ['prettier'],
+  rules: {
+    ...commonRules,
+  },
+};

package/eslintRules/a11y.js

@@ -0,0 +1,15 @@
+// only add a11y rules
+
+module.exports = {
+  // airbnb config requires both id & nested, but this just enforces that there's an id
+  'jsx-a11y/label-has-for': [
+    'error',
+    {
+      components: ['label'],
+      required: {
+        every: ['id'],
+      },
+      allowChildren: false,
+    },
+  ],
+};

package/eslintRules/common.js

@@ -0,0 +1,22 @@
+// these rules are included in all config types
+module.exports = {
+  // prettier configuration
+  'prettier/prettier': 'error',
+  // this rule is not particularly useful
+  'class-methods-use-this': 'off',
+  // anonymous exports make grepping code from Dev Tools component tree more difficult
+  'import/no-anonymous-default-export': [
+    'error',
+    {
+      allowArray: false,
+      allowArrowFunction: false,
+      allowAnonymousClass: false,
+      allowAnonymousFunction: false,
+      allowCallExpression: true, // for backward compatibility
+      allowLiteral: false,
+      allowObject: false,
+    },
+  ],
+  // this will allow unary operators in for loops only
+  'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+};

package/eslintRules/jest.js

@@ -0,0 +1,60 @@
+// only add jest rules
+
+module.exports = {
+  // see: https://github.com/jest-community/eslint-plugin-jest#rules
+  // authoring rules for tests
+  'jest/consistent-test-it': 'error',
+  'jest/expect-expect': 'off',
+  // descriptions are often named after React components which are capitalized
+  'jest/lowercase-name': 'off',
+  'jest/no-alias-methods': 'error',
+  'jest/no-commented-out-tests': 'error',
+  'jest/no-conditional-expect': 'error',
+  'jest/no-deprecated-functions': 'error',
+  // it is often useful to be allowed to add a .skip
+  'jest/no-disabled-tests': 'off',
+  'jest/no-done-callback': 'error',
+  'jest/no-duplicate-hooks': 'error',
+  'jest/no-export': 'error',
+  'jest/no-focused-tests': 'error',
+  // hooks are testable with react-testing-library
+  'jest/no-hooks': 'off',
+  'jest/no-identical-title': 'error',
+  'jest/no-if': 'error',
+  'jest/no-interpolation-in-snapshots': 'error',
+  'jest/no-jasmine-globals': 'error',
+  'jest/no-jest-import': 'error',
+  // reasonable but arbitrary size limit
+  'jest/no-large-snapshots': ['error', { maxSize: 500 }],
+  'jest/no-mocks-import': 'error',
+  'jest/no-restricted-matchers': 'error',
+  'jest/no-standalone-expect': 'error',
+  'jest/no-test-prefixes': 'error',
+  'jest/no-test-return-statement': 'error',
+  'jest/prefer-called-with': 'error',
+  'jest/prefer-expect-assertions': 'error',
+  'jest/prefer-hooks-on-top': 'error',
+  'jest/prefer-spy-on': 'error',
+  'jest/prefer-strict-equal': 'error',
+  'jest/prefer-to-be-null': 'error',
+  'jest/prefer-to-be-undefined': 'error',
+  'jest/prefer-to-contain': 'error',
+  'jest/prefer-to-have-length': 'error',
+  'jest/prefer-todo': 'error',
+  'jest/require-to-throw-message': 'error',
+  'jest/require-top-level-describe': 'error',
+  'jest/valid-describe': 'error',
+  'jest/valid-expect': 'error',
+  'jest/valid-expect-in-promise': 'error',
+  'jest/valid-title': 'error',
+
+  // formatting rules for tests
+  'jest-formatting/padding-around-after-all-blocks': 'error',
+  'jest-formatting/padding-around-after-each-blocks': 'error',
+  'jest-formatting/padding-around-before-all-blocks': 'error',
+  'jest-formatting/padding-around-before-each-blocks': 'error',
+  'jest-formatting/padding-around-expect-groups': 'error',
+  'jest-formatting/padding-around-describe-blocks': 'error',
+  'jest-formatting/padding-around-test-blocks': 'error',
+  'jest-formatting/padding-around-all': 'error',
+};

package/eslintRules/react.js

@@ -0,0 +1,33 @@
+// only add react rules
+
+module.exports = {
+  // checks rules of hooks: https://reactjs.org/docs/hooks-rules.html
+  'react-hooks/rules-of-hooks': 'error',
+  // checks effect dependencies
+  'react-hooks/exhaustive-deps': 'error',
+  // it's acceptable to mix these even at the expense of consistency
+  'react/destructuring-assignment': 'off',
+  // it's useful to be able to reuse prop types off of components
+  // since we don't remove prop types in production it's safe to disable this rule
+  'react/forbid-foreign-prop-types': 'off',
+  // force consistency of jsx attribute declaration
+  'react/jsx-boolean-value': ['error', 'always'],
+  // encourages consistent event handler naming
+  'react/jsx-handler-names': 'error',
+  // checks if an element likely requires a key prop
+  'react/jsx-key': 'error',
+  // this rule is overreaching in it's prescriptiveness
+  'react/jsx-one-expression-per-line': 'off',
+  // it's good to avoid but there are occasions where you need it and will just end up disabling this rule inline anyways
+  'react/no-danger': 'off',
+  // alpha-sort prop types for lack of a better idea
+  'react/sort-prop-types': [
+    'error',
+    {
+      sortShapeProp: true,
+      ignoreCase: true,
+    },
+  ],
+  // alpha-sort default props for consistency
+  'react/jsx-sort-default-props': ['error'],
+};

package/eslintRules/styledComponents.js

@@ -0,0 +1,8 @@
+// only add rules pertaining to styled-components
+// see: https://github.com/brendanmorrell/eslint-plugin-styled-components-a11y
+// for more rules that are added via extension
+
+module.exports = {
+  // sort styled-component properties alphabetically
+  'better-styled-components/sort-declarations-alphabetically': 'error',
+};

package/jest.js

@@ -0,0 +1,8 @@
+const testRules = require('./eslintRules/jest');
+
+module.exports = {
+  plugins: ['jest', 'jest-formatting'],
+  rules: {
+    ...testRules,
+  },
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@wistia/eslint-config",
+  "version": "0.0.10",
+  "description": "Wistia's ESLint configurations",
+  "main": "react.js",
+  "scripts": {
+    "lint": "eslint --fix --report-unused-disable-directives .",
+    "prepare": "husky install",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "@babel/core": "^7.14.3",
+    "@babel/eslint-parser": "^7.14.4",
+    "eslint": "^7.28.0",
+    "eslint-config-airbnb": "^18.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-better-styled-components": "^1.1.2",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-jest": "^24.3.6",
+    "eslint-plugin-jest-formatting": "^3.0.0",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-react": "^7.24.0",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "eslint-plugin-styled-components-a11y": "^0.0.34",
+    "prettier": "^2.3.1",
+    "stylelint": "^13.13.1",
+    "stylelint-config-prettier": "^8.0.2",
+    "stylelint-config-standard": "^22.0.0",
+    "stylelint-declaration-block-no-ignored-properties": "^2.3.0",
+    "stylelint-prettier": "^1.2.0",
+    "stylelint-processor-styled-components": "^1.10.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^13.1.0",
+    "@commitlint/config-conventional": "^13.1.0",
+    "husky": "^7.0.1"
+  },
+  "engines": {
+    "node": "^10.12.0 || >=12.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wistia/eslint-config.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wistia/eslint-config/issues"
+  },
+  "homepage": "https://github.com/wistia/eslint-config#readme",
+  "author": "Wistia Engineering",
+  "license": "UNLICENSED"
+}

package/react.js

@@ -0,0 +1,14 @@
+const commonRules = require('./eslintRules/common');
+const a11yRules = require('./eslintRules/a11y');
+const reactRules = require('./eslintRules/react');
+
+module.exports = {
+  parser: '@babel/eslint-parser',
+  extends: ['airbnb', 'airbnb/hooks', 'prettier'],
+  plugins: ['prettier'],
+  rules: {
+    ...commonRules,
+    ...a11yRules,
+    ...reactRules,
+  },
+};

package/styledComponents.js

@@ -0,0 +1,9 @@
+const styledComponentsRules = require('./eslintRules/styledComponents');
+
+module.exports = {
+  plugins: ['better-styled-components', 'styled-components-a11y'],
+  extends: ['plugin:styled-components-a11y/strict'],
+  rules: {
+    ...styledComponentsRules,
+  },
+};

package/stylelint/base.js

@@ -0,0 +1,9 @@
+const commonRules = require('../stylelintRules/common');
+
+module.exports = {
+  plugins: ['stylelint-prettier'],
+  extends: ['stylelint-config-standard', 'stylelint-config-prettier'],
+  rules: {
+    ...commonRules,
+  },
+};

package/stylelint/styledComponents.js

@@ -0,0 +1,12 @@
+const commonRules = require('../stylelintRules/common');
+const styledComponentRules = require('../stylelintRules/styledComponents');
+
+module.exports = {
+  plugins: ['stylelint-prettier', 'stylelint-declaration-block-no-ignored-properties'],
+  processors: ['stylelint-processor-styled-components'],
+  extends: ['stylelint-config-standard', 'stylelint-config-prettier'],
+  rules: {
+    ...commonRules,
+    ...styledComponentRules,
+  },
+};

package/stylelintRules/common.js

@@ -0,0 +1,6 @@
+// these rules are included in all config types
+
+module.exports = {
+  // prettier configuration
+  'prettier/prettier': true,
+};

package/stylelintRules/styledComponents.js

@@ -0,0 +1,14 @@
+// only add rules pertaining to styled-components
+
+module.exports = {
+  // without this pretty much every file will throw an error¯\_(ツ)_/¯
+  'no-empty-source': null,
+  // disallow property values that are ignored due to another property value in the same rule
+  'plugin/declaration-block-no-ignored-properties': true,
+  // these selectors are used as placeholders by styled-components preprocessor
+  'selector-type-no-unknown': [true, { ignoreTypes: ['$dummyValue', '/^-styled-/'] }],
+  'value-keyword-case': [
+    'lower',
+    { ignoreKeywords: [/dummyValue/], ignoreProperties: [/dummyValue/] },
+  ],
+};