@wistia/eslint-config 0.2.6 → 0.3.2

package/.tool-versions

@@ -0,0 +1,3 @@
+ruby 2.7.5
+nodejs 16.10.0
+yarn 1.22.10

package/catalog-info.yaml

@@ -0,0 +1,17 @@
+# this is a catalog entity descriptor file for our Backstage instance (https://backstage.wistia.cloud)
+
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ESLint-Config
+  description: Wistia's ESLint configurations
+  annotations:
+    github.com/project-slug: wistia/eslint-config
+    backstage.io/techdocs-ref: dir:.
+  tags:
+    - lang#javascript
+    - pkg#npm
+spec:
+  type: configuration
+  owner: app-platform
+  lifecycle: production

package/mkdocs.yaml

@@ -0,0 +1,10 @@
+# this file exists to generate techdocs for Backstage (https://backstage.wistia.cloud)
+
+site_name: ESLint-Config
+docs_dir: .
+plugins:
+  - techdocs-core
+  - same-dir
+  - exclude:
+      glob:
+        - node_modules/*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.2.6",
+  "version": "0.3.2",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
   "scripts": {
@@ -9,34 +9,37 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "@babel/core": "^7.16.0",
-    "@babel/eslint-parser": "^7.16.3",
-    "eslint": "^8.2.0",
-    "eslint-config-airbnb": "^19.0.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@babel/core": "^7.17.7",
+    "@babel/eslint-parser": "^7.17.0",
+    "eslint": "^8.11.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-better-styled-components": "^1.1.2",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-jest": "^25.2.4",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-plugin-jest": "^26.1.1",
     "eslint-plugin-jest-dom": "^4.0.1",
-    "eslint-plugin-jest-formatting": "^3.0.0",
+    "eslint-plugin-jest-formatting": "^3.1.0",
     "eslint-plugin-jsx-a11y": "^6.5.1",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-react": "^7.27.0",
+    "eslint-plugin-react": "^7.29.4",
     "eslint-plugin-react-hooks": "^4.3.0",
     "eslint-plugin-styled-components-a11y": "^0.0.34",
-    "eslint-plugin-testing-library": "^5.0.0",
-    "prettier": "^2.4.1",
-    "stylelint": "^13.0.0",
-    "stylelint-config-prettier": "^9.0.0",
-    "stylelint-config-standard": "^22.0.0",
-    "stylelint-declaration-block-no-ignored-properties": "^2.0.0",
-    "stylelint-prettier": "^1.0.0",
+    "eslint-plugin-testing-library": "^5.1.0",
+    "postcss": "^8.4.12",
+    "postcss-scss": "^4.0.3",
+    "prettier": "^2.6.0",
+    "stylelint": "^14.6.0",
+    "stylelint-config-prettier": "^9.0.3",
+    "stylelint-config-standard": "^25.0.0",
+    "stylelint-config-standard-scss": "^3.0.0",
+    "stylelint-declaration-block-no-ignored-properties": "^2.5.0",
+    "stylelint-prettier": "^2.0.0",
     "stylelint-processor-styled-components": "^1.10.0"
   },
   "devDependencies": {
-    "@commitlint/cli": "^16.0.1",
-    "@commitlint/config-conventional": "^16.0.0",
-    "husky": "^7.0.1"
+    "@commitlint/cli": "^16.2.3",
+    "@commitlint/config-conventional": "^16.2.1",
+    "husky": "^7.0.4"
   },
   "engines": {
     "node": "^10.12.0 || >=12.0.0"

package/stylelint/styled-components.js

@@ -3,8 +3,9 @@ const styledComponentRules = require('../stylelintRules/styled-components');
 
 module.exports = {
   plugins: ['stylelint-prettier', 'stylelint-declaration-block-no-ignored-properties'],
+  extends: ['stylelint-config-standard-scss', 'stylelint-config-prettier'],
+  customSyntax: 'postcss-scss',
   processors: ['stylelint-processor-styled-components'],
-  extends: ['stylelint-config-standard', 'stylelint-config-prettier'],
   rules: {
     ...commonRules,
     ...styledComponentRules,

package/stylelintRules/styled-components.js

@@ -1,14 +1,25 @@
 // only add rules pertaining to styled-components
 
 module.exports = {
+  // in css-in-js when variables are being passed around, this rule
+  // often leads to less readable code, even though it is more compact
+  'declaration-block-no-redundant-longhand-properties': null,
+  // this appears to conflict with styled-components keyframes method
+  'keyframes-name-pattern': null,
   // 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,
+  // prevent snake case from being used for class/id selectors but be otherwise flexible
+  'selector-class-pattern': '^[a-zA-Z0-9-]+(-[a-zA-Z0-9]+)*$',
+  'selector-id-pattern': '^[a-zA-Z0-9-]+(-[a-zA-Z0-9]+)*$',
   // 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/] },
   ],
+  // styled-components adds vendor prefixes if necessary so we should avoid adding them in code
+  'value-no-vendor-prefix': true,
+  'property-no-vendor-prefix': true,
 };