Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion plugins/typescript/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
"openapi3-ts": "^4.4.0",
"pluralize": "^8.0.0",
"tslib": "^2.3.1",
"tsutils": "^3.21.0",
"typescript": "4.8.2"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion plugins/typescript/src/core/schemaToEnumDeclaration.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { pascal } from "case";
import { SchemaObject } from "openapi3-ts/oas30";
import ts, { factory as f } from "typescript";
import { isValidIdentifier } from "tsutils";
import { convertNumberToWord } from "../utils/getEnumProperties";
import { isValidIdentifier } from "../utils/isValidIdentifier";
import { Context, getJSDocComment } from "./schemaToTypeAliasDeclaration";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ import {
isSchemaObject,
} from "openapi3-ts/oas30";
import { singular } from "pluralize";
import { isValidIdentifier } from "tsutils";
import ts, {
factory as f,
isIdentifierPart,
isIdentifierStart,
} from "typescript";
import { convertNumberToWord } from "../utils/getEnumProperties";
import { isValidIdentifier } from "../utils/isValidIdentifier";
import { getReferenceSchema } from "./getReference";

type RemoveIndex<T> = {
Expand Down
49 changes: 49 additions & 0 deletions plugins/typescript/src/utils/isValidIdentifier.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import { describe, expect, it } from "vitest";
import { isValidIdentifier } from "./isValidIdentifier";

describe("isValidIdentifier", () => {
it("accepts simple identifiers", () => {
expect(isValidIdentifier("foo")).toBe(true);
expect(isValidIdentifier("Foo")).toBe(true);
expect(isValidIdentifier("_foo")).toBe(true);
expect(isValidIdentifier("$foo")).toBe(true);
expect(isValidIdentifier("foo_bar123")).toBe(true);
});

it("rejects empty strings", () => {
expect(isValidIdentifier("")).toBe(false);
});

it("rejects identifiers starting with a digit", () => {
expect(isValidIdentifier("1foo")).toBe(false);
});

it("rejects identifiers containing invalid characters", () => {
expect(isValidIdentifier("foo-bar")).toBe(false);
expect(isValidIdentifier("foo bar")).toBe(false);
expect(isValidIdentifier("foo.bar")).toBe(false);
});

it("rejects reserved words", () => {
expect(isValidIdentifier("class")).toBe(false);
expect(isValidIdentifier("import")).toBe(false);
expect(isValidIdentifier("enum")).toBe(false);
expect(isValidIdentifier("true")).toBe(false);
expect(isValidIdentifier("false")).toBe(false);
});

it("accepts capitalized reserved words", () => {
expect(isValidIdentifier("Class")).toBe(true);
expect(isValidIdentifier("True")).toBe(true);
});

// Only reserved in strict mode; TypeScript's scanner still tokenizes these
// as plain identifiers, so tsutils' isValidIdentifier accepts them too.
it("accepts strict-mode-only future reserved words", () => {
expect(isValidIdentifier("let")).toBe(true);
expect(isValidIdentifier("static")).toBe(true);
expect(isValidIdentifier("private")).toBe(true);
expect(isValidIdentifier("interface")).toBe(true);
expect(isValidIdentifier("yield")).toBe(true);
});
});
45 changes: 45 additions & 0 deletions plugins/typescript/src/utils/isValidIdentifier.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**
* Avoids depending on tsutils, which resolves `typescript` at runtime via a
* peer dependency and can pick up an incompatible version (e.g. TypeScript 7).
*/
export const isValidIdentifier = (text: string): boolean =>
/^[A-Za-z_$][A-Za-z0-9_$]*$/.test(text) && !reservedWords.has(text);

const reservedWords = new Set([
"break",
"case",
"catch",
"class",
"const",
"continue",
"debugger",
"default",
"delete",
"do",
"else",
"enum",
"export",
"extends",
"false",
"finally",
"for",
"function",
"if",
"import",
"in",
"instanceof",
"new",
"null",
"return",
"super",
"switch",
"this",
"throw",
"true",
"try",
"typeof",
"var",
"void",
"while",
"with",
]);
14 changes: 0 additions & 14 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading