@wistia/eslint-config 0.3.7 → 0.5.2

package/README.md

@@ -1,3 +1,17 @@
 # @wistia/eslint-config
 
-Wistia's ESLint configurations
+Wistia's ESLint configuration. This repo is "pseudo-public" - private on our org, and [pushed to NPM](https://www.npmjs.com/package/@wistia/eslint-config) for ease of distribution.
+
+## How to install
+
+TODO! 
+
+## Guidelines for adding new rules
+
+1. preference given for autofixable rules; for non-autofixable rules consider seeking consensus from co-workers (open a PR on this repo and ask for feedback in #engineering-general!)
+2. should not contradict existing rules
+3. person/team adding new rules handles upgrading consumers and fixing violations
+
+## Publishing
+
+TODO!

package/cypress.js

@@ -0,0 +1,11 @@
+const testRules = require('./eslintRules/cypress');
+
+module.exports = {
+  plugins: ['eslint-plugin-cypress'],
+  env: {
+    'cypress/globals': true,
+  },
+  rules: {
+    ...testRules,
+  },
+};

package/eslintRules/cypress.js

@@ -0,0 +1,11 @@
+// only add cypress rules
+
+module.exports = {
+  'cypress/no-assigning-return-values': 'error',
+  'cypress/no-unnecessary-waiting': 'error',
+  'cypress/no-async-tests': 'error',
+  'cypress/no-force': 'error',
+  'cypress/assertion-before-screenshot': 'error',
+  'cypress/require-data-selectors': 'error',
+  'cypress/no-pause': 'error',
+};

package/eslintRules/sonar.js

@@ -0,0 +1,39 @@
+// only add SonarJS rules
+// https://github.com/SonarSource/eslint-plugin-sonarjs#rules
+
+module.exports = {
+  // bug detection
+  'sonarjs/no-all-duplicated-branches': 'error',
+  'sonarjs/no-element-overwrite': 'error',
+  'sonarjs/no-empty-collection': 'error',
+  'sonarjs/no-extra-arguments': 'error',
+  'sonarjs/no-identical-conditions': 'error',
+  'sonarjs/no-identical-expressions': 'error',
+  'sonarjs/no-ignored-return': 'error',
+  'sonarjs/no-one-iteration-loop': 'error',
+  'sonarjs/no-use-of-empty-return-value': 'error',
+  'sonarjs/non-existent-operator': 'error',
+  // code smells
+  'sonarjs/cognitive-complexity': 'error',
+  'sonarjs/elseif-without-else': 'error',
+  'sonarjs/max-switch-cases': 'error',
+  'sonarjs/no-collapsible-if': 'error',
+  'sonarjs/no-collection-size-mischeck': 'error',
+  'sonarjs/no-duplicate-string': 'error',
+  'sonarjs/no-duplicated-branches': 'error',
+  'sonarjs/no-gratuitous-expressions': 'error',
+  'sonarjs/no-identical-functions': 'error',
+  'sonarjs/no-inverted-boolean-check': 'error',
+  'sonarjs/no-nested-switch': 'error',
+  'sonarjs/no-nested-template-literals': 'error',
+  'sonarjs/no-redundant-boolean': 'error',
+  'sonarjs/no-redundant-jump': 'error',
+  'sonarjs/no-same-line-conditional': 'error',
+  'sonarjs/no-small-switch': 'error',
+  'sonarjs/no-unused-collection': 'error',
+  'sonarjs/no-useless-catch': 'error',
+  'sonarjs/prefer-immediate-return': 'error',
+  'sonarjs/prefer-object-literal': 'error',
+  'sonarjs/prefer-single-boolean-return': 'error',
+  'sonarjs/prefer-while': 'error',
+};

package/jest.js

@@ -2,6 +2,9 @@ const testRules = require('./eslintRules/jest');
 
 module.exports = {
   plugins: ['eslint-plugin-jest', 'eslint-plugin-jest-formatting'],
+  env: {
+    jest: true,
+  },
   rules: {
     ...testRules,
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.3.7",
+  "version": "0.5.2",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
   "scripts": {
@@ -15,6 +15,7 @@
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-better-styled-components": "^1.1.2",
+    "eslint-plugin-cypress": "^2.12.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^26.1.5",
     "eslint-plugin-jest-dom": "^4.0.1",
@@ -23,7 +24,8 @@
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-react": "^7.29.4",
     "eslint-plugin-react-hooks": "^4.5.0",
-    "eslint-plugin-styled-components-a11y": "^0.0.34",
+    "eslint-plugin-sonarjs": "^0.13.0",
+    "eslint-plugin-styled-components-a11y": "^0.0.39",
     "eslint-plugin-testing-library": "^5.3.1",
     "postcss": "^8.4.13",
     "postcss-scss": "^4.0.4",
@@ -38,9 +40,9 @@
     "stylelint-scss": "^4.2.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.2.4",
-    "@commitlint/config-conventional": "^16.2.4",
-    "husky": "^7.0.4"
+    "@commitlint/cli": "^17.0.2",
+    "@commitlint/config-conventional": "^17.0.2",
+    "husky": "^8.0.1"
   },
   "engines": {
     "node": "^12.22.0 || ^14.17.0 || >=16.0.0"

package/react.js

@@ -6,6 +6,9 @@ module.exports = {
   parser: '@babel/eslint-parser',
   plugins: ['eslint-plugin-prettier'],
   extends: ['eslint-config-airbnb', 'eslint-config-airbnb/hooks', 'eslint-config-prettier'],
+  env: {
+    browser: true,
+  },
   rules: {
     ...commonRules,
     ...a11yRules,

package/sonar.js

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