-
Notifications
You must be signed in to change notification settings - Fork 17
feat: Completely remove TypeScript AST dependency and migrate to string-based code generation #141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
51bf050
refactor(CodeGenerator): remove unused typescript import and simplify…
Himenon 7bd98ab
refactor(TsGenerator): simplify code generation to use string arrays …
Himenon 3656f01
refactor(factory): delete all individual TypeScript AST node factory …
Himenon d78e7f5
refactor: replace typescript AST types with string return types acros…
Himenon 04f3144
refactor: replace TypeScript AST types with string return types acros…
Himenon 845c902
test: update snapshots to include generator version v1.1.0
Himenon 4e66438
test(argo-rollout-test): update snapshot with formatting and version …
Himenon 504d3d6
chore(package.json): remove typescript peer dependency
Himenon cdbd6d5
test(PathParameter): add explicit vitest imports
Himenon f298063
chore(.dependency-cruiser.cjs): expand test file exclusion patterns t…
Himenon 2f56deb
fix: escape double quotes in generated string literals and enum values
Himenon 1f5212b
fix: snapshot差分をzeroにする修正 1
Himenon f309629
feat: change tsc scope
Himenon 43f03a8
feat: update snapshot
Himenon 95fe90a
feat: update readme
Himenon 8cd378a
refactor: index.ts to factory.ts
Himenon 1e2705b
refactor: remove ast api I/F
Himenon ccdeaac
test: add test code
Himenon 38e9e8b
Merge branch 'main' of https://github.com/Himenon/openapi-typescript-…
Himenon 8621632
fix: confilict
Himenon c83989c
feat: remove factory directory
Himenon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -33,6 +33,7 @@ jobs: | |
| - name: Test & Build | ||
| run: | | ||
| pnpm build | ||
| pnpm type-check | ||
| pnpm test:code:gen | ||
| pnpm test | ||
| env: | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 23 additions & 68 deletions
91
src/code-templates/_shared/MethodBody/__tests__/PathParameter-test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,134 +1,89 @@ | ||
| import ts from "typescript"; | ||
| import { describe, expect, test } from "vitest"; | ||
|
|
||
| import { TsGenerator } from "../../../../api"; | ||
| import type { CodeGenerator } from "../../../../types"; | ||
| import * as Utils from "../../utils"; | ||
| import * as PathParameter from "../PathParameter"; | ||
|
|
||
| const EOL = "\n"; | ||
|
|
||
| const traverse = | ||
| (expression: ts.Expression) => | ||
| <T extends ts.Node>(context: Pick<ts.TransformationContext, "factory">) => | ||
| (rootNode: T) => { | ||
| const visit = (node: ts.Node): ts.Node => { | ||
| if (!ts.isSourceFile(node)) { | ||
| return node; | ||
| } | ||
| return context.factory.updateSourceFile( | ||
| node, | ||
| [ts.factory.createExpressionStatement(expression)], | ||
| node.isDeclarationFile, | ||
| node.referencedFiles, | ||
| node.typeReferenceDirectives, | ||
| node.hasNoDefaultLib, | ||
| node.libReferenceDirectives, | ||
| ); | ||
| }; | ||
| return ts.visitNode(rootNode, visit); | ||
| }; | ||
|
|
||
| const getText = (expression: ts.Expression) => { | ||
| const source = ts.createSourceFile("", "", ts.ScriptTarget.ESNext); | ||
| const result = ts.transform(source, [traverse(expression)]); | ||
| result.dispose(); | ||
|
|
||
| const printer = ts.createPrinter(); // AST -> TypeScriptに変換 | ||
| return printer.printFile(result.transformed[0] as any); | ||
| }; | ||
|
|
||
| describe("PathParameter Test", () => { | ||
| const factory = TsGenerator.Factory.create(); | ||
| const generate = (url: string, pathParameter: CodeGenerator.PickedParameter[]): string => { | ||
| const urlTemplates = PathParameter.generateUrlTemplateExpression(factory, url, pathParameter); | ||
| const expression = Utils.generateTemplateExpression(factory, urlTemplates); | ||
| return getText(expression); | ||
| return Utils.generateTemplateExpression(factory, urlTemplates); | ||
| }; | ||
| test("generateUrlTemplateExpression", () => { | ||
| expect(generate("/{a}", [{ in: "path", name: "a", required: true }])).toEqual(`\`/\${encodeURIComponent(params.parameter.a)}\`;${EOL}`); | ||
| expect(generate("/{a}/", [{ in: "path", name: "a", required: true }])).toEqual(`\`/\${encodeURIComponent(params.parameter.a)}/\`;${EOL}`); | ||
| expect(generate("/a/{b}", [{ in: "path", name: "b", required: true }])).toEqual(`\`/a/\${encodeURIComponent(params.parameter.b)}\`;${EOL}`); | ||
| expect(generate("/a/{b}/", [{ in: "path", name: "b", required: true }])).toEqual( | ||
| `\`/a/\${encodeURIComponent(params.parameter.b)}/\`;${EOL}`, | ||
| ); | ||
| expect(generate("/a/{b}/c", [{ in: "path", name: "b", required: true }])).toEqual( | ||
| `\`/a/\${encodeURIComponent(params.parameter.b)}/c\`;${EOL}`, | ||
| ); | ||
| expect(generate("/a/{b}/c/", [{ in: "path", name: "b", required: true }])).toEqual( | ||
| `\`/a/\${encodeURIComponent(params.parameter.b)}/c/\`;${EOL}`, | ||
| ); | ||
| expect(generate("/a/b/{c}", [{ in: "path", name: "c", required: true }])).toEqual( | ||
| `\`/a/b/\${encodeURIComponent(params.parameter.c)}\`;${EOL}`, | ||
| ); | ||
| expect(generate("/a/b/{c}", [{ in: "path", name: "c", required: true }])).toEqual( | ||
| `\`/a/b/\${encodeURIComponent(params.parameter.c)}\`;${EOL}`, | ||
| ); | ||
| expect(generate("/a/b/{c}/", [{ in: "path", name: "c", required: true }])).toEqual( | ||
| `\`/a/b/\${encodeURIComponent(params.parameter.c)}/\`;${EOL}`, | ||
| ); | ||
| expect(generate("/{a}", [{ in: "path", name: "a", required: true }])).toEqual(`\`/\${encodeURIComponent(params.parameter.a)}\``); | ||
| expect(generate("/{a}/", [{ in: "path", name: "a", required: true }])).toEqual(`\`/\${encodeURIComponent(params.parameter.a)}/\``); | ||
| expect(generate("/a/{b}", [{ in: "path", name: "b", required: true }])).toEqual(`\`/a/\${encodeURIComponent(params.parameter.b)}\``); | ||
| expect(generate("/a/{b}/", [{ in: "path", name: "b", required: true }])).toEqual(`\`/a/\${encodeURIComponent(params.parameter.b)}/\``); | ||
| expect(generate("/a/{b}/c", [{ in: "path", name: "b", required: true }])).toEqual(`\`/a/\${encodeURIComponent(params.parameter.b)}/c\``); | ||
| expect(generate("/a/{b}/c/", [{ in: "path", name: "b", required: true }])).toEqual(`\`/a/\${encodeURIComponent(params.parameter.b)}/c/\``); | ||
| expect(generate("/a/b/{c}", [{ in: "path", name: "c", required: true }])).toEqual(`\`/a/b/\${encodeURIComponent(params.parameter.c)}\``); | ||
| expect(generate("/a/b/{c}", [{ in: "path", name: "c", required: true }])).toEqual(`\`/a/b/\${encodeURIComponent(params.parameter.c)}\``); | ||
| expect(generate("/a/b/{c}/", [{ in: "path", name: "c", required: true }])).toEqual(`\`/a/b/\${encodeURIComponent(params.parameter.c)}/\``); | ||
| expect(generate("/a/b/{c}.json", [{ in: "path", name: "c", required: true }])).toEqual( | ||
| `\`/a/b/\${encodeURIComponent(params.parameter.c)}.json\`;${EOL}`, | ||
| `\`/a/b/\${encodeURIComponent(params.parameter.c)}.json\``, | ||
| ); | ||
| expect(generate("/{a}.json/{a}.json/{a}.json", [{ in: "path", name: "a", required: true }])).toEqual( | ||
| `\`/\${encodeURIComponent(params.parameter.a)}.json/\${encodeURIComponent(params.parameter.a)}.json/\${encodeURIComponent(params.parameter.a)}.json\`;${EOL}`, | ||
| `\`/\${encodeURIComponent(params.parameter.a)}.json/\${encodeURIComponent(params.parameter.a)}.json/\${encodeURIComponent(params.parameter.a)}.json\``, | ||
| ); | ||
| expect(generate("/.json.{a}.json/{a}.json.{a}", [{ in: "path", name: "a", required: true }])).toEqual( | ||
| `\`/.json.\${encodeURIComponent(params.parameter.a)}.json/\${encodeURIComponent(params.parameter.a)}.json.\${encodeURIComponent(params.parameter.a)}\`;${EOL}`, | ||
| `\`/.json.\${encodeURIComponent(params.parameter.a)}.json/\${encodeURIComponent(params.parameter.a)}.json.\${encodeURIComponent(params.parameter.a)}\``, | ||
| ); | ||
|
|
||
| expect( | ||
| generate("/{a}/{b}", [ | ||
| { in: "path", name: "a", required: true }, | ||
| { in: "path", name: "b", required: true }, | ||
| ]), | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}\`;${EOL}`); | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}\``); | ||
| expect( | ||
| generate("/{a}/{b}/", [ | ||
| { in: "path", name: "a", required: true }, | ||
| { in: "path", name: "b", required: true }, | ||
| ]), | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}/\`;${EOL}`); | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}/\``); | ||
| expect( | ||
| generate("/{a}/{b}/c", [ | ||
| { in: "path", name: "a", required: true }, | ||
| { in: "path", name: "b", required: true }, | ||
| ]), | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}/c\`;${EOL}`); | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}/c\``); | ||
| expect( | ||
| generate("/{a}/{b}/c/", [ | ||
| { in: "path", name: "a", required: true }, | ||
| { in: "path", name: "b", required: true }, | ||
| ]), | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}/c/\`;${EOL}`); | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/\${encodeURIComponent(params.parameter.b)}/c/\``); | ||
| expect( | ||
| generate("/{a}/b/{c}", [ | ||
| { in: "path", name: "a", required: true }, | ||
| { in: "path", name: "c", required: true }, | ||
| ]), | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/b/\${encodeURIComponent(params.parameter.c)}\`;${EOL}`); | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/b/\${encodeURIComponent(params.parameter.c)}\``); | ||
| expect( | ||
| generate("/{a}/b/{c}/", [ | ||
| { in: "path", name: "a", required: true }, | ||
| { in: "path", name: "c", required: true }, | ||
| ]), | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/b/\${encodeURIComponent(params.parameter.c)}/\`;${EOL}`); | ||
| ).toBe(`\`/\${encodeURIComponent(params.parameter.a)}/b/\${encodeURIComponent(params.parameter.c)}/\``); | ||
| expect( | ||
| generate("/a/{b}/{c}", [ | ||
| { in: "path", name: "b", required: true }, | ||
| { in: "path", name: "c", required: true }, | ||
| ]), | ||
| ).toBe(`\`/a/\${encodeURIComponent(params.parameter.b)}/\${encodeURIComponent(params.parameter.c)}\`;${EOL}`); | ||
| ).toBe(`\`/a/\${encodeURIComponent(params.parameter.b)}/\${encodeURIComponent(params.parameter.c)}\``); | ||
| expect( | ||
| generate("/a/{b}/{c}/", [ | ||
| { in: "path", name: "b", required: true }, | ||
| { in: "path", name: "c", required: true }, | ||
| ]), | ||
| ).toBe(`\`/a/\${encodeURIComponent(params.parameter.b)}/\${encodeURIComponent(params.parameter.c)}/\`;${EOL}`); | ||
| ).toBe(`\`/a/\${encodeURIComponent(params.parameter.b)}/\${encodeURIComponent(params.parameter.c)}/\``); | ||
| expect( | ||
| generate("/a/{b}...{c}/", [ | ||
| { in: "path", name: "b", required: true }, | ||
| { in: "path", name: "c", required: true }, | ||
| ]), | ||
| ).toBe(`\`/a/\${encodeURIComponent(params.parameter.b)}...\${encodeURIComponent(params.parameter.c)}/\`;${EOL}`); | ||
| ).toBe(`\`/a/\${encodeURIComponent(params.parameter.b)}...\${encodeURIComponent(params.parameter.c)}/\``); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
will remove