fix: support comments on extracted literals (#1908)

vega · Apr 8, 2024 · 9353127 · 9353127
1 parent 0020ba0
commit 9353127
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 9 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -11,7 +11,7 @@
   "editor.tabSize": 4,
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "jest.autoRun": "off"
 }
diff --git a/src/Utils/extractLiterals.ts b/src/Utils/extractLiterals.ts
@@ -6,31 +6,35 @@ import { DefinitionType } from "../Type/DefinitionType";
 import { EnumType } from "../Type/EnumType";
 import { LiteralType } from "../Type/LiteralType";
 import { UnionType } from "../Type/UnionType";
+import { derefAnnotatedType } from "./derefType";
 
 function* _extractLiterals(type: BaseType): Iterable<string> {
     if (!type) {
         return;
     }
-    if (type instanceof LiteralType) {
-        yield type.getValue().toString();
+
+    const dereffedType = derefAnnotatedType(type);
+
+    if (dereffedType instanceof LiteralType) {
+        yield dereffedType.getValue().toString();
         return;
     }
-    if (type instanceof UnionType || type instanceof EnumType) {
-        for (const t of type.getTypes()) {
+    if (dereffedType instanceof UnionType || dereffedType instanceof EnumType) {
+        for (const t of dereffedType.getTypes()) {
             yield* _extractLiterals(t);
         }
         return;
     }
-    if (type instanceof AliasType || type instanceof DefinitionType) {
-        yield* _extractLiterals(type.getType());
+    if (dereffedType instanceof AliasType || dereffedType instanceof DefinitionType) {
+        yield* _extractLiterals(dereffedType.getType());
         return;
     }
-    if (type instanceof BooleanType) {
+    if (dereffedType instanceof BooleanType) {
         yield* _extractLiterals(new UnionType([new LiteralType("true"), new LiteralType("false")]));
         return;
     }
 
-    throw new UnknownTypeError(type);
+    throw new UnknownTypeError(dereffedType);
 }
 
 export function extractLiterals(type: BaseType): string[] {

diff --git a/test/valid-data-type.test.ts b/test/valid-data-type.test.ts
@@ -148,4 +148,6 @@ describe("valid-data-type", () => {
     it("type-satisfies", assertValidSchema("type-satisfies", "MyType"));
 
     it("ignore-export", assertValidSchema("ignore-export", "*"));
+
+    it("lowercase", assertValidSchema("lowercase", "MyType"));
 });
diff --git a/test/valid-data/lowercase/main.ts b/test/valid-data/lowercase/main.ts
@@ -0,0 +1,4 @@
+/** The built-in color schemes, cased. */
+type Foo = "Accent";
+
+export type MyType = Lowercase<Foo>;
diff --git a/test/valid-data/lowercase/schema.json b/test/valid-data/lowercase/schema.json
@@ -0,0 +1,10 @@
+{
+    "$ref": "#/definitions/MyType",
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "definitions": {
+      "MyType": {
+        "const": "accent",
+        "type": "string"
+      }
+    }
+  }