Release v3.0.0

.clint-config.mjs

@@ -0,0 +1,97 @@
+// @ts-check
+// eslint-disable-next-line import/no-extraneous-dependencies -- dev only
+import chalk from 'chalk'
+
+import czConfig from './.cz-config.js'
+
+/** @type {import('./lib/commit-lint.mjs').CLintConfig} */
+const clintrc = {
+  parserOptions: {
+    mergePattern: /^merge/iu,
+    revertPattern: /^revert/iu,
+  },
+  commit: ({ commit, logger }) => {
+    const scopesForType = (commit.type && czConfig.scopeOverrides[commit.type]) || czConfig.scopes
+
+    return [
+      {
+        name: 'Type',
+        checks: [
+          {
+            message: logger.errors.isRequired(),
+            test: () => !commit.type,
+          },
+          {
+            message: logger.errors.mustBeEnum(
+              'must be a valid type',
+              czConfig.types.map((type) => type.value),
+              commit.type,
+            ),
+            test: () => !commit.type || !czConfig.types.find((type) => type.value === commit.type),
+          },
+        ],
+      },
+      {
+        name: 'Scope',
+        checks: [
+          {
+            message: logger.errors.isRequired(),
+            test: () => !commit.scope || commit.scope.length === 0,
+          },
+          {
+            message: logger.errors.mustBeEnum(
+              ['must be a valid scope for', `"${chalk.red(commit.type)}"`, 'type'],
+              scopesForType.map((scope) => scope.name),
+              commit.scope,
+            ),
+            test: () => !commit.scope || !scopesForType.find((scope) => scope.name === commit.scope),
+          },
+        ],
+      },
+      {
+        name: 'Subject',
+        checks: [
+          {
+            message: logger.errors.isRequired(),
+            test: () => !commit.subject,
+          },
+          {
+            message: logger.errors.tooLong(czConfig.subjectLimit, commit.subject?.trim().length || 0),
+            test: () => commit.subject && commit.subject.trim().length > czConfig.subjectLimit,
+          },
+          {
+            message: logger.error('must not end with punctuation'),
+            test: () => commit.subject && /[.?!]$/u.test(commit.subject),
+          },
+        ],
+      },
+      {
+        name: 'Breaking Changes',
+        checks: [
+          {
+            message: logger.error(
+              'must be a commit of type',
+              Array.isArray(czConfig.allowBreakingChanges)
+                ? czConfig.allowBreakingChanges.map((type) => `"${type}"`).join(', ')
+                : '',
+            ),
+            test: () => {
+              if (
+                Boolean(commit.notes?.length)
+                && Array.isArray(czConfig.allowBreakingChanges)
+              ) {
+                return !czConfig.allowBreakingChanges.find(
+                  (type) => commit.type?.toLowerCase() === type.toLowerCase(),
+                )
+              }
+
+              return false
+            },
+          },
+        ],
+      },
+    ]
+  },
+}
+
+export default clintrc

.cz-config.js

@@ -0,0 +1,103 @@
+// @ts-check
+const path = require('path')
+
+const scopeGen = require('./lib/generate-scopes')
+
+const configPath = (...paths) => path.resolve('packages', 'eslint-config', ...paths)
+
+/**
+ * A list of scopes that are allowed for the 'config' type.
+ * Scopes are generated from the file structure of the `eslint-config` package.
+ */
+const configScopes = [
+  // all configs in the root directory are of the 'preset' scope, and should be listed first.
+  ...scopeGen.getScopesFromDirectory({ path: configPath(), prefix: 'preset', indexScope: 'default' }),
+  // individual ruleset configs are sorted alphabetically below the presets.
+  ...scopeGen.getScopesFromDirectories([
+    // all core rule configs are of the 'core' scope, unless they are prefixed with 'plugin'.
+    { path: configPath('core'), prefix: 'core', allowedPrefixes: ['core', 'plugin'] },
+    // all plugin rule configs are of the 'plugin' scope.
+    { path: configPath('plugins'), prefix: 'plugin' },
+  ]).sort((aScope, bScope) => aScope.name.localeCompare(bScope.name)),
+]
+
+/**
+ * A list of monorepo package scopes.
+ */
+const packageScopes = scopeGen.getScopesFromDirectory({
+  path: path.resolve('./packages'),
+  includeDirectories: true,
+})
+
+module.exports = {
+  types: [
+    {
+      value: 'config',
+      name: 'config:   A change to the configuration of a SINGLE ESLint Rule. Rule changes should be limited to one rule per commit.',
+    },
+    {
+      value: 'feat',
+      name: 'feat:     A new plugin feature, eslint-config utility, or architecture change.',
+    },
+    {
+      value: 'fix',
+      name: 'fix:      A bug fix to a package.',
+    },
+    {
+      value: 'readme',
+      name: 'readme:   A change to a README file.',
+    },
+    {
+      value: 'docs',
+      name: 'docs:     A change to documentation OTHER than README.',
+    },
+    {
+      value: 'style',
+      name: `style:    Changes that do not affect the meaning of the code.
+            (white-space, formatting, missing semi-colons, etc)`,
+    },
+    {
+      value: 'refactor',
+      name: 'refactor: A code change that neither fixes a bug nor adds a feature.',
+    },
+    {
+      value: 'test',
+      name: 'test:     Any change to the test suite.',
+    },
+    {
+      value: 'chore',
+      name: `chore:    Changes to the build process or auxiliary tools and libraries such as
+            documentation generation`,
+    },
+    {
+      value: 'revert',
+      name: 'revert:   Revert to a commit',
+    },
+  ],
+
+  scopes: [
+    { name: 'repo' },
+    ...packageScopes,
+  ],
+
+  scopeOverrides: {
+    config: configScopes,
+  },
+
+  messages: {
+    type: "Select the type of change that you're committing:",
+    scope: 'Denote the SCOPE of this change (optional):\n',
+    subject: 'Write a SHORT, IMPERATIVE tense description of the change:\n',
+    body: 'Provide a LONGER description of the change (optional). Use "|" to break new line:\n',
+    breaking: 'List any BREAKING CHANGES (optional):\n',
+    footer: 'List any ISSUES CLOSED by this change (optional). E.g.: #31, #34:\n',
+    confirmCommit: 'Are you sure you want to proceed with the commit above?',
+  },
+
+  allowBreakingChanges: ['feat', 'fix'],
+  allowCustomScopes: false,
+  allowTicketNumber: false,
+  askForBreakingChangeFirst: false,
+  subjectLimit: 100,
+  usePreparedCommit: true,
+}

.eslintignore

@@ -0,0 +1,4 @@
+!.*
+.yarn/
+dist/
+node_modules/

.eslintrc.js

@@ -0,0 +1,31 @@
+module.exports = {
+  root: true,
+  env: {
+    node: true,
+  },
+  overrides: [
+    {
+      files: '**/*.{js,mjs,cjs,jsx}',
+      extends: require.resolve('./dist/eslint-config/index.js'),
+      rules: {
+        'jsdoc/require-jsdoc': ['off'], // since we don't use jsdoc here
+        'no-magic-numbers': ['off'], // since defining a bunch of consts for lint rules is cumbersome
+        'quote-props': ['error', 'consistent-as-needed'], // since the majority of rules are in quotes with little outliers;
+        'max-lines': ['off'], // We're not interested in breaking up large rule files.
+      },
+    },
+    {
+      files: '**/*.{ts,tsx}',
+      extends: require.resolve('./dist/eslint-config/typescript.js'),
+      rules: {
+        'jsdoc/require-jsdoc': ['off'], // since we don't use jsdoc here
+        '@typescript-eslint/no-magic-numbers': ['off'], // since defining a bunch of consts for lint rules is cumbersome
+        'quote-props': ['error', 'consistent-as-needed'], // since the majority of rules are in quotes with little outliers;
+        'max-lines': ['off'], // We're not interested in breaking up large rule files.
+      },
+      parserOptions: {
+        project: './tsconfig.eslint.json',
+      },
+    },
+  ],
+}

.github/workflows/pull_request.yml

@@ -0,0 +1,32 @@
+name: Test Pull Request
+
+on:
+  pull_request:
+    branches:
+      - main
+      - canary
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - name: Install Dependencies + Build Distributons
+        run: yarn install --immutable
+
+      - name: Test Packages
+        run: yarn test
+
+      - name: Lint
+        uses: wearerequired/lint-action@v2
+        with:
+          eslint: true
+          eslint_args: "--max-warnings 0"

.github/workflows/release.yml

@@ -21,5 +21,16 @@ jobs:
           cache: 'yarn'
 
       - name: Install Dependencies + Build Distributons
-        run: yarn install
+        run: yarn install --immutable
 
+      - name: Test Packages
+        run: yarn test
+
+      - name: Lint
+        run: yarn lint
+
+      - name: Release Packages
+        run: yarn release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,9 +2,18 @@
 .idea/
 .next
 .env
-.dist
+dist/
 bower_components
 node_modules
 static/compiled
 static/fonts/font-awesome
 logs/
+
+# Yarn 2
+.yarn/*
+!.yarn/patches
+!.yarn/releases
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions
+.pnp.*

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+node lib/commit-lint.mjs "$1"

.nvmrc

@@ -0,0 +1 @@
+18

.vscode/settings.json

@@ -1,15 +1,5 @@
 {
-  "eslint.workingDirectories": [
-    { "directory": "./eslint-config", "changeProcessCWD": true },
-    { "directory": "./eslint-config-react", "changeProcessCWD": true }
-  ],
   "editor.rulers": [180],
   "git.ignoreLimitWarning": true,
-  "cSpell.words": [
-    "cond",
-    "ponse",
-    "riptor",
-    "uest",
-    "umulator"
-  ]
+  "typescript.tsdk": "node_modules/typescript/lib"
 }

.yarn/patches/@semantic-release-npm-npm-9.0.2-01eb854535.patch

@@ -0,0 +1,15 @@
+diff --git a/lib/publish.js b/lib/publish.js
+index ff3af00789942572806e52627b5e22c8ac25d1b1..578d3fca85cdca973fd42ce05fc26b75a121e0b1 100644
+--- a/lib/publish.js
++++ b/lib/publish.js
+@@ -22,8 +22,8 @@ module.exports = async (npmrc, {npmPublish, pkgRoot}, pkg, context) => {
+     logger.log(`Publishing version ${version} to npm registry on dist-tag ${distTag}`);
+     const result = execa(
+       'npm',
+-      ['publish', basePath, '--userconfig', npmrc, '--tag', distTag, '--registry', registry],
+-      {cwd, env, preferLocal: true}
++      ['publish', '--userconfig', npmrc, '--tag', distTag, '--registry', registry],
++      {cwd: basePath, env, preferLocal: true}
+     );
+     result.stdout.pipe(stdout, {end: false});
+     result.stderr.pipe(stderr, {end: false});