Nov 17, 2024 · Nov 16, 2024 · Nov 16, 2024 · Nov 16, 2024 · Nov 16, 2024 · Nov 17, 2024
diff --git a/packages/eslint-plugin/src/rules/consistent-return.ts b/packages/eslint-plugin/src/rules/consistent-return.ts
  | TSESTree.FunctionDeclaration
  | TSESTree.FunctionExpression;

 const defaultOptions: Options = [{ treatUndefinedAsUnspecified: false }];
 export default createRule<Options, MessageIds>({
  name: 'consistent-return',
  meta: {
    type: 'suggestion',
    defaultOptions,
    docs: {
      description:
        'Require `return` statements to either always or never specify values',
    messages: baseRule.meta.messages,
    schema: baseRule.meta.schema,
  },
  defaultOptions: [{ treatUndefinedAsUnspecified: false }],
  defaultOptions,
  create(context, [options]) {
    const services = getParserServices(context);
    const checker = services.program.getTypeChecker();
diff --git a/packages/eslint-plugin/src/rules/dot-notation.ts b/packages/eslint-plugin/src/rules/dot-notation.ts
 export type Options = InferOptionsTypeFromRule<typeof baseRule>;
 export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

 const defaultOptions: Options = [
  {
    allowIndexSignaturePropertyAccess: false,
    allowKeywords: true,
    allowPattern: '',
    allowPrivateClassPropertyAccess: false,
    allowProtectedClassPropertyAccess: false,
  },
 ];

 export default createRule<Options, MessageIds>({
  name: 'dot-notation',
  meta: {
    type: 'suggestion',
    defaultOptions,
    docs: {
      description: 'Enforce dot notation whenever possible',
      extendsBaseRule: true,
      },
    ],
  },
  defaultOptions: [
    {
      allowIndexSignaturePropertyAccess: false,
      allowKeywords: true,
      allowPattern: '',
      allowPrivateClassPropertyAccess: false,
      allowProtectedClassPropertyAccess: false,
    },
  ],
  defaultOptions,
  create(context, [options]) {
    const rules = baseRule.create(context);
    const services = getParserServices(context);
diff --git a/packages/eslint-plugin/src/rules/init-declarations.ts b/packages/eslint-plugin/src/rules/init-declarations.ts
  name: 'init-declarations',
  meta: {
    type: 'suggestion',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description:
        'Require or disallow initialization in variable declarations',
diff --git a/packages/eslint-plugin/src/rules/max-params.ts b/packages/eslint-plugin/src/rules/max-params.ts
  name: 'max-params',
  meta: {
    type: 'suggestion',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description:
        'Enforce a maximum number of parameters in function definitions',
diff --git a/packages/eslint-plugin/src/rules/no-dupe-class-members.ts b/packages/eslint-plugin/src/rules/no-dupe-class-members.ts
  name: 'no-dupe-class-members',
  meta: {
    type: 'problem',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description: 'Disallow duplicate class members',
      extendsBaseRule: true,
diff --git a/packages/eslint-plugin/src/rules/no-empty-function.ts b/packages/eslint-plugin/src/rules/no-empty-function.ts
 type Options = InferOptionsTypeFromRule<typeof baseRule>;
 type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

 const defaultOptions: Options = [
  {
    allow: [],
  },
 ];

 const schema = deepMerge(
  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- https://github.com/microsoft/TypeScript/issues/17002
  Array.isArray(baseRule.meta.schema)
  name: 'no-empty-function',
  meta: {
    type: 'suggestion',
    defaultOptions,
    docs: {
      description: 'Disallow empty functions',
      extendsBaseRule: true,
    messages: baseRule.meta.messages,
    schema: [schema],
  },
  defaultOptions: [
    {
      allow: [],
    },
  ],
  defaultOptions,
  create(context, [{ allow = [] }]) {
    const rules = baseRule.create(context);

diff --git a/packages/eslint-plugin/src/rules/no-invalid-this.ts b/packages/eslint-plugin/src/rules/no-invalid-this.ts
 export type Options = InferOptionsTypeFromRule<typeof baseRule>;
 export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

 const defaultOptions: Options = [{ capIsConstructor: true }];

 export default createRule<Options, MessageIds>({
  name: 'no-invalid-this',
  meta: {
    type: 'suggestion',
    defaultOptions,
    docs: {
      description:
        'Disallow `this` keywords outside of classes or class-like objects',
    messages: baseRule.meta.messages,
    schema: baseRule.meta.schema,
  },
  defaultOptions: [{ capIsConstructor: true }],
  defaultOptions,
  create(context) {
    const rules = baseRule.create(context);

diff --git a/packages/eslint-plugin/src/rules/no-loop-func.ts b/packages/eslint-plugin/src/rules/no-loop-func.ts
  name: 'no-loop-func',
  meta: {
    type: 'suggestion',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description:
        'Disallow function declarations that contain unsafe references inside loop statements',
diff --git a/packages/eslint-plugin/src/rules/no-loss-of-precision.ts b/packages/eslint-plugin/src/rules/no-loss-of-precision.ts
  name: 'no-loss-of-precision',
  meta: {
    type: 'problem',
    // defaultOptions, -- base rule does not use defaultOptions
    deprecated: true,
    docs: {
      description: 'Disallow literal numbers that lose precision',
diff --git a/packages/eslint-plugin/src/rules/no-magic-numbers.ts b/packages/eslint-plugin/src/rules/no-magic-numbers.ts
  name: 'no-magic-numbers',
  meta: {
    type: 'suggestion',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description: 'Disallow magic numbers',
      extendsBaseRule: true,
diff --git a/packages/eslint-plugin/src/rules/no-restricted-imports.ts b/packages/eslint-plugin/src/rules/no-restricted-imports.ts
  name: 'no-restricted-imports',
  meta: {
    type: 'suggestion',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description: 'Disallow specified modules when loaded by `import`',
      extendsBaseRule: true,
diff --git a/packages/eslint-plugin/src/rules/no-unused-expressions.ts b/packages/eslint-plugin/src/rules/no-unused-expressions.ts
 type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;
 type Options = InferOptionsTypeFromRule<typeof baseRule>;

 const defaultOptions: Options = [
  {
    allowShortCircuit: false,
    allowTaggedTemplates: false,
    allowTernary: false,
  },
 ];

 export default createRule<Options, MessageIds>({
  name: 'no-unused-expressions',
  meta: {
    type: 'suggestion',
    defaultOptions,
    docs: {
      description: 'Disallow unused expressions',
      extendsBaseRule: true,
    messages: baseRule.meta.messages,
    schema: baseRule.meta.schema,
  },
  defaultOptions: [
    {
      allowShortCircuit: false,
      allowTaggedTemplates: false,
      allowTernary: false,
    },
  ],
  defaultOptions,
  create(context, [{ allowShortCircuit = false, allowTernary = false }]) {
    const rules = baseRule.create(context);

diff --git a/packages/eslint-plugin/src/rules/no-useless-constructor.ts b/packages/eslint-plugin/src/rules/no-useless-constructor.ts
  name: 'no-useless-constructor',
  meta: {
    type: 'problem',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description: 'Disallow unnecessary constructors',
      extendsBaseRule: true,
diff --git a/packages/eslint-plugin/src/rules/prefer-destructuring.ts b/packages/eslint-plugin/src/rules/prefer-destructuring.ts
  name: 'prefer-destructuring',
  meta: {
    type: 'suggestion',
    // defaultOptions, -- base rule does not use defaultOptions
    docs: {
      description: 'Require destructuring from arrays and/or objects',
      extendsBaseRule: true,
diff --git a/packages/utils/src/eslint-utils/RuleCreator.ts b/packages/utils/src/eslint-utils/RuleCreator.ts
 export type NamedCreateRuleMeta<
  MessageIds extends string,
  PluginDocs = unknown,
  Options extends readonly unknown[] = [],
 > = {
  docs: PluginDocs & RuleMetaDataDocs;
 } & Omit<RuleMetaData<MessageIds, PluginDocs>, 'docs'>;
 } & Omit<RuleMetaData<MessageIds, PluginDocs, Options>, 'docs'>;

 export interface RuleCreateAndOptions<
  Options extends readonly unknown[],
  MessageIds extends string,
  Docs = unknown,
 > extends RuleCreateAndOptions<Options, MessageIds> {
  meta: RuleMetaData<MessageIds, Docs>;
  meta: RuleMetaData<MessageIds, Docs, Options>;
 }

 export interface RuleWithMetaAndName<
  Options extends readonly unknown[],
  MessageIds extends string,
  Docs = unknown,
 > extends RuleCreateAndOptions<Options, MessageIds> {
  meta: NamedCreateRuleMeta<MessageIds, Docs>;
  meta: NamedCreateRuleMeta<MessageIds, Docs, Options>;
  name: string;
 }

diff --git a/packages/utils/src/ts-eslint/Rule.ts b/packages/utils/src/ts-eslint/Rule.ts
  url?: string;
 }

 export interface RuleMetaData<MessageIds extends string, PluginDocs = unknown> {
 export interface RuleMetaData<
  MessageIds extends string,
  PluginDocs = unknown,
  Options extends readonly unknown[] = [],
 > {
  /**
   * True if the rule is deprecated, false otherwise
   */
   * - `"layout"` means the rule cares primarily about whitespace, semicolons, commas, and parentheses, all the parts of the program that determine how the code looks rather than how it executes. These rules work on parts of the code that aren’t specified in the AST.
   */
  type: 'layout' | 'problem' | 'suggestion';

  /**
   * Specifies default options for the rule. If present, any user-provided options in their config will be merged on top of them recursively.
   * This merging will be applied directly to `context.options`.
   * If you want backwards-compatible support for earlier ESLint version; consider using the top-level `defaultOptions` instead.
   *
   * since ESLint 9.15.0
   */
  defaultOptions?: Options;
 }

 export interface RuleMetaDataWithDocs<
  MessageIds extends string,
  PluginDocs = unknown,
 > extends RuleMetaData<MessageIds, PluginDocs> {
  Options extends readonly unknown[] = [],
 > extends RuleMetaData<MessageIds, PluginDocs, Options> {
  /**
   * Documentation for the rule
   */
  /**
   * Metadata about the rule
   */
  meta: RuleMetaData<MessageIds, Docs>;
  meta: RuleMetaData<MessageIds, Docs, Options>;
 }

 export type AnyRuleModule = RuleModule<string, readonly unknown[]>;
  /**
   * Metadata about the rule
   */
  meta: RuleMetaDataWithDocs<MessageIds, Docs>;
  meta: RuleMetaDataWithDocs<MessageIds, Docs, Options>;
 }

 export type AnyRuleModuleWithMetaDocs = RuleModuleWithMetaDocs<
Original file line number	Diff line number	Diff line change
Expand Up		@@ -21,10 +21,12 @@ type FunctionNode =
		\| TSESTree.FunctionDeclaration
		\| TSESTree.FunctionExpression;

		const defaultOptions: Options = [{ treatUndefinedAsUnspecified: false }];
		export default createRule<Options, MessageIds>({
		name: 'consistent-return',
		meta: {
		type: 'suggestion',
		defaultOptions,
		docs: {
		description:
		'Require `return` statements to either always or never specify values',
Expand All		@@ -35,7 +37,7 @@ export default createRule<Options, MessageIds>({
		messages: baseRule.meta.messages,
		schema: baseRule.meta.schema,
		},
		defaultOptions: [{ treatUndefinedAsUnspecified: false }],
		defaultOptions,
		create(context, [options]) {
		const services = getParserServices(context);
		const checker = services.program.getTypeChecker();
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -17,10 +17,21 @@ const baseRule = getESLintCoreRule('dot-notation');
		export type Options = InferOptionsTypeFromRule<typeof baseRule>;
		export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

		const defaultOptions: Options = [
		{
		allowIndexSignaturePropertyAccess: false,
		allowKeywords: true,
		allowPattern: '',
		allowPrivateClassPropertyAccess: false,
		allowProtectedClassPropertyAccess: false,
		},
		];

		export default createRule<Options, MessageIds>({
		name: 'dot-notation',
		meta: {
		type: 'suggestion',
		defaultOptions,
		docs: {
		description: 'Enforce dot notation whenever possible',
		extendsBaseRule: true,
Expand DownExpand Up		@@ -67,15 +78,7 @@ export default createRule<Options, MessageIds>({
		},
		],
		},
		defaultOptions: [
		{
		allowIndexSignaturePropertyAccess: false,
		allowKeywords: true,
		allowPattern: '',
		allowPrivateClassPropertyAccess: false,
		allowProtectedClassPropertyAccess: false,
		},
		],
		defaultOptions,
		create(context, [options]) {
		const rules = baseRule.create(context);
		const services = getParserServices(context);
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,6 +19,7 @@ export default createRule<Options, MessageIds>({
		name: 'init-declarations',
		meta: {
		type: 'suggestion',
		// defaultOptions, -- base rule does not use defaultOptions
		docs: {
		description:
		'Require or disallow initialization in variable declarations',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,6 +26,7 @@ export default createRule<Options, MessageIds>({
		name: 'max-params',
		meta: {
		type: 'suggestion',
		// defaultOptions, -- base rule does not use defaultOptions
		docs: {
		description:
		'Enforce a maximum number of parameters in function definitions',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,6 +19,7 @@ export default createRule<Options, MessageIds>({
		name: 'no-dupe-class-members',
		meta: {
		type: 'problem',
		// defaultOptions, -- base rule does not use defaultOptions
		docs: {
		description: 'Disallow duplicate class members',
		extendsBaseRule: true,
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,6 +16,12 @@ const baseRule = getESLintCoreRule('no-empty-function');
		type Options = InferOptionsTypeFromRule<typeof baseRule>;
		type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

		const defaultOptions: Options = [
		{
		allow: [],
		},
		];

		const schema = deepMerge(
		// eslint-disable-next-line @typescript-eslint/no-unsafe-argument -- https://github.com/microsoft/TypeScript/issues/17002
		Array.isArray(baseRule.meta.schema)
Expand DownExpand Up		@@ -54,6 +60,7 @@ export default createRule<Options, MessageIds>({
		name: 'no-empty-function',
		meta: {
		type: 'suggestion',
		defaultOptions,
		docs: {
		description: 'Disallow empty functions',
		extendsBaseRule: true,
Expand All		@@ -63,11 +70,7 @@ export default createRule<Options, MessageIds>({
		messages: baseRule.meta.messages,
		schema: [schema],
		},
		defaultOptions: [
		{
		allow: [],
		},
		],
		defaultOptions,
		create(context, [{ allow = [] }]) {
		const rules = baseRule.create(context);

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,10 +15,13 @@ const baseRule = getESLintCoreRule('no-invalid-this');
		export type Options = InferOptionsTypeFromRule<typeof baseRule>;
		export type MessageIds = InferMessageIdsTypeFromRule<typeof baseRule>;

		const defaultOptions: Options = [{ capIsConstructor: true }];

		export default createRule<Options, MessageIds>({
		name: 'no-invalid-this',
		meta: {
		type: 'suggestion',
		defaultOptions,
		docs: {
		description:
		'Disallow `this` keywords outside of classes or class-like objects',
Expand All		@@ -28,7 +31,7 @@ export default createRule<Options, MessageIds>({
		messages: baseRule.meta.messages,
		schema: baseRule.meta.schema,
		},
		defaultOptions: [{ capIsConstructor: true }],
		defaultOptions,
		create(context) {
		const rules = baseRule.create(context);

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -19,6 +19,7 @@ export default createRule<Options, MessageIds>({
		name: 'no-loop-func',
		meta: {
		type: 'suggestion',
		// defaultOptions, -- base rule does not use defaultOptions
		docs: {
		description:
		'Disallow function declarations that contain unsafe references inside loop statements',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,6 +15,7 @@ export default createRule<Options, MessageIds>({
		name: 'no-loss-of-precision',
		meta: {
		type: 'problem',
		// defaultOptions, -- base rule does not use defaultOptions
		deprecated: true,
		docs: {
		description: 'Disallow literal numbers that lose precision',
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -49,6 +49,7 @@ export default createRule<Options, MessageIds>({
		name: 'no-magic-numbers',
		meta: {
		type: 'suggestion',
		// defaultOptions, -- base rule does not use defaultOptions
		docs: {
		description: 'Disallow magic numbers',
		extendsBaseRule: true,
Expand Down