fix(openapi-generator): do not calculate relative paths from input files #123
Conversation
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 commit removes the code to calculate a relative path between the directory containing the tsconfig.json file and the input file. This permits a copy of @api-ts/openapi-generator installed in one location to use files from a project in a different location as inputs without crashing. Full bug report below. What I did ---------- ``` $ npx openapi-generator \ --input ../lib/grooble/src/index.ts \ --output api.json \ --tsconfig ../lib/grooble/tsconfig.json \ --name "Grooble" ``` What I Expected to Happen ------------------------- I expected the openapi-generator to create a file named `api.json` with the OpenAPI spec described by `../lib/grooble/src/index.ts`. What Actually Happens --------------------- ``` Error processing project: src/index.ts not in project ``` with a non-zero exit code. What Actually Happens (with These Changes) ------------------------------------------ The openapi-generator successfully creates a file named `api.json` with the OpenAPI spec described by `../lib/grooble/src/index.ts`. However, I'm not sure why this code was added in the first place! So please review thorougly to see if this will regresss some use-cases not captured by the tests. Ticket: BG-41531
Now trying to remember this as well |
bitgopatmcl
approved these changes
Jun 6, 2022
|
🎉 This PR is included in version 0.2.0-beta.2 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.0.0-beta.13 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 0.2.0-beta.6 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 0.2.0-beta.8 🎉 The release is available on npm package (@beta dist-tag) Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This commit removes the code to calculate a relative path between the
directory containing the tsconfig.json file and the input file. This
permits a copy of @api-ts/openapi-generator installed in one location
to use files from a project in a different location as inputs without
crashing.
Full bug report below.
What I did
What I Expected to Happen
I expected the openapi-generator to create a file named
api.jsonwith the OpenAPI spec described by
../lib/grooble/src/index.ts.What Actually Happens
with a non-zero exit code.
What Actually Happens (with These Changes)
The openapi-generator successfully creates a file named
api.jsonwith the OpenAPI spec described by
../lib/grooble/src/index.ts.However, I'm not sure why this code was added in the first place!
So please review thorougly to see if this will regresss some use-cases
not captured by the tests.
Ticket: BG-41531