@isentinel/eslint-config 1.1.2 → 1.2.2

package/dist/index.d.ts

@@ -3027,105 +3027,105 @@ interface RuleOptions {
    */
   'rest-spread-spacing'?: Linter.RuleEntry<RestSpreadSpacing>
   /**
-   * Warns against falsy strings and numbers
-   * @see lua-truthiness
+   * Enforces the use of lua truthiness
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/lua-truthiness/documentation.md
    */
   'roblox/lua-truthiness'?: Linter.RuleEntry<[]>
   /**
-   * Bans LuaTuples boolean expressions
-   * @see misleading-luatuple-checks
+   * Disallow the use of LuaTuple in conditional expressions
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/misleading-lua-tuple-checks/documentation.md
    */
-  'roblox/misleading-luatuple-checks'?: Linter.RuleEntry<[]>
+  'roblox/misleading-lua-tuple-checks'?: Linter.RuleEntry<[]>
   /**
-   * Bans prototype from being used
-   * @see no-any
+   * Disallow values of type `any`. Use `unknown` instead
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-any/documentation.md
    */
-  'roblox/no-any'?: Linter.RuleEntry<[]>
+  'roblox/no-any'?: Linter.RuleEntry<RobloxNoAny>
   /**
-   * Disallows usage of pairs() and ipairs() with Array<T>
-   * @see no-array-pairs
+   * Disallow usage of pairs() and ipairs() with Array<T>
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-array-pairs/documentation.md
    */
   'roblox/no-array-pairs'?: Linter.RuleEntry<[]>
   /**
-   * Bans enum declaration merging
-   * @see no-enum-merging
+   * Disallow merging enum declarations
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-enum-merging/documentation.md
    */
   'roblox/no-enum-merging'?: Linter.RuleEntry<[]>
   /**
-   * Bans using `export =` on a let variable
-   * @see no-export-assignment-let
+   * Disallow using `export =` on a let variable
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-export-assignment-let/documentation.md
    */
   'roblox/no-export-assignment-let'?: Linter.RuleEntry<[]>
   /**
-   * Disallows iterating with a for-in loop
-   * @see no-for-in
+   * Disallow iterating with a for-in loop
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-for-in/documentation.md
    */
   'roblox/no-for-in'?: Linter.RuleEntry<[]>
   /**
-   * Bans function expression names
-   * @see no-function-expression-id
+   * Disallow the use of function expression names
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-function-expression-name/documentation.md
    */
-  'roblox/no-function-expression-id'?: Linter.RuleEntry<[]>
+  'roblox/no-function-expression-name'?: Linter.RuleEntry<[]>
   /**
-   * Disallows getters and setters
-   * @see no-getters-or-setters
+   * Disallow getters and setters
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-get-set/documentation.md
    */
-  'roblox/no-getters-or-setters'?: Linter.RuleEntry<[]>
+  'roblox/no-get-set'?: Linter.RuleEntry<[]>
   /**
-   * Bans globalThis from being used
-   * @see no-global-this
+   * Disallow the use of Luau reserved keywords as identifiers
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-invalid-identifier/documentation.md
    */
-  'roblox/no-global-this'?: Linter.RuleEntry<[]>
+  'roblox/no-invalid-identifier'?: Linter.RuleEntry<[]>
   /**
-   * Bans namespace declaration merging
-   * @see no-namespace-merging
+   * Disallow merging namespace declarations
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-namespace-merging/documentation.md
    */
   'roblox/no-namespace-merging'?: Linter.RuleEntry<[]>
   /**
-   * Bans null from being used
-   * @see no-null
+   * Disallow usage of the `null` keyword
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-null/documentation.md
    */
   'roblox/no-null'?: Linter.RuleEntry<[]>
   /**
-   * Bans math operators from being used on data types
-   * @see no-object-math
+   * Disallow using objects in mathematical operations
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-object-math/documentation.md
    */
   'roblox/no-object-math'?: Linter.RuleEntry<[]>
   /**
-   * Bans spread elements not last in a list of arguments from being used
-   * @see no-preceding-spread-element
+   * Disallow .new() on objects without a .new() method
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-post-fix-new/documentation.md
    */
-  'roblox/no-preceding-spread-element'?: Linter.RuleEntry<[]>
+  'roblox/no-post-fix-new'?: Linter.RuleEntry<[]>
   /**
-   * Bans private identifiers from being used
-   * @see no-private-identifier
+   * Disallow spread elements not last in a list of arguments
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-preceding-spread-element/documentation.md
    */
-  'roblox/no-private-identifier'?: Linter.RuleEntry<[]>
+  'roblox/no-preceding-spread-element'?: Linter.RuleEntry<[]>
   /**
-   * Bans prototype from being used
-   * @see no-prototype
+   * Disallow the use of private identifiers (`#`)
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-private-identifier/documentation.md
    */
-  'roblox/no-prototype'?: Linter.RuleEntry<[]>
+  'roblox/no-private-identifier'?: Linter.RuleEntry<[]>
   /**
-   * Bans calling .new() on Roblox objects (helps transition to TS)
-   * @see no-rbx-postfix-new
+   * Disallow unsupported syntax in roblox-ts
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-unsupported-syntax/documentation.md
    */
-  'roblox/no-rbx-postfix-new'?: Linter.RuleEntry<[]>
+  'roblox/no-unsupported-syntax'?: Linter.RuleEntry<[]>
   /**
-   * Disallows the regex operator
-   * @see no-regex
+   * Disallow using `typeof` to check for value types
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/no-value-typeof/documentation.md
    */
-  'roblox/no-regex'?: Linter.RuleEntry<[]>
+  'roblox/no-value-typeof'?: Linter.RuleEntry<[]>
   /**
-   * Bans spread destructuring from being used
-   * @see no-spread-destructuring
+   * Enforce use of task library alternatives
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/prefer-task-library/documentation.md
    */
-  'roblox/no-spread-destructuring'?: Linter.RuleEntry<[]>
+  'roblox/prefer-task-library'?: Linter.RuleEntry<[]>
   /**
-   * Disallows the typeof operator for values
-   * @see no-value-typeof
+   * Enforce use of .size() instead of .length or .size property
+   * @see https://github.com/christopher-buss/eslint-plugin-roblox-ts-x/tree/main/src/rules/size-method/documentation.md
    */
-  'roblox/no-value-typeof'?: Linter.RuleEntry<[]>
+  'roblox/size-method'?: Linter.RuleEntry<[]>
   /**
    * Require or disallow semicolons instead of ASI
    * @see https://eslint.org/docs/latest/rules/semi
@@ -5905,6 +5905,11 @@ interface RuleOptions {
    * @see https://typescript-eslint.io/rules/no-unnecessary-type-constraint
    */
   'ts/no-unnecessary-type-constraint'?: Linter.RuleEntry<[]>
+  /**
+   * Disallow conversion idioms when they do not change the type or value of the expression
+   * @see https://typescript-eslint.io/rules/no-unnecessary-type-conversion
+   */
+  'ts/no-unnecessary-type-conversion'?: Linter.RuleEntry<[]>
   /**
    * Disallow type parameters that aren't used multiple times
    * @see https://typescript-eslint.io/rules/no-unnecessary-type-parameters
@@ -6166,6 +6171,7 @@ interface RuleOptions {
   /**
    * Require type annotations in certain places
    * @see https://typescript-eslint.io/rules/typedef
+   * @deprecated
    */
   'ts/typedef'?: Linter.RuleEntry<TsTypedef>
   /**
@@ -11710,6 +11716,11 @@ type RequireUnicodeRegexp = []|[{
 }]
 // ----- rest-spread-spacing -----
 type RestSpreadSpacing = []|[("always" | "never")]
+// ----- roblox/no-any -----
+type RobloxNoAny = []|[{
+  
+  fixToUnknown?: boolean
+}]
 // ----- semi -----
 type Semi = ([]|["never"]|["never", {
   beforeStatementContinuationChars?: ("always" | "any" | "never")
@@ -14247,6 +14258,8 @@ type TsOnlyThrowError = []|[{
     package: string
   })[]
   
+  allowRethrowing?: boolean
+  
   allowThrowingAny?: boolean
   
   allowThrowingUnknown?: boolean
@@ -14976,7 +14989,7 @@ type Yoda = []|[("always" | "never")]|[("always" | "never"), {
   onlyEquality?: boolean
 }]
 // Names of all the configs
-type ConfigNames = 'style/eslint/comments' | 'style/formatters/setup' | 'style/ignores' | 'style/imports' | 'style/import-sort' | 'style/imports/game' | 'style/jsdoc' | 'style/jsonc/setup' | 'style/jsonc/rules' | 'style/markdown/setup' | 'style/markdown/processor' | 'style/markdown/parser' | 'style/markdown/disables' | 'style/package-json' | 'style/perfectionist' | 'style/pnpm/package-json' | 'style/pnpm/pnpm-workspace-yaml' | 'style/prettier' | 'style/promise' | 'style/react/setup' | 'style/react/rules' | 'style/roblox' | 'style/shopify' | 'style/sonarjs' | 'style/sort-tsconfig' | 'style/spelling' | 'style/stylistic' | 'style/test/setup' | 'style/test/rules' | 'style/typescript/setup' | 'style/typescript/rules' | 'style/unicorn' | 'style/yaml:setup' | 'style/yaml/rules'
+type ConfigNames = 'style/eslint/comments' | 'style/formatters/setup' | 'style/ignores' | 'style/imports' | 'style/import-sort' | 'style/imports/game' | 'style/javascript/setup' | 'style/javascript/rules' | 'style/jsdoc' | 'style/jsonc/setup' | 'style/jsonc/rules' | 'style/markdown/setup' | 'style/markdown/processor' | 'style/markdown/parser' | 'style/markdown/disables' | 'style/package-json' | 'style/perfectionist' | 'style/pnpm/package-json' | 'style/pnpm/pnpm-workspace-yaml' | 'style/prettier' | 'style/promise' | 'style/react/setup' | 'style/react/rules' | 'style/react/type-aware-rules' | 'style/roblox' | 'style/shopify' | 'style/sonarjs' | 'style/sort-tsconfig' | 'style/spelling' | 'style/stylistic' | 'style/test/setup' | 'style/test/rules' | 'style/typescript/setup' | 'style/typescript/parser' | 'style/typescript/type-aware-parser' | 'style/typescript/rules' | 'style/unicorn' | 'style/yaml:setup' | 'style/yaml/rules'
 
 type Awaitable<T> = Promise<T> | T;
 interface JsDocOptions {
@@ -15203,7 +15216,7 @@ interface OptionsTypeScriptParserOptions {
     /**
      * Glob patterns for files that should not be type aware.
      *
-     * @default \["**\/*.md\/**", "**\/*.astro/*.ts"]
+     * @default \["**\/*.md\/**"]
      */
     ignoresTypeAware?: Array<string>;
     /** Additional parser options for TypeScript. */
@@ -15211,11 +15224,19 @@ interface OptionsTypeScriptParserOptions {
 }
 interface OptionsTypeScriptWithTypes {
     /**
-     * When this options is provided, type aware rules will be enabled.
+     * Provide a path to the TypeScript configuration file to use a different
+     * default to 'tsconfig.json'.
      *
      * @see https://typescript-eslint.io/linting/typed-linting/
      */
-    tsconfigPath?: Array<string> | string;
+    tsconfigPath?: string;
+    /**
+     * Enable Type-Aware linting.
+     *
+     * @default true
+     * @see https://typescript-eslint.io/linting/typed-linting/
+     */
+    typeAware?: boolean;
 }
 interface PerfectionistConfig {
     customClassGroups?: Array<string>;
@@ -15251,6 +15272,8 @@ declare function ignores(): Promise<Array<TypedFlatConfigItem>>;
 
 declare function imports(options?: OptionsProjectType & OptionsStylistic): Promise<Array<TypedFlatConfigItem>>;
 
+declare function javascript(options?: OptionsIsInEditor & OptionsOverrides): Promise<Array<TypedFlatConfigItem>>;
+
 declare function jsdoc(options?: JsDocOptions & OptionsProjectType & OptionsStylistic): Promise<Array<TypedFlatConfigItem>>;
 
 declare function jsonc(options?: OptionsFiles & OptionsOverrides & OptionsStylistic): Promise<Array<TypedFlatConfigItem>>;
@@ -15276,7 +15299,7 @@ declare function prettier(options?: OptionsComponentExtensions & OptionsFiles &
 
 declare function promise(): Promise<Array<TypedFlatConfigItem>>;
 
-declare function react(options?: OptionsFiles & OptionsStylistic & OptionsTypeScriptParserOptions & OptionsTypeScriptWithTypes & ReactConfig): Promise<Array<TypedFlatConfigItem>>;
+declare function react(options?: OptionsComponentExtensions & OptionsFiles & OptionsStylistic & OptionsTypeScriptParserOptions & OptionsTypeScriptWithTypes & ReactConfig): Promise<Array<TypedFlatConfigItem>>;
 
 declare function roblox(options?: OptionsComponentExtensions & OptionsFiles & OptionsOverrides & OptionsStylistic & OptionsTypeScriptParserOptions & OptionsTypeScriptWithTypes, formatLua?: boolean): Promise<Array<TypedFlatConfigItem>>;
 
@@ -15383,8 +15406,19 @@ type ResolvedOptions<T> = T extends boolean ? never : NonNullable<T>;
  * @returns The combined array.
  */
 declare function combine(...configs: Array<Awaitable<Array<TypedFlatConfigItem> | TypedFlatConfigItem>>): Promise<Array<TypedFlatConfigItem>>;
+declare function createTsParser(options: {
+    componentExtensions?: Array<string>;
+    configName: string;
+    files: Array<string>;
+    ignores?: Array<string>;
+    parser: any;
+    parserOptions?: any;
+    tsconfigPath?: string;
+    typeAware: boolean;
+}): TypedFlatConfigItem;
 declare function ensurePackages(packages: Array<string | undefined>): Promise<void>;
 declare function getOverrides<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): any;
+declare function getTsConfig(tsconfigPath?: string): string | undefined;
 declare function interopDefault<T>(dynamicImport: Awaitable<T>): Promise<T extends {
     default: infer U;
 } ? U : T>;
@@ -15438,4 +15472,4 @@ declare function renameRules(rules: Record<string, any>, map: Record<string, str
 declare function resolveSubOptions<K extends keyof OptionsConfig>(options: OptionsConfig, key: K): ResolvedOptions<OptionsConfig[K]>;
 declare function toArray<T>(value: Array<T> | T): Array<T>;
 
-export { type Awaitable, type ConfigNames, GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LUA, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_YAML, type JsDocOptions, type OptionsComponentExtensions, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsProjectType, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type PerfectionistConfig, type ReactConfig, type ResolvedOptions, type Rules, type SpellCheckConfig, type StylisticConfig, StylisticConfigDefaults, type TypedFlatConfigItem, combine, comments, style as default, defaultPluginRenaming, disables, ensurePackages, formatters, getOverrides, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, jsdoc, jsonc, markdown, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, resolveSubOptions, roblox, shopify, sonarjs, sortTsconfig, spelling, style, stylistic, toArray, toml, typescript, unicorn, yaml };
+export { type Awaitable, type ConfigNames, GLOB_ALL_SRC, GLOB_CSS, GLOB_DTS, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_LUA, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_MARKDOWN_IN_MARKDOWN, GLOB_POSTCSS, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSX, GLOB_YAML, type JsDocOptions, type OptionsComponentExtensions, type OptionsConfig, type OptionsFiles, type OptionsFormatters, type OptionsHasTypeScript, type OptionsIsInEditor, type OptionsOverrides, type OptionsProjectType, type OptionsStylistic, type OptionsTypeScriptParserOptions, type OptionsTypeScriptWithTypes, type OptionsTypescript, type PerfectionistConfig, type ReactConfig, type ResolvedOptions, type Rules, type SpellCheckConfig, type StylisticConfig, StylisticConfigDefaults, type TypedFlatConfigItem, combine, comments, createTsParser, style as default, defaultPluginRenaming, disables, ensurePackages, formatters, getOverrides, getTsConfig, ignores, imports, interopDefault, isInEditorEnvironment, isInGitHooksOrLintStaged, javascript, jsdoc, jsonc, markdown, packageJson, parserPlain, perfectionist, pnpm, prettier, promise, react, renamePluginInConfigs, renameRules, resolveSubOptions, roblox, shopify, sonarjs, sortTsconfig, spelling, style, stylistic, toArray, toml, typescript, unicorn, yaml };