Switch to flat config format

.editorconfig

@@ -1,11 +1,16 @@
 root = true
 
 [*]
-indent_style = space
+indent_style = tab
 indent_size = 2
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false
+
+# YAML files cannot have tabs
+# @see https://yaml.org/faq.html
+[*.yml]
+indent_style = space

.github/workflows/ci.yml

@@ -7,26 +7,17 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  lint:
+  validate:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - name: Use Node.js 18
-        uses: actions/setup-node@v3
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
-      - name: Cache node modules
-        uses: actions/cache@v3
-        with:
-          path: node_modules
-          key: ${{ runner.OS }}-build-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-build-${{ env.cache-name }}-
-            ${{ runner.OS }}-build-
-            ${{ runner.OS }}-
+          node-version: 'lts/*'
+          cache: 'npm'
       - name: Install Dependencies
-        run: npm ci && npm link && npm link @cloudfour/eslint-plugin
-      - name: Run Build
-        run: npm run build
+        run: npm ci
       - name: Run Lint
-        run: npm run check-lint
+        run: npm run lint:check

.gitignore

@@ -1,5 +1,2 @@
 node_modules
-/dist/*.js
-.vscode/
-/fixtures/repos
-/tmp-eslint-config
+.vscode

.nvmrc

@@ -0,0 +1 @@
+lts/*

.renovaterc.json

@@ -1,16 +1,16 @@
 {
-  "extends": ["config:base", ":automergeMinor"],
-  "reviewers": ["team:dev"],
-  "dependencyDashboard": true,
-  "stabilityDays": 4,
-  "packageRules": [
-    {
-      "matchDepTypes": ["dependencies"],
-      "rangeStrategy": "bump"
-    },
-    {
-      "matchPackagePatterns": ["eslint"],
-      "automerge": false
-    }
-  ]
+	"extends": ["config:base", ":automergeMinor"],
+	"reviewers": ["team:dev"],
+	"dependencyDashboard": true,
+	"stabilityDays": 4,
+	"packageRules": [
+		{
+			"matchDepTypes": ["dependencies"],
+			"rangeStrategy": "bump"
+		},
+		{
+			"matchPackagePatterns": ["eslint"],
+			"automerge": false
+		}
+	]
 }

CHANGELOG.md

@@ -1,5 +1,12 @@
 # @cloudfour/eslint-plugin
 
+## Unreleased
+
+### Breaking Changes
+
+- Changed from a "super plugin" to a flat config file.
+- Changed package name from `@cloudfour/eslint-plugin` to `@cloudfour/eslint-config`.
+
 ## 23.0.0
 
 ### Major Changes
@@ -471,22 +478,22 @@
 
   ```js
   function a() {
-    if (_) {
-      a();
-      b();
-      c();
-    }
+  	if (_) {
+  		a();
+  		b();
+  		c();
+  	}
   }
   ```
 
   into:
 
   ```js
   function a() {
-    if (!_) return;
-    a();
-    b();
-    c();
+  	if (!_) return;
+  	a();
+  	b();
+  	c();
   }
   ```
 

CONTRIBUTING.md

@@ -1,33 +1,5 @@
 # Contributing Guide
 
-## Running @cloudfour/eslint-plugin on itself
+## Release Process
 
-In order to run `npm run lint` on this project, it needs to have a symlink to itself in `node_modules`, so that ESLint can find it. To set up this symlink, run `npm link` and then `npm link @cloudfour/eslint-plugin`. Then you should be able to run `npm run lint`.
-
-## Pull Requests
-
-If you are submitting a pull request that includes changes that will affect places where this ESLint config is installed, add a Changeset file to describe the outward-facing changes:
-
-- On your feature branch, run `npx changeset`.
-
-  - First it will ask you what [kind of change it is](https://semver.org/#summary):
-
-    - **Major changes** include
-      - Enabling rules
-      - Removing rules
-      - Bugfixes to rules that are likely to error on more code than before
-      - Removing support for Node or ESLint or TypeScript versions
-    - **Minor changes** include
-      - Creating rules that are not enabled by default
-      - Adding support for Node or ESLint or TypeScript versions
-      - Bugfixes to rules that are not likely to error on more code than before
-    - **Patch releases** include
-      - Bugfixes/refactorings that will not change the functionality
-
-    Dependency updates can fall into any of the three categories, consider how the dependency change will affect consumers of this ESLint config.
-
-  - Next it will ask you to describe your changes. This message will appear in the Changelog. You can press enter before you type anything to edit the message in your editor.
-
-## Releasing
-
-- [Changesets Action](https://github.com/changesets/action) will create and maintain release PR's whenever changes are pushed to main. Merge the "Publish Next Version" PR to release all unreleased changes on `main`. All of the changes will get combined into a single release. Changesets will handle updating the changelog, pushing git tags, and publishing to npm.
+[How to publish an updated version](https://cloudfour.com/thinks/how-to-publish-an-updated-version-of-an-npm-package/)

README.md

@@ -1,75 +1,43 @@
-# @cloudfour/eslint-plugin
+# @cloudfour/eslint-config
 
-[![NPM version](https://img.shields.io/npm/v/@cloudfour/eslint-plugin.svg)](https://www.npmjs.com/package/@cloudfour/eslint-plugin) [![Build Status](https://github.com/cloudfour/eslint-config/workflows/CI/badge.svg)](https://github.com/cloudfour/eslint-config/actions?query=workflow%3ACI) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
+[![NPM version](https://img.shields.io/npm/v/@cloudfour/eslint-config.svg)](https://www.npmjs.com/package/@cloudfour/eslint-config) [![Build Status](https://github.com/cloudfour/eslint-config/workflows/CI/badge.svg)](https://github.com/cloudfour/eslint-config/actions?query=workflow%3ACI) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
 
-Cloud Four's ESLint configuration. This exports itself as a "super-plugin" because of a [limitation of ESLint](https://github.com/eslint/eslint/issues/3458).
+Cloud Four's ESLint configuration.
 
-The way this works is that it requires all of the plugin dependencies, and exports them from this plugin under a prefix.
-
-The plugins that this exposes are:
+This config extends the following plugins:
 
 - [`n`](https://github.com/weiran-zsd/eslint-plugin-node) (maintained fork of original [`eslint-plugin-node`](https://github.com/mysticatea/eslint-plugin-node))
 - [`import`](https://github.com/benmosher/eslint-plugin-import)
-- [`standard`](https://github.com/standard/eslint-plugin-standard)
 - [`promise`](https://github.com/xjamundx/eslint-plugin-promise)
-- [`unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn)
 - [`jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc)
+- [`unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn)
+- [`standard`](https://github.com/standard/eslint-config-standard)
 - [`@typescript-eslint`](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin)
 
-To override settings for any of these plugins, you must prefix the configuration
-with `cloudfour/`, because the plugins are exposed through this "super-plugin".
-
-```json
-{
-  "extends": ["plugin:@cloudfour/recommended"],
-  "rules": {
-    "@cloudfour/promise/no-native": "off"
-  }
-}
-```
-
-In addition to the `recommended` configuration, `@cloudfour/eslint-plugin` also re-exports typescript-eslint's [`disable-type-checked` configuration](https://typescript-eslint.io/linting/configs/#disable-type-checked). This configuration disables any rules that depend on typescript-eslint's typescript integration.
-
-## Installation
+It also adds the following custom rules:
 
-```sh
-npm install --save-dev @cloudfour/eslint-plugin eslint prettier
-```
+- [`prefer-early-return`](./rules/prefer-early-return/)
 
 ## Usage
 
-Add this to your `package.json`:
-
-```json
-  "scripts": {
-    "check-lint": "eslint . && prettier --check .",
-    "lint": "eslint --fix . && prettier --write ."
-  },
-  "eslintConfig": {
-    "extends": "plugin:@cloudfour/recommended"
-  },
-  "prettier": {
-    "singleQuote": true
-  }
-```
-
-### Check for Lint Errors
+This package exports [a flat ESLint configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new).
 
-```sh
-npm run check-lint
+```bash
+npm install --save-dev eslint @cloudfour/eslint-config
 ```
 
-### Fix Lint Errors
+Example `eslint.config.js`:
 
-This command will attempt to automatically fix lint errors. Note that not all lint errors can be fixed this way, so be prepeared to fix any remaining errors by hand.
+```js
+import cloudFourConfig from '@cloudfour/eslint-config';
 
-```sh
-npm run lint
+export default [
+	...cloudFourConfig,
+	{
+		rules: {
+			// your overrides here
+			...
+		}
+	},
+];
 ```
-
-### Troubleshooting Note
-
-This config relies on using a version of eslint installed locally to your project. If you also have eslint installed globally, it's possible to run into conflicts. To avoid any problems, either:
-
-- Just use the `npm run check-lint` and `npm run lint` scripts, which will run the local version of eslint.
-- Or, if you prefer to run eslint by hand, use [npx](https://www.npmjs.com/package/npx), which will run the local version of eslint. eg, `npx eslint '**/*.js'`