refactor(core): moving the core library into an isolated package #725
Conversation
erunion
added
enhancement
There was a problem hiding this comment.
A lot of these SDK fixtures had changes because I slightly bumped our oas dependency and we've fixed a number of issues since the release that this was using:
- Support for
nullmixed types - Addition of a
Default: <default value>suffix to enum descriptions. - Improved unused schema removal.
| import Oas from 'oas'; | ||
| import APICore from 'api/dist/core'; | ||
| import definition from '../../../__fixtures__/definitions/operationid-quirks.json'; | ||
| import APICore from '@api/core'; |
There was a problem hiding this comment.
Moving core also lets us do this clean require instead of having to set this up in exports.
| "@types/lodash.merge": "^4.6.7", | ||
| "@types/lodash.setwith": "^4.3.7", | ||
| "@types/lodash.startcase": "^4.4.7", | ||
| "@types/prettier": "^3.0.0", |
There was a problem hiding this comment.
Forgot to remove this when I removed Prettier support last month.
There was a problem hiding this comment.
Thoughts on bringing in knip? Happy to PR that later
There was a problem hiding this comment.
Fully into bringing in Knip. Will ticket something on the board.
There was a problem hiding this comment.
Figure this readme doesn't need any usage or installation info since you won't ever use this package outside the scope of a codegen'd SDK.
| { | ||
| "name": "@api/core", | ||
| "version": "1.0.0", | ||
| "description": "The magic behind `api` 🧙", |
There was a problem hiding this comment.
Could stand to give this a better description.
erunion
requested review from
a team,
Dashron,
darrenyong and
kanadgupta
and removed request for
a team
| { | ||
| "name": "@api/core", | ||
| "version": "1.0.0", | ||
| "description": "The magic behind `api` 🧙", |
| @@ -0,0 +1 @@ | |||
| import '@api/test-utils/vitest.matchers'; | |||
Co-authored-by: Kanad Gupta <8854718+kanadgupta@users.noreply.github.com>
🧰 Changes
Installing a codegen'd SDK right now installs all of
apiwhich means that our users are getting all of our dependencies for codegen installed (ts-morph,commander,@readme/openapi-parser, the works). Since that's not ideal, and definitely not necessary for an SDK that's been generated, I'm splitting our core library out into a new@api/corepackage that SDKs will then install.closes RM-7992