fix: correct handling of additionalProperties in object schemas (#6939)

Co-authored-by: Adam Jones <domdomegg+git@gmail.com>
typescript-eslint · Apr 21, 2023 · 489c7a5 · 489c7a5
1 parent acc1a43
commit 489c7a5
Show file tree

Hide file tree

Showing 19 changed files with 23 additions and 2 deletions.
diff --git a/packages/eslint-plugin/src/rules/array-type.ts b/packages/eslint-plugin/src/rules/array-type.ts
@@ -112,6 +112,7 @@ export default util.createRule<Options, MessageIds>({
             enum: ['array', 'generic', 'array-simple'],
           },
         },
+        additionalProperties: false,
         properties: {
           default: {
             $ref: '#/items/0/$defs/arrayOption',

diff --git a/packages/eslint-plugin/src/rules/ban-ts-comment.ts b/packages/eslint-plugin/src/rules/ban-ts-comment.ts
@@ -53,6 +53,7 @@ export default util.createRule<[Options], MessageIds>({
               },
               {
                 type: 'object',
+                additionalProperties: false,
                 properties: {
                   descriptionFormat: { type: 'string' },
                 },

diff --git a/packages/eslint-plugin/src/rules/naming-convention-utils/schema.ts b/packages/eslint-plugin/src/rules/naming-convention-utils/schema.ts
@@ -40,6 +40,7 @@ const $DEFS: Record<string, JSONSchema.JSONSchema4> = {
   },
   matchRegexConfig: {
     type: 'object',
+    additionalProperties: false,
     properties: {
       match: { type: 'boolean' },
       regex: { type: 'string' },

diff --git a/packages/eslint-plugin/src/rules/no-misused-promises.ts b/packages/eslint-plugin/src/rules/no-misused-promises.ts
@@ -83,6 +83,7 @@ export default util.createRule<Options, MessageId>({
     schema: [
       {
         type: 'object',
+        additionalProperties: false,
         properties: {
           checksConditionals: {
             type: 'boolean',

diff --git a/packages/eslint-plugin/src/rules/no-unnecessary-type-assertion.ts b/packages/eslint-plugin/src/rules/no-unnecessary-type-assertion.ts
@@ -31,6 +31,7 @@ export default util.createRule<Options, MessageIds>({
     schema: [
       {
         type: 'object',
+        additionalProperties: false,
         properties: {
           typesToIgnore: {
             description: 'A list of type names to ignore.',

diff --git a/packages/eslint-plugin/src/rules/require-array-sort-compare.ts b/packages/eslint-plugin/src/rules/require-array-sort-compare.ts
@@ -30,6 +30,7 @@ export default util.createRule<Options, MessageIds>({
     schema: [
       {
         type: 'object',
+        additionalProperties: false,
         properties: {
           ignoreStringArrays: {
             description:

diff --git a/packages/eslint-plugin/src/rules/restrict-template-expressions.ts b/packages/eslint-plugin/src/rules/restrict-template-expressions.ts
@@ -33,6 +33,7 @@ export default util.createRule<Options, MessageId>({
     schema: [
       {
         type: 'object',
+        additionalProperties: false,
         properties: {
           allowNumber: {
             description:

diff --git a/packages/eslint-plugin/src/rules/sort-type-constituents.ts b/packages/eslint-plugin/src/rules/sort-type-constituents.ts
@@ -124,6 +124,7 @@ export default util.createRule<Options, MessageIds>({
     schema: [
       {
         type: 'object',
+        additionalProperties: false,
         properties: {
           checkIntersections: {
             description: 'Whether to check intersection types.',

diff --git a/packages/eslint-plugin/src/rules/typedef.ts b/packages/eslint-plugin/src/rules/typedef.ts
@@ -31,6 +31,7 @@ export default util.createRule<[Options], MessageIds>({
     schema: [
       {
         type: 'object',
+        additionalProperties: false,
         properties: {
           [OptionKeys.ArrayDestructuring]: { type: 'boolean' },
           [OptionKeys.ArrowParameter]: { type: 'boolean' },

diff --git a/packages/eslint-plugin/tests/schema-snapshots/array-type.shot b/packages/eslint-plugin/tests/schema-snapshots/array-type.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/ban-ts-comment.shot b/packages/eslint-plugin/tests/schema-snapshots/ban-ts-comment.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/naming-convention.shot b/packages/eslint-plugin/tests/schema-snapshots/naming-convention.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/no-misused-promises.shot b/packages/eslint-plugin/tests/schema-snapshots/no-misused-promises.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/no-unnecessary-type-assertion.shot b/packages/eslint-plugin/tests/schema-snapshots/no-unnecessary-type-assertion.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/require-array-sort-compare.shot b/packages/eslint-plugin/tests/schema-snapshots/require-array-sort-compare.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/restrict-template-expressions.shot b/packages/eslint-plugin/tests/schema-snapshots/restrict-template-expressions.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/sort-type-constituents.shot b/packages/eslint-plugin/tests/schema-snapshots/sort-type-constituents.shot
diff --git a/packages/eslint-plugin/tests/schema-snapshots/typedef.shot b/packages/eslint-plugin/tests/schema-snapshots/typedef.shot
diff --git a/packages/rule-schema-to-typescript-types/src/generateObjectType.ts b/packages/rule-schema-to-typescript-types/src/generateObjectType.ts
@@ -13,13 +13,16 @@ export function generateObjectType(
   const commentLines = getCommentLines(schema);
 
   let indexSignature: AST | null = null;
-  if (schema.additionalProperties === true) {
+  if (
+    schema.additionalProperties === true ||
+    schema.additionalProperties === undefined
+  ) {
     indexSignature = {
       type: 'type-reference',
       typeName: 'unknown',
       commentLines: [],
     };
-  } else if (schema.additionalProperties) {
+  } else if (typeof schema.additionalProperties === 'object') {
     const indexSigType = generateType(schema.additionalProperties, refMap);
     indexSignature = indexSigType;
   }