@isentinel/eslint-config 0.6.0-beta.2 → 0.6.0-beta.4

package/README.md

@@ -10,7 +10,19 @@ template](https://github.com/christopher-buss/roblox-ts-project-template)
 repository. This includes all necessarily files and configurations to get you up
 and running.
 
-### Install
+## Usage
+
+### 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
+```
+
+### Manual Install
+
+If you prefer to set up manually:
 
 ```bash
 pnpm i -D eslint @isentinel/eslint-config

package/dist/index.cjs

@@ -34,9 +34,12 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // node_modules/.pnpm/tsup@8.1.0_postcss@8.4.38_typescript@5.4.5/node_modules/tsup/assets/cjs_shims.js
+var getImportMetaUrl, importMetaUrl;
 var init_cjs_shims = __esm({
   "node_modules/.pnpm/tsup@8.1.0_postcss@8.4.38_typescript@5.4.5/node_modules/tsup/assets/cjs_shims.js"() {
     "use strict";
+    getImportMetaUrl = () => typeof document === "undefined" ? new URL("file:" + __filename).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
+    importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
   }
 });
 
@@ -890,71 +893,6 @@ init_cjs_shims();
 init_cjs_shims();
 var import_compat = require("@eslint/compat");
 
-// src/plugins.ts
-init_cjs_shims();
-var import_eslint_plugin = __toESM(require("@cspell/eslint-plugin"), 1);
-var import_eslint_plugin_comment_length = __toESM(require("@isentinel/eslint-plugin-comment-length"), 1);
-var import_eslint_plugin2 = __toESM(require("@shopify/eslint-plugin"), 1);
-var import_eslint_config_prettier = __toESM(require("eslint-config-prettier"), 1);
-var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
-var import_eslint_plugin_arrow_return_style = __toESM(require("eslint-plugin-arrow-return-style"), 1);
-var import_eslint_plugin_eslint_comments = __toESM(require("eslint-plugin-eslint-comments"), 1);
-var import_eslint_plugin_format = __toESM(require("eslint-plugin-format"), 1);
-var pluginImport = __toESM(require("eslint-plugin-import-x"), 1);
-var import_eslint_plugin_no_autofix = __toESM(require("eslint-plugin-no-autofix"), 1);
-var import_eslint_plugin_perfectionist = __toESM(require("eslint-plugin-perfectionist"), 1);
-var import_eslint_plugin_promise = __toESM(require("eslint-plugin-promise"), 1);
-var import_eslint_plugin_simple_import_sort = __toESM(require_eslint_plugin_simple_import_sort(), 1);
-var pluginSonar = __toESM(require("eslint-plugin-sonarjs"), 1);
-var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
-var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-imports"), 1);
-var import_isentinel_eslint_plugin_roblox_ts = __toESM(require("isentinel-eslint-plugin-roblox-ts"), 1);
-
-// src/configs/comments.ts
-async function comments() {
-  return [
-    {
-      name: "style:eslint-comments",
-      plugins: {
-        "comment-length": (0, import_compat.fixupPluginRules)(import_eslint_plugin_comment_length.default),
-        "eslint-comments": import_eslint_plugin_eslint_comments.default
-      },
-      rules: {
-        "comment-length/limit-multi-line-comments": [
-          "warn",
-          {
-            ignoreUrls: true,
-            maxLength: 80
-          }
-        ],
-        "comment-length/limit-single-line-comments": [
-          "warn",
-          {
-            ignoreUrls: true,
-            maxLength: 80
-          }
-        ],
-        "eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],
-        "eslint-comments/no-aggregating-enable": "error",
-        "eslint-comments/no-duplicate-disable": "error",
-        "eslint-comments/no-unlimited-disable": "error",
-        "eslint-comments/no-unused-enable": "error",
-        "eslint-comments/require-description": [
-          "error",
-          {
-            ignore: ["eslint-enable"]
-          }
-        ],
-        "no-inline-comments": "error",
-        "style/multiline-comment-style": ["error", "separate-lines"]
-      }
-    }
-  ];
-}
-
-// src/configs/formatters.ts
-init_cjs_shims();
-
 // src/globs.ts
 init_cjs_shims();
 var GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
@@ -1008,6 +946,67 @@ var GLOB_EXCLUDE = [
   "**/roblox.yml"
 ];
 
+// src/plugins.ts
+init_cjs_shims();
+var import_eslint_plugin = __toESM(require("@cspell/eslint-plugin"), 1);
+var import_eslint_plugin_comment_length = __toESM(require("@isentinel/eslint-plugin-comment-length"), 1);
+var import_eslint_plugin2 = __toESM(require("@shopify/eslint-plugin"), 1);
+var import_eslint_config_prettier = __toESM(require("eslint-config-prettier"), 1);
+var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
+var import_eslint_plugin_arrow_return_style = __toESM(require("eslint-plugin-arrow-return-style"), 1);
+var import_eslint_plugin_eslint_comments = __toESM(require("eslint-plugin-eslint-comments"), 1);
+var import_eslint_plugin_format = __toESM(require("eslint-plugin-format"), 1);
+var pluginImport = __toESM(require("eslint-plugin-import-x"), 1);
+var import_eslint_plugin_no_autofix = __toESM(require("eslint-plugin-no-autofix"), 1);
+var import_eslint_plugin_perfectionist = __toESM(require("eslint-plugin-perfectionist"), 1);
+var import_eslint_plugin_promise = __toESM(require("eslint-plugin-promise"), 1);
+var import_eslint_plugin_simple_import_sort = __toESM(require_eslint_plugin_simple_import_sort(), 1);
+var pluginSonar = __toESM(require("eslint-plugin-sonarjs"), 1);
+var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
+var import_isentinel_eslint_plugin_roblox_ts = __toESM(require("isentinel-eslint-plugin-roblox-ts"), 1);
+
+// src/configs/comments.ts
+async function comments() {
+  return [
+    {
+      name: "style:eslint-comments",
+      plugins: {
+        "comment-length": (0, import_compat.fixupPluginRules)(import_eslint_plugin_comment_length.default),
+        "eslint-comments": import_eslint_plugin_eslint_comments.default
+      },
+      rules: {
+        // We cover these with prettier
+        "comment-length/limit-multi-line-comments": "off",
+        "comment-length/limit-single-line-comments": "off",
+        "eslint-comments/disable-enable-pair": ["error", { allowWholeFile: true }],
+        "eslint-comments/no-aggregating-enable": "error",
+        "eslint-comments/no-duplicate-disable": "error",
+        "eslint-comments/no-unlimited-disable": "error",
+        "eslint-comments/no-unused-enable": "error",
+        "eslint-comments/require-description": [
+          "error",
+          {
+            ignore: ["eslint-enable"]
+          }
+        ],
+        "no-inline-comments": "error",
+        "style/multiline-comment-style": ["error", "separate-lines"]
+      }
+    },
+    {
+      files: [GLOB_YAML],
+      rules: {
+        // TODO: Seems to be a false positive
+        "comment-length/limit-multi-line-comments": "off",
+        "no-inline-comments": "off"
+      }
+    }
+  ];
+}
+
+// src/configs/formatters.ts
+init_cjs_shims();
+
 // src/configs/stylistic.ts
 init_cjs_shims();
 
@@ -1183,13 +1182,12 @@ async function stylistic(options = {}) {
 
 // src/configs/formatters.ts
 async function formatters(options = {}, stylistic2 = {}, markdownEnabled = true) {
-  if (options === true) {
+  if (options === void 0 || options === true) {
     options = {
       css: true,
       graphql: true,
       html: true,
-      markdown: true,
-      toml: true
+      markdown: true
     };
   }
   const { indent, quotes, semi } = {
@@ -1292,24 +1290,6 @@ async function formatters(options = {}, stylistic2 = {}, markdownEnabled = true)
       }
     });
   }
-  if (options.toml) {
-    configs.push({
-      files: ["**/*.toml"],
-      languageOptions: {
-        parser: import_eslint_plugin_format.default.parserPlain
-      },
-      name: "style:formatter:toml",
-      rules: {
-        "format/dprint": [
-          "error",
-          {
-            ...dprintOptions,
-            language: "toml"
-          }
-        ]
-      }
-    });
-  }
   if (options.markdown) {
     const formatter = options.markdown === true ? "prettier" : options.markdown;
     configs.push({
@@ -1440,7 +1420,10 @@ async function jsdoc(options = {}) {
         "jsdoc/no-multi-asterisks": "warn",
         "jsdoc/no-types": "warn",
         "jsdoc/require-asterisk-prefix": "warn",
-        "jsdoc/require-description": ["warn", { exemptedBy: ["hidden, ignore"] }],
+        "jsdoc/require-description": [
+          "warn",
+          { exemptedBy: ["hidden, ignore", "inheritdoc", "client", "server"] }
+        ],
         "jsdoc/require-description-complete-sentence": "warn",
         "jsdoc/require-hyphen-before-param-description": "warn",
         "jsdoc/require-param": [
@@ -1658,14 +1641,19 @@ async function prettier(options) {
     GLOB_SRC,
     ...componentExtensions.map((extension) => `**/*.${extension}`)
   ];
-  const defaultPrettierOptions = prettierOptions ?? {
+  const defaultPrettierOptions = {
     arrowParens: "avoid",
-    printWidth: 120,
+    jsdocPreferCodeFences: true,
+    jsdocPrintWidth: 80,
+    plugins: ["prettier-plugin-jsdoc"],
+    printWidth: 100,
     semi: true,
     singleQuote: false,
     tabWidth: 4,
     trailingComma: "all",
-    useTabs: true
+    tsdoc: true,
+    useTabs: true,
+    ...prettierOptions
   };
   return [
     {
@@ -2314,12 +2302,21 @@ function sortTsconfig() {
 
 // src/configs/spelling.ts
 init_cjs_shims();
+var import_node_module = require("module");
+var import_node_url = require("url");
+var require2 = (0, import_node_module.createRequire)(importMetaUrl);
 async function spelling(options = {}) {
-  const { componentExts: componentExtensions = [] } = options;
+  const { componentExts: componentExtensions = [], language = "en-US" } = options;
   const files = options.files ?? [
     GLOB_SRC,
     ...componentExtensions.map((extension) => `**/*.${extension}`)
   ];
+  const robloxDictionary = require2.resolve("@isentinel/dict-roblox");
+  const urlRobloxDictionary = (0, import_node_url.pathToFileURL)(robloxDictionary);
+  const urlRoblox = new URL("dict/roblox.txt", urlRobloxDictionary);
+  const rbxtsDictionary = require2.resolve("@isentinel/dict-rbxts");
+  const urlRbxtsDictionary = (0, import_node_url.pathToFileURL)(rbxtsDictionary);
+  const urlRbxts = new URL("dict/rbxts.txt", urlRbxtsDictionary);
   return [
     {
       files,
@@ -2334,8 +2331,18 @@ async function spelling(options = {}) {
             autoFix: false,
             checkComments: true,
             cspell: {
-              import: ["@isentinel/dict-roblox"],
-              language: "en-US",
+              dictionaries: ["roblox", "rbxts"],
+              dictionaryDefinitions: [
+                {
+                  name: "roblox",
+                  path: urlRoblox.href
+                },
+                {
+                  name: "rbxts",
+                  path: urlRbxts.href
+                }
+              ],
+              language,
               words: ["isentinel"]
             },
             generateSuggestions: true,
@@ -2554,6 +2561,14 @@ async function typescript(options = {}) {
         "no-return-assign": ["error", "always"],
         "no-shadow": "off",
         "no-unneeded-ternary": "error",
+        "no-unused-expressions": [
+          "error",
+          {
+            allowShortCircuit: true,
+            allowTaggedTemplates: true,
+            allowTernary: true
+          }
+        ],
         "no-unused-private-class-members": "error",
         "no-use-before-define": "off",
         "no-useless-constructor": "off",
@@ -2895,7 +2910,7 @@ function style(options = {}, ...userConfigs) {
   if (enableSpellCheck ?? true) {
     configs.push(
       spelling({
-        ...resolveSubOptions(options, "typescript"),
+        ...resolveSubOptions(options, "spellCheck"),
         componentExts: componentExtensions
       })
     );