@wistia/eslint-config 0.3.2 → 0.3.3

package/eslintRules/jest.js

@@ -15,7 +15,7 @@ module.exports = {
   'jest/no-duplicate-hooks': 'error',
   'jest/no-export': 'error',
   'jest/no-focused-tests': 'error',
-  // hooks may arguably promote shared state but they're handy
+  // hooks are useful even though they *potentially* promote shared state between tests
   'jest/no-hooks': 'off',
   'jest/no-identical-title': 'error',
   'jest/no-if': 'error',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wistia/eslint-config",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Wistia's ESLint configurations",
   "main": "react.js",
   "scripts": {
@@ -34,7 +34,8 @@
     "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"
+    "stylelint-processor-styled-components": "^1.10.0",
+    "stylelint-scss": "^4.2.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^16.2.3",
@@ -42,7 +43,7 @@
     "husky": "^7.0.4"
   },
   "engines": {
-    "node": "^10.12.0 || >=12.0.0"
+    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
   "repository": {
     "type": "git",

package/stylelint/scss.js

@@ -0,0 +1,11 @@
+const commonRules = require('../stylelintRules/common');
+const scssRules = require('../stylelintRules/scss');
+
+module.exports = {
+  plugins: ['stylelint-prettier', 'stylelint-scss'],
+  extends: ['stylelint-config-standard-scss'], // see: https://github.com/stylelint-scss/stylelint-config-standard-scss/blob/main/index.js
+  rules: {
+    ...commonRules,
+    ...scssRules,
+  },
+};

package/stylelintRules/scss.js

@@ -0,0 +1,33 @@
+// only add rules pertaining to scss
+
+module.exports = {
+  // disallow vendor prefixes
+  'at-rule-no-vendor-prefix': true,
+  'property-no-vendor-prefix': true,
+  'selector-no-vendor-prefix': true,
+  'value-no-vendor-prefix': true,
+
+  // prefer single to double quotes for better js compat
+  'string-quotes': 'single',
+
+  // *** DISABLED RULES ***
+  // too many violations to fix so we just allow any pattern
+  'selector-class-pattern': '[a-zA-Z0-9]',
+  'selector-id-pattern': '[a-zA-Z0-9]',
+
+  // unfortunately these conflict with sass functions; hopefully someday we will be able to enable
+  'color-function-notation': null,
+  'alpha-value-notation': null,
+
+  // thousands of these errors, not realistically fixable
+  'no-descending-specificity': null,
+
+  // TODO: should try to fix these, there's not too many
+  'no-duplicate-selectors': null,
+
+  'scss/at-extend-no-missing-placeholder': null,
+  'scss/at-mixin-pattern': null,
+  'scss/dollar-variable-pattern': null,
+  'scss/no-global-function-names': null,
+  'scss/percent-placeholder-pattern': null,
+};

package/.commitlintrc.js

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

package/.eslintrc.js

@@ -1,16 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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

@@ -1,41 +0,0 @@
-name: Lint
-
-on: pull_request
-
-env:
-  NODE_VERSION: 16.10.0
-
-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.4.1
-        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.1.6
-        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.10.0
-        with:
-          github_token: ${{ secrets.github_token }}
-          eslint: true
-          eslint_extensions: js

package/.husky/commit-msg

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

package/.prettierrc.js

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

package/.tool-versions

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

package/catalog-info.yaml

@@ -1,17 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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/*