@isentinel/eslint-config 1.1.2 → 1.2.2

package/README.md

@@ -2,7 +2,11 @@
 
 ## Usage
 
-### Quick Start
+### 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.
+
+### Example Usage
 
 For an existing template that already has this config setup, please refer to the
 [roblox-ts
@@ -10,10 +14,6 @@ template](https://github.com/christopher-buss/roblox-ts-project-template)
 repository. This includes all necessarily files and configurations to get you up
 and running.
 
-### 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.
-
 ```bash
 npx @isentinel/eslint-config@latest
 ```
@@ -30,36 +30,56 @@ pnpm i -D eslint @isentinel/eslint-config
 
 With [`"type": "module"`](https://nodejs.org/api/packages.html#type) in `package.json` (recommended):
 
-```js
+```ts
 // eslint.config.ts
 import style from "@isentinel/eslint-config";
 
 export default style();
 ```
 
-> Note that `.eslintignore` no longer works in Flat config, see
-> [customization](#customization) for more details.
+#### Optional: TypeScript Config Support
 
-> [!TIP]
-> ESLint can support .ts config files, but requires some additional setup. See
-> [here](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files)
-> for more information.
+If you want to use `eslint.config.ts` instead of `.js`, install `jiti` v2.0.0 or greater:
 
-### tsconfig.build.json
+```bash
+pnpm i -D jiti@^2.0.0
+```
 
-Create a `tsconfig.build.json` file in the root of your project with the
-following content:
+See [ESLint's TypeScript configuration documentation](https://eslint.org/docs/latest/use/configure/configuration-files#typescript-configuration-files) for more details.
 
-```json
-{
-	"extends": "./tsconfig.json",
-	"include": ["src/**/*", "eslint.config.ts"],
-	"exclude": ["node_modules"]
-}
+<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.
+
+```ts
+// eslint.config.ts
+import { FlatCompat } from "@eslint/eslintrc";
+import style from "@isentinel/eslint-config";
+
+const compat = new FlatCompat();
+
+export default style(
+	{
+		ignores: [],
+	},
+
+	// Legacy config
+	...compat.config({
+		extends: [
+			"eslint:recommended",
+			// Other extends...
+		],
+	}),
+
+	// Other flat configs...
+);
 ```
 
-This is required to allow typescript to work with the ESLint configuration file,
-without erroring due to it not being included in the project.
+> Note that `.eslintignore` no longer works in Flat config, see
+> [customization](#customization) for more details.
 
 ### Add script for package.json
 
@@ -114,9 +134,6 @@ Add the following settings to your `.vscode/settings.json`:
 
 ```json
 {
-	// Enable the ESlint flat config support
-	"eslint.experimental.useFlatConfig": true,
-
 	"editor.formatOnSave": false,
 
 	// Auto fix
@@ -148,10 +165,7 @@ Add the following settings to your `.vscode/settings.json`:
 		"jsonc",
 		"yaml",
 		"toml"
-	],
-
-	// Currently required to enable .ts config files
-	"eslint.options": { "flags": ["unstable_ts_config"] }
+	]
 }
 ```
 
@@ -183,14 +197,6 @@ export default style({
 	// Type of the project. `package` for packages, the default is `game`
 	type: "package",
 
-	// Provide TypeScript parser options for access to type checking lints.
-	typescript: {
-		parserOptions: {
-			project: "tsconfig.build.json",
-		},
-		tsconfigPath: "tsconfig.build.json",
-	},
-
 	// Disable yaml support
 	yaml: false,
 });
@@ -295,14 +301,15 @@ export default style({
 		"perfectionist/sort-objects": [
 			"warn",
 			{
-				"custom-groups": {
-					id: "id",
-					name: "name",
-					"react-props": ["children", "ref"],
+				customGroups: {
+					callbacks: ["\b(on[A-Z][a-zA-Z]*)\b"],
+					id: "^id$",
+					name: "^name$",
+					reactProps: ["^children$", "^ref$"],
 				},
-				groups: ["id", "name", "unknown", "react-props"],
+				groups: ["id", "name", "unknown", "reactProps"],
 				order: "asc",
-				"partition-by-comment": "Part:**",
+				partitionByComment: "^Part:\\*\\*(.*)$",
 				type: "natural",
 			},
 		],
@@ -327,10 +334,23 @@ export default style({
 });
 ```
 
+#### Jest
+
+To enable Jest support, you need to explicitly turn it on:
+
+```js
+// eslint.config.ts
+import style from "@isentinel/eslint-config";
+
+export default style({
+	test: true,
+});
+```
+
 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
+pnpm i -D @eslint-react/eslint-plugin eslint-plugin-react-roblox-hooks eslint-plugin-jest
 ```
 
 ### Lint Staged

package/dist/{chunk-VXR6SE7R.js → chunk-2HV5XKT7.js}

@@ -27,9 +27,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 
-// node_modules/.pnpm/tsup@8.4.0_jiti@2.4.2_postcss@8.4.38_tsx@4.19.1_typescript@5.8.3_yaml@2.7.1/node_modules/tsup/assets/esm_shims.js
+// node_modules/.pnpm/tsup@8.4.0_jiti@2.4.2_tsx@4.20.3_typescript@5.8.3_yaml@2.8.0/node_modules/tsup/assets/esm_shims.js
 var init_esm_shims = __esm({
-  "node_modules/.pnpm/tsup@8.4.0_jiti@2.4.2_postcss@8.4.38_tsx@4.19.1_typescript@5.8.3_yaml@2.7.1/node_modules/tsup/assets/esm_shims.js"() {
+  "node_modules/.pnpm/tsup@8.4.0_jiti@2.4.2_tsx@4.20.3_typescript@5.8.3_yaml@2.8.0/node_modules/tsup/assets/esm_shims.js"() {
     "use strict";
   }
 });

package/dist/cli.js

@@ -1,23 +1,24 @@
 import {
   init_esm_shims
-} from "./chunk-VXR6SE7R.js";
+} from "./chunk-2HV5XKT7.js";
 
 // src/cli.ts
 init_esm_shims();
 
 // src/cli/index.ts
 init_esm_shims();
-import { intro, log as log6 } from "@clack/prompts";
+import { intro, log as log5 } from "@clack/prompts";
 import ansis6 from "ansis";
-import process6 from "node:process";
+import process5 from "node:process";
 import yargs from "yargs";
 import { hideBin } from "yargs/helpers";
 
 // src/cli/constants.ts
 init_esm_shims();
+import ansis from "ansis";
 
 // package.json
-var version = "1.1.2";
+var version = "1.2.2";
 var package_default = {
   name: "@isentinel/eslint-config",
   version,
@@ -53,7 +54,7 @@ var package_default = {
     build: "nr gen && tsup --clean --dts",
     "build:inspector": "pnpm build && npx @eslint/config-inspector build",
     dev: "npx @eslint/config-inspector --config eslint.config.ts",
-    gen: "tsx scripts/typegen.ts && tsx scripts/versiongen.ts",
+    gen: "NODE_OPTIONS='--import ./scripts/register-stylua-loader.mjs' tsx scripts/typegen.ts && NODE_OPTIONS='--import ./scripts/register-stylua-loader.mjs' tsx scripts/versiongen.ts",
     postgen: "echo 'Generation complete!'",
     lint: "eslint",
     prepack: "nr build",
@@ -102,12 +103,12 @@ var package_default = {
     "eslint-plugin-perfectionist": "catalog:prod",
     "eslint-plugin-pnpm": "catalog:prod",
     "eslint-plugin-promise": "catalog:prod",
+    "eslint-plugin-roblox-ts-x": "catalog:prod",
     "eslint-plugin-sentinel": "catalog:prod",
     "eslint-plugin-sonarjs": "catalog:prod",
     "eslint-plugin-toml": "catalog:prod",
     "eslint-plugin-unicorn": "catalog:prod",
     "eslint-plugin-yml": "catalog:prod",
-    "isentinel-eslint-plugin-roblox-ts": "catalog:prod",
     "jsonc-eslint-parser": "catalog:prod",
     "local-pkg": "catalog:prod",
     "parse-gitignore": "catalog:prod",
@@ -163,7 +164,7 @@ var package_default = {
       optional: true
     }
   },
-  packageManager: "pnpm@10.9.0",
+  packageManager: "pnpm@10.12.1",
   publishConfig: {
     access: "public"
   }
@@ -171,9 +172,6 @@ var package_default = {
 
 // src/cli/constants.ts
 var vscodeSettingsString = `
-  // Enable the ESlint flat config support
-	"eslint.useFlatConfig": true,
-
   // Disable the default formatter, use eslint instead
   "prettier.enable": false,
   "editor.formatOnSave": false,
@@ -210,55 +208,37 @@ var vscodeSettingsString = `
 	  "luau"
   ]
 `;
+var frameworkOptions = [
+  {
+    label: ansis.red("Test"),
+    value: "test"
+  },
+  {
+    label: ansis.cyan("React"),
+    value: "react"
+  }
+];
+var frameworks = frameworkOptions.map(({ value }) => value);
 var dependenciesMap = {
-  react: ["@eslint-react/eslint-plugin", "eslint-plugin-react-roblox-hooks"]
+  react: ["@eslint-react/eslint-plugin", "eslint-plugin-react-roblox-hooks"],
+  test: ["eslint-plugin-jest"]
 };
 
 // src/cli/run.ts
 init_esm_shims();
-import { cancel, confirm, group, log as log5, outro } from "@clack/prompts";
+import { cancel, confirm, group, log as log4, multiselect, outro } from "@clack/prompts";
 import ansis5 from "ansis";
-import fs4 from "node:fs";
-import path5 from "node:path";
-import process5 from "node:process";
-
-// src/cli/stages/add-tsconfig.build.json.ts
-init_esm_shims();
-import { log } from "@clack/prompts";
-import ansis from "ansis";
-import fs from "node:fs";
-import fsp from "node:fs/promises";
-import path from "path";
-async function addTsconfigBuild() {
-  const cwd = process.cwd();
-  const pathTsconfigBuild = path.join(cwd, "tsconfig.build.json");
-  if (fs.existsSync(pathTsconfigBuild)) {
-    log.info(ansis.yellow("tsconfig.build.json already exists"));
-    return;
-  }
-  const tsconfigBuildContent = `{
-	"extends": "./tsconfig.json",
-	"include": ["src/**/*", "eslint.config.ts"],
-	"exclude": ["node_modules"]
-	}
-	`;
-  await fsp.writeFile(pathTsconfigBuild, tsconfigBuildContent, "utf-8");
-  log.success(ansis.green("Created tsconfig.build.json"));
-  log.info(
-    ansis.yellow(
-      `You must add '"exclude": ["./eslint.config.ts"]' to your tsconfig.json. In the future, this will be done automatically.`
-    )
-  );
-}
+import fs3 from "node:fs";
+import process4 from "node:process";
 
 // src/cli/stages/update-eslint-files.ts
 init_esm_shims();
-import { log as log2, note } from "@clack/prompts";
+import { log, note } from "@clack/prompts";
 import ansis2 from "ansis";
-import fs2 from "node:fs";
-import fsp2 from "node:fs/promises";
-import path2 from "node:path";
-import process2 from "node:process";
+import fs from "node:fs";
+import fsp from "node:fs/promises";
+import path from "node:path";
+import process from "node:process";
 import parse from "parse-gitignore";
 
 // src/cli/utils.ts
@@ -285,18 +265,18 @@ function isGitClean() {
 }
 
 // src/cli/stages/update-eslint-files.ts
-async function updateEslintFiles() {
-  const cwd = process2.cwd();
-  const pathESLintIgnore = path2.join(cwd, ".eslintignore");
-  const pathPackageJSON = path2.join(cwd, "package.json");
-  const packageContent = await fsp2.readFile(pathPackageJSON, "utf-8");
-  const package_ = JSON.parse(packageContent);
-  const configFileName = package_.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
-  const pathFlatConfig = path2.join(cwd, configFileName);
+async function updateEslintFiles(result) {
+  const cwd = process.cwd();
+  const pathESLintIgnore = path.join(cwd, ".eslintignore");
+  const pathPackageJSON = path.join(cwd, "package.json");
+  const packageContent = await fsp.readFile(pathPackageJSON, "utf-8");
+  const parsedPackage = JSON.parse(packageContent);
+  const configFileName = parsedPackage.type === "module" ? "eslint.config.js" : "eslint.config.mjs";
+  const pathFlatConfig = path.join(cwd, configFileName);
   const eslintIgnores = [];
-  if (fs2.existsSync(pathESLintIgnore)) {
-    log2.step(ansis2.cyan("Migrating existing .eslintignore"));
-    const content = await fsp2.readFile(pathESLintIgnore, "utf-8");
+  if (fs.existsSync(pathESLintIgnore)) {
+    log.step(ansis2.cyan("Migrating existing .eslintignore"));
+    const content = await fsp.readFile(pathESLintIgnore, "utf-8");
     const parsed = parse(content);
     const globs = parsed.globs();
     for (const glob of globs) {
@@ -311,20 +291,15 @@ async function updateEslintFiles() {
   if (eslintIgnores.length) {
     configLines.push(`ignores: ${JSON.stringify(eslintIgnores)},`);
   }
-  configLines.push(
-    `${"react"}: true,`,
-    `typescript: {
-			parserOptions: {
-				project: "tsconfig.build.json",
-			},
-		},`
-  );
+  for (const framework of result.frameworks) {
+    configLines.push(`${framework}: true,`);
+  }
   const mainConfig = configLines.map((index) => `  ${index}`).join("\n");
   const additionalConfig = [];
   const eslintConfigContent = getEslintConfigContent(mainConfig, additionalConfig);
-  await fsp2.writeFile(pathFlatConfig, eslintConfigContent);
-  log2.success(ansis2.green(`Created ${configFileName}`));
-  const files = fs2.readdirSync(cwd);
+  await fsp.writeFile(pathFlatConfig, eslintConfigContent);
+  log.success(ansis2.green(`Created ${configFileName}`));
+  const files = fs.readdirSync(cwd);
   const legacyConfig = [];
   for (const file of files) {
     if (/eslint|prettier/.test(file) && !/eslint\.config\./.test(file)) {
@@ -338,82 +313,84 @@ async function updateEslintFiles() {
 
 // src/cli/stages/update-package-json.ts
 init_esm_shims();
-import { log as log3, note as note2 } from "@clack/prompts";
+import { log as log2, note as note2 } from "@clack/prompts";
 import ansis3 from "ansis";
-import fsp3 from "node:fs/promises";
-import path3 from "node:path";
-import process3 from "node:process";
+import fsp2 from "node:fs/promises";
+import path2 from "node:path";
+import process2 from "node:process";
 
 // src/cli/constants-generated.ts
 init_esm_shims();
 var versionsMap = {
   "@eslint-react/eslint-plugin": "1.48.4",
   "eslint": "9.25.1",
+  "eslint-plugin-jest": "28.11.0",
   "eslint-plugin-react-roblox-hooks": "5.1.0-rbx.1"
 };
 
 // src/cli/stages/update-package-json.ts
 async function updatePackageJson() {
-  const cwd = process3.cwd();
-  const pathPackageJSON = path3.join(cwd, "package.json");
-  log3.step(ansis3.cyan(`Bumping @isentinel/eslint-config to v${version}`));
-  const packageContent = await fsp3.readFile(pathPackageJSON, "utf-8");
-  const package_ = JSON.parse(packageContent);
-  package_.devDependencies ??= {};
-  package_.devDependencies["@isentinel/eslint-config"] = `^${version}`;
-  package_.devDependencies.eslint ??= versionsMap.eslint;
+  const cwd = process2.cwd();
+  const pathPackageJSON = path2.join(cwd, "package.json");
+  log2.step(ansis3.cyan(`Bumping @isentinel/eslint-config to v${version}`));
+  const packageContent = await fsp2.readFile(pathPackageJSON, "utf-8");
+  const parsedPackage = JSON.parse(packageContent);
+  parsedPackage.devDependencies ??= {};
+  parsedPackage.devDependencies["@isentinel/eslint-config"] = `^${version}`;
+  parsedPackage.devDependencies.eslint ??= versionsMap.eslint;
   const addedPackages = [];
   for (const dep of dependenciesMap["react"]) {
-    package_.devDependencies[dep] = versionsMap[dep];
+    parsedPackage.devDependencies[dep] = versionsMap[dep];
     addedPackages.push(dep);
   }
   if (addedPackages.length) {
     note2(`${ansis3.dim(addedPackages.join(", "))}`, "Added packages");
   }
-  await fsp3.writeFile(pathPackageJSON, JSON.stringify(package_, null, 2));
-  log3.success(ansis3.green("Changes wrote to package.json"));
+  await fsp2.writeFile(pathPackageJSON, JSON.stringify(parsedPackage, null, 2));
+  log2.success(ansis3.green("Changes wrote to package.json"));
 }
 
 // src/cli/stages/update-vscode-settings.ts
 init_esm_shims();
-import { log as log4 } from "@clack/prompts";
+import { log as log3 } from "@clack/prompts";
 import ansis4 from "ansis";
-import fs3 from "node:fs";
-import fsp4 from "node:fs/promises";
-import path4 from "node:path";
-import process4 from "node:process";
+import fs2 from "node:fs";
+import fsp3 from "node:fs/promises";
+import path3 from "node:path";
+import process3 from "node:process";
 async function updateVscodeSettings(result) {
-  const cwd = process4.cwd();
+  const cwd = process3.cwd();
   if (!result.updateVscodeSettings) {
     return;
   }
-  const dotVscodePath = path4.join(cwd, ".vscode");
-  const settingsPath = path4.join(dotVscodePath, "settings.json");
-  if (!fs3.existsSync(dotVscodePath)) {
-    await fsp4.mkdir(dotVscodePath, { recursive: true });
+  const dotVscodePath = path3.join(cwd, ".vscode");
+  const settingsPath = path3.join(dotVscodePath, "settings.json");
+  if (!fs2.existsSync(dotVscodePath)) {
+    await fsp3.mkdir(dotVscodePath, { recursive: true });
   }
-  if (!fs3.existsSync(settingsPath)) {
-    await fsp4.writeFile(settingsPath, `{${vscodeSettingsString}}
+  if (!fs2.existsSync(settingsPath)) {
+    await fsp3.writeFile(settingsPath, `{${vscodeSettingsString}}
 `, "utf-8");
-    log4.success(ansis4.green("Created .vscode/settings.json"));
+    log3.success(ansis4.green("Created .vscode/settings.json"));
     return;
   }
-  let settingsContent = await fsp4.readFile(settingsPath, "utf8");
+  let settingsContent = await fsp3.readFile(settingsPath, "utf8");
   settingsContent = settingsContent.trim().replace(/\s*\}$/, "");
   settingsContent += settingsContent.endsWith(",") || settingsContent.endsWith("{") ? "" : ",";
   settingsContent += `${vscodeSettingsString}}
 `;
-  await fsp4.writeFile(settingsPath, settingsContent, "utf-8");
-  log4.success(ansis4.green("Updated .vscode/settings.json"));
+  await fsp3.writeFile(settingsPath, settingsContent, "utf-8");
+  log3.success(ansis4.green("Updated .vscode/settings.json"));
 }
 
 // src/cli/run.ts
 async function run(options = {}) {
-  const argumentSkipPrompt = !!process5.env.SKIP_PROMPT || options.yes;
-  const argumentTemplate = ["react"];
-  if (fs4.existsSync(path5.join(process5.cwd(), "eslint.config.js"))) {
-    log5.warn(ansis5.yellow("eslint.config.js already exists, migration wizard exited."));
-    return process5.exit(1);
+  const argumentSkipPrompt = !!process4.env.SKIP_PROMPT || options.yes;
+  const argumentTemplate = options.frameworks?.map((framework) => framework?.trim()).filter(Boolean);
+  const eslintConfigFiles = fs3.readdirSync(process4.cwd()).filter((file) => file.startsWith("eslint.config."));
+  if (eslintConfigFiles.length > 0) {
+    log4.warn(ansis5.yellow(`${eslintConfigFiles[0]} already exists, migration wizard exited.`));
+    return process4.exit(1);
   }
   let result = {
     frameworks: argumentTemplate,
@@ -423,6 +400,18 @@ async function run(options = {}) {
   if (!argumentSkipPrompt) {
     result = await group(
       {
+        frameworks: ({ results }) => {
+          const isArgumentTemplateValid = typeof argumentTemplate === "string" && !!frameworks.includes(argumentTemplate);
+          if (!results.uncommittedConfirmed || isArgumentTemplateValid) {
+            return;
+          }
+          const message = !isArgumentTemplateValid && argumentTemplate ? `"${argumentTemplate}" isn't a valid template. Please choose from below: ` : "Select a framework:";
+          return multiselect({
+            message: ansis5.reset(message),
+            options: frameworkOptions,
+            required: false
+          });
+        },
         uncommittedConfirmed: () => {
           if (argumentSkipPrompt || isGitClean()) {
             return Promise.resolve(true);
@@ -445,21 +434,22 @@ async function run(options = {}) {
       {
         onCancel: () => {
           cancel("Operation cancelled.");
-          process5.exit(0);
+          process4.exit(0);
         }
       }
     );
     if (!result.uncommittedConfirmed) {
-      return process5.exit(1);
+      return process4.exit(1);
     }
   }
   await updatePackageJson();
-  await updateEslintFiles();
+  await updateEslintFiles(result);
   await updateVscodeSettings(result);
-  await addTsconfigBuild();
-  log5.success(ansis5.green("Setup completed"));
-  outro(`Now you can update the dependencies and run ${ansis5.blue("eslint --fix")}
-`);
+  log4.success(ansis5.green("Setup completed"));
+  outro(
+    `Now you can update the dependencies by running ${ansis5.blue("pnpm install")} and run ${ansis5.blue("eslint --fix")}
+`
+  );
 }
 
 // src/cli/index.ts
@@ -469,7 +459,7 @@ function header() {
   const versionText = `v${package_default.version}`;
   intro(introText + ansis6.dim(versionText));
 }
-var instance = yargs(hideBin(process6.argv)).scriptName("@isentinel/eslint-config").usage("").command(
+var instance = yargs(hideBin(process5.argv)).scriptName("@isentinel/eslint-config").usage("").command(
   "*",
   "Run the initialization or migration",
   (args) => {
@@ -488,9 +478,9 @@ var instance = yargs(hideBin(process6.argv)).scriptName("@isentinel/eslint-confi
     try {
       await run(args);
     } catch (err) {
-      log6.error(ansis6.inverse(ansis6.red(" Failed to migrate ")));
-      log6.error(ansis6.red(`\u2718 ${String(err)}`));
-      process6.exit(1);
+      log5.error(ansis6.inverse(ansis6.red(" Failed to migrate ")));
+      log5.error(ansis6.red(`\u2718 ${String(err)}`));
+      process5.exit(1);
     }
   }
 ).showHelpOnFail(false).alias("h", "help").version("version", package_default.version).alias("v", "version");