@isentinel/eslint-config 1.3.0 → 3.0.0-beta.1

package/README.md

@@ -4,13 +4,13 @@
 
 ### Starter Wizard
 
-We provided a CLI tool to help you set up your project, or migrate from the legacy config to the new flat config with one command.
+We provided a CLI tool to help you set up your project, or migrate from the
+legacy config to the new flat config with one command.
 
 ### Example Usage
 
 For an existing template that already has this config setup, please refer to the
-[roblox-ts
-template](https://github.com/christopher-buss/roblox-ts-project-template)
+[roblox-ts template](https://github.com/christopher-buss/roblox-ts-project-template)
 repository. This includes all necessarily files and configurations to get you up
 and running.
 
@@ -28,40 +28,46 @@ pnpm i -D eslint @isentinel/eslint-config
 
 ### Create config file
 
-With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
+With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in
+`package.json` (recommended):
 
 ```ts
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style();
+export default isentinel();
 ```
 
 #### Optional: TypeScript Config Support
 
-If you want to use `eslint.config.ts` instead of `.js`, install `jiti` v2.0.0 or greater:
+If you want to use `eslint.config.ts` instead of `.js`, install `jiti` v2.0.0 or
+greater:
 
 ```bash
 pnpm i -D jiti@^2.0.0
 ```
 
-See [ESLint's TypeScript configuration documentation](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files) for more details.
+See
+[ESLint's TypeScript configuration documentation](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files)
+for more details.
 
 <details>
 <summary>
 Combined with legacy config:
 </summary>
 
-If you still use some configs from the legacy eslintrc format, you can use the [`@eslint/eslintrc`](https://www.npmjs.com/package/@eslint/eslintrc) package to convert them to the flat config.
+If you still use some configs from the legacy eslintrc format, you can use the
+[`@eslint/eslintrc`](https://www.npmjs.com/package/@eslint/eslintrc) package to
+convert them to the flat config.
 
 ```ts
 // eslint.config.ts
 import { FlatCompat } from "@eslint/eslintrc";
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
 const compat = new FlatCompat();
 
-export default style(
+export default isentinel(
 	{
 		ignores: [],
 	},
@@ -78,8 +84,8 @@ export default style(
 );
 ```
 
-> Note that `.eslintignore` no longer works in Flat config, see
-> [customization](#customization) for more details.
+> Note that `.eslintignore` no longer works in Flat config. Use the `ignores`
+> option instead, see [customization](#customization) for more details.
 
 </details>
 
@@ -118,7 +124,8 @@ when you use the `!` operator to assert that a value is not `undefined`. The
 caveat is that this rule will not always play nicely with
 `noUncheckedIndexedAccess`, and will often require you to disable it in certain
 places. I believe that this is a good trade-off, as it will help you catch
-potential bugs in your code, but you can disable it if you find it too restrictive.
+potential bugs in your code, but you can disable it if you find it too
+restrictive.
 
 ```json
 {
@@ -130,7 +137,8 @@ potential bugs in your code, but you can disable it if you find it too restricti
 
 ## VS Code support (auto fix)
 
-Install [VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+Install
+[VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
 Add the following settings to your `.vscode/settings.json`:
 
@@ -173,22 +181,22 @@ Add the following settings to your `.vscode/settings.json`:
 
 ## Customization
 
-Normally you only need to import the `style` preset:
+Normally you only need to import the `isentinel` preset:
 
 ```ts
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style();
+export default isentinel();
 ```
 
 And that's it! Or you can configure each integration individually, for example:
 
 ```ts
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style({
+export default isentinel({
 	// `.eslintignore` is no longer supported in Flat config, use `ignores`
 	// instead
 	ignores: [
@@ -204,13 +212,14 @@ export default style({
 });
 ```
 
-The `style` factory function also accepts any number of arbitrary custom config overrides:
+The `isentinel` factory function also accepts any number of arbitrary custom
+config overrides:
 
 ```ts
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style(
+export default isentinel(
 	{
 		// Configures for this config
 	},
@@ -227,13 +236,21 @@ export default style(
 );
 ```
 
-Check out the [configs](https://github.com/christopher-buss/roblox-ts-eslint-config/tree/main/src/configs) and [factory](https://github.com/christopher-buss/roblox-ts-eslint-config/blob/main/src/factory.ts) for more details.
+Check out the
+[configs](https://github.com/christopher-buss/eslint-config/tree/main/src/configs)
+and
+[factory](https://github.com/christopher-buss/eslint-config/blob/main/src/factory.ts)
+for more details.
 
-> Thanks to [antfu/eslint-config](https://github.com/antfu/eslint-config) and [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the inspiration and reference.
+> Thanks to [antfu/eslint-config](https://github.com/antfu/eslint-config) and
+> [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the
+> inspiration and reference.
 
 ### Plugins Renaming
 
-Since flat config requires us to explicitly provide the plugin names (instead of the mandatory convention from npm package name), we renamed some plugins to make the overall scope more consistent and easier to write.
+Since flat config requires us to explicitly provide the plugin names (instead of
+the mandatory convention from npm package name), we renamed some plugins to make
+the overall scope more consistent and easier to write.
 
 | New Prefix | Original Prefix        | Source Plugin                                                                              |
 | ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
@@ -243,7 +260,8 @@ Since flat config requires us to explicitly provide the plugin names (instead of
 | `ts/*`     | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
 | `style/*`  | `@stylistic/*`         | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic)           |
 
-When you want to override rules, or disable them inline, you need to update to the new prefix:
+When you want to override rules, or disable them inline, you need to update to
+the new prefix:
 
 ```diff
 -// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
@@ -263,22 +281,23 @@ repository rather than this one.
 
 Sometimes you will have words that are not in the dictionary, but are still
 valid for your project. To add these words to the dictionary, you can create a
-`cspell.config.yaml` file in the root of your project with the following content:
+`cspell.config.yaml` file in the root of your project with the following
+content:
 
 ```yaml
 # cspell.config.yaml
 words:
-  - isentinel
-  - isverycool
+    - isentinel
+    - isverycool
 ```
 
 To disable this, you can set the `spellCheck` option to `false`:
 
 ```js
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style({
+export default isentinel({
 	spellCheck: false,
 });
 ```
@@ -288,7 +307,9 @@ For more information on how to configure the spell checker, please refer to the
 
 #### `perfectionist` (sorting)
 
-This plugin [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) allows you to sorted object keys, imports, etc, with auto-fix.
+This plugin
+[`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist)
+allows you to sort object keys, imports, etc, with auto-fix.
 
 The plugin is installed and some rules are enabled by default, but these rules
 can be disabled or overridden by your own config. For example, I personally have
@@ -296,9 +317,9 @@ sort-objects set to:
 
 ```js
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style({
+export default isentinel({
 	rules: {
 		"perfectionist/sort-objects": [
 			"warn",
@@ -321,7 +342,8 @@ export default style({
 
 ### Optional Configs
 
-We provide some optional configs for specific use cases, that we don't include their dependencies by default.
+We provide some optional configs for specific use cases, that we don't include
+their dependencies by default.
 
 #### React
 
@@ -329,9 +351,9 @@ To enable React support, you need to explicitly turn it on:
 
 ```js
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style({
+export default isentinel({
 	react: true,
 });
 ```
@@ -342,14 +364,15 @@ To enable Jest support, you need to explicitly turn it on:
 
 ```js
 // eslint.config.ts
-import style from "@isentinel/eslint-config";
+import isentinel from "@isentinel/eslint-config";
 
-export default style({
+export default isentinel({
 	test: true,
 });
 ```
 
-Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually:
+Running `npx eslint` should prompt you to install the required dependencies,
+otherwise, you can install them manually:
 
 ```bash
 pnpm i -D @eslint-react/eslint-plugin eslint-plugin-react-roblox-hooks eslint-plugin-jest
@@ -357,7 +380,8 @@ pnpm i -D @eslint-react/eslint-plugin eslint-plugin-react-roblox-hooks eslint-pl
 
 ### Lint Staged
 
-If you want to apply lint and auto-fix before every commit, you can add the following to your `package.json`:
+If you want to apply lint and auto-fix before every commit, you can add the
+following to your `package.json`:
 
 ```json
 {
@@ -378,7 +402,9 @@ pnpm i -D lint-staged simple-git-hooks
 
 ## View what rules are enabled
 
-There is a visual tool to help you view what rules are enabled in your project and apply them to what files, [eslint-config-inspector](https://github.com/eslint/config-inspector)
+There is a visual tool to help you view what rules are enabled in your project
+and apply them to what files,
+[eslint-config-inspector](https://github.com/eslint/config-inspector)
 
 Go to your project root that contains `eslint.config.ts` and run:
 
@@ -388,7 +414,9 @@ npx eslint-config-inspector
 
 ## Versioning Policy
 
-This project follows [Semantic Versioning](https://semver.org/) for releases. However, since this is just a config and involves opinions and many moving parts, we don't treat rules changes as breaking changes.
+This project follows [Semantic Versioning](https://semver.org/) for releases.
+However, since this is just a config and involves opinions and many moving
+parts, we don't treat rules changes as breaking changes.
 
 ### Changes Considered as Breaking Changes
 

package/dist/cli.js

@@ -18,27 +18,20 @@ init_esm_shims();
 import ansis from "ansis";
 
 // package.json
-var version = "1.3.0";
+var version = "3.0.0-beta.1";
 var package_default = {
   name: "@isentinel/eslint-config",
   version,
   description: "iSentinel's ESLint config",
-  keywords: [
-    "eslint-config",
-    "roblox",
-    "roblox-ts",
-    "rbxts"
-  ],
-  homepage: "https://github.com/christopher-buss/roblox-ts-eslint-config",
+  keywords: ["eslint-config", "roblox", "roblox-ts", "rbxts"],
+  homepage: "https://github.com/christopher-buss/eslint-config",
   repository: {
     type: "git",
-    url: "git+https://github.com/christopher-buss/roblox-ts-eslint-config.git"
+    url: "git+https://github.com/christopher-buss/eslint-config.git"
   },
   license: "MIT",
   author: "Christopher Buss <christopher.buss@pm.me> (https://github.com/christopher-buss)",
-  contributors: [
-    "Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)"
-  ],
+  contributors: ["Anthony Fu <anthonyfu117@hotmail.com> (https://github.com/antfu/)"],
   type: "module",
   exports: {
     ".": "./dist/index.js"
@@ -46,10 +39,7 @@ var package_default = {
   main: "./dist/index.js",
   types: "./dist/index.d.ts",
   bin: "./bin/index.js",
-  files: [
-    "bin",
-    "dist"
-  ],
+  files: ["bin", "dist"],
   scripts: {
     build: "nr gen && tsup --clean --dts",
     "build:inspector": "pnpm build && npx @eslint/config-inspector build",
@@ -63,7 +53,7 @@ var package_default = {
     release: "bumpp",
     stub: "tsup",
     typecheck: "tsc --noEmit",
-    watch: "tsup --watch"
+    watch: "tsup --watch --dts"
   },
   "simple-git-hooks": {
     "pre-commit": "pnpm lint-staged"
@@ -88,21 +78,23 @@ var package_default = {
     "eslint-config-flat-gitignore": "catalog:prod",
     "eslint-config-prettier": "catalog:prod",
     "eslint-flat-config-utils": "catalog:prod",
+    "eslint-import-resolver-node": "catalog:prod",
     "eslint-merge-processors": "catalog:prod",
     "eslint-plugin-antfu": "catalog:prod",
-    "eslint-plugin-arrow-return-style": "catalog:prod",
+    "eslint-plugin-arrow-return-style-x": "catalog:prod",
     "eslint-plugin-better-max-params": "catalog:prod",
     "eslint-plugin-comment-length": "catalog:prod",
     "eslint-plugin-de-morgan": "catalog:prod",
-    "eslint-plugin-format": "catalog:prod",
     "eslint-plugin-format-lua": "catalog:prod",
     "eslint-plugin-import-lite": "catalog:prod",
     "eslint-plugin-jsdoc": "catalog:prod",
     "eslint-plugin-jsonc": "catalog:prod",
+    "eslint-plugin-n": "catalog:peer",
     "eslint-plugin-no-only-tests": "catalog:prod",
     "eslint-plugin-package-json": "catalog:prod",
     "eslint-plugin-perfectionist": "catalog:prod",
     "eslint-plugin-pnpm": "catalog:prod",
+    "eslint-plugin-prettier": "catalog:prod",
     "eslint-plugin-promise": "catalog:prod",
     "eslint-plugin-roblox-ts": "catalog:prod",
     "eslint-plugin-sentinel": "catalog:prod",
@@ -130,9 +122,11 @@ var package_default = {
     "@types/node": "catalog:dev",
     "@types/prompts": "catalog:dev",
     "@types/yargs": "catalog:dev",
+    "@vitest/eslint-plugin": "catalog:peer",
     bumpp: "catalog:dev",
     eslint: "catalog:peer",
     "eslint-plugin-jest": "catalog:peer",
+    "eslint-plugin-pnpm": "catalog:prod",
     "eslint-plugin-react-roblox-hooks": "catalog:peer",
     "eslint-plugin-simple-import-sort": "catalog:dev",
     "eslint-typegen": "catalog:dev",
@@ -150,17 +144,25 @@ var package_default = {
   },
   peerDependencies: {
     "@eslint-react/eslint-plugin": "^1.45.0",
+    "@vitest/eslint-plugin": "^1.0.0",
     eslint: "^9.10.0",
-    "eslint-plugin-jest": "^28.9.0",
+    "eslint-plugin-jest": "^28.9.0 || ^29.0.0",
+    "eslint-plugin-n": "^17.0.0",
     "eslint-plugin-react-roblox-hooks": "^5.1.0-rbx.1"
   },
   peerDependenciesMeta: {
     "@eslint-react/eslint-plugin": {
       optional: true
     },
+    "@vitest/eslint-plugin": {
+      optional: true
+    },
     "eslint-plugin-jest": {
       optional: true
     },
+    "eslint-plugin-n": {
+      optional: true
+    },
     "eslint-plugin-react-roblox-hooks": {
       optional: true
     }
@@ -250,9 +252,9 @@ init_esm_shims();
 import { execSync } from "child_process";
 function getEslintConfigContent(mainConfig, additionalConfigs) {
   return `
-import style from '@isentinel/eslint-config'
+import isentinel from '@isentinel/eslint-config'
 
-export default style({
+export default isentinel({
 ${mainConfig}
 }${additionalConfigs?.map((config) => `,{
 ${config}