Skip to content

Conversation

@bitgopatmcl
Copy link
Contributor

@bitgopatmcl bitgopatmcl commented Aug 18, 2023

BREAKING CHANGE: The OpenAPI generator has been almost entirely rewritten and now uses swc instead of ts-morph. Performance is much better, and there should be fewer bugs. The CLI has been streamlined to just accept a ts file as a parameter, and outputs the spec to stdout. More jsdoc comments are supported as well (see here)

@socket-security
Copy link

socket-security bot commented Aug 18, 2023

New, updated, and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Packages Version New capabilities Transitives Size Publisher
resolve 1.22.4 None +1 175 kB ljharb
@swc/core-darwin-arm64 1.3.76 None +0 34.4 MB kdy1
@swc/core-linux-x64-gnu 1.3.76 None +0 46.6 MB kdy1
@swc/core 1.3.76 filesystem, shell, environment +10 390 MB kdy1
@types/resolve 1.20.2 None +0 9.88 kB types
@swc-node/register 1.6.6 filesystem, environment +14 390 MB broooooklyn
memfs 4.2.1 network, filesystem, shell +8 11.6 MB streamich
turbo 1.10.12...1.10.10 None +6/-6 246 MB turbobot

🚮 Removed packages: io-ts-types@0.5.15, parser-ts@0.7.0, ts-morph@14.0.0

@bitgopatmcl bitgopatmcl force-pushed the swc-based-openapi-generator branch from 60ead7f to 5fcbdfc Compare August 18, 2023 21:27
"@types/resolve": "^1.20.2",
"c8": "8.0.1",
"parser-ts": "0.7.0",
"tsx": "3.12.7"
Copy link
Contributor

@ericcrosson-bitgo ericcrosson-bitgo Aug 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Should we eventually replace tsx with swc in the other packages too? Since npm hoists dependencies with workspaces, it would result in fewer dependencies downloaded and faster npm install runtimes

@bitgopatmcl bitgopatmcl force-pushed the swc-based-openapi-generator branch 2 times, most recently from 09fc1b7 to 8895871 Compare August 21, 2023 13:58
@bitgopatmcl bitgopatmcl marked this pull request as ready for review August 21, 2023 14:20
@bitgopatmcl bitgopatmcl requested a review from a team as a code owner August 21, 2023 14:20
@bitgopatmcl bitgopatmcl force-pushed the swc-based-openapi-generator branch from 3c6fe48 to 9951a4e Compare August 21, 2023 14:23
const pkgJson = fs.readFileSync(pkgFile, 'utf-8');
return JSON.parse(pkgJson)['version'] ?? '0.0.1';
} catch (err) {
return '0.0.1';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: should this raise an error for the user to resolve by editing their package manifest?

@bitgopatmcl bitgopatmcl force-pushed the swc-based-openapi-generator branch 4 times, most recently from 792f207 to b012043 Compare August 22, 2023 14:14
BREAKING CHANGE: The OpenAPI generator has been almost entirely
rewritten and now uses `swc` instead of `ts-morph`.
@bitgopatmcl bitgopatmcl force-pushed the swc-based-openapi-generator branch 2 times, most recently from 5554c1a to 8211730 Compare August 22, 2023 16:16
@bitgopatmcl bitgopatmcl force-pushed the swc-based-openapi-generator branch from 8211730 to 340c14b Compare August 22, 2023 16:29
Copy link
Contributor

@andrew-scott-fischer andrew-scott-fischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bitgopatmcl bitgopatmcl merged commit 3315aa6 into BitGo:master Aug 22, 2023
@bitgopatmcl bitgopatmcl deleted the swc-based-openapi-generator branch August 22, 2023 17:15
@github-actions
Copy link

🎉 This PR is included in version @api-ts/openapi-generator@2.0.0 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

ericcrosson-bitgo added a commit to ericcrosson-bitgo/api-ts that referenced this pull request Aug 24, 2023
tsmorph was removed in BitGo#508, so we
can remove the associated dependabot configuration.
@github-actions
Copy link

🎉 This PR is included in version @api-ts/typed-express-router@1.1.1 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/express-wrapper@1.0.21 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

🎉 This PR is included in version @api-ts/superagent-wrapper@1.1.12 🎉

The release is available on npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

@github-actions
Copy link

github-actions bot commented Oct 4, 2023

🎉 This PR is included in version @api-ts/io-ts-http@2.4.1-beta.1 🎉

The release is available on @api-ts/io-ts-http

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants