refactor(lockfile): consolidate TS and JSON schema type definitions #777
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
Co-authored-by: Kanad Gupta <8854718+kanadgupta@users.noreply.github.com>
Co-authored-by: Kanad Gupta <8854718+kanadgupta@users.noreply.github.com>
Co-authored-by: Kanad Gupta <8854718+kanadgupta@users.noreply.github.com>
kanadgupta
commented
Oct 20, 2023
| } | ||
| } | ||
| }, | ||
| "additionalProperties": false |
Contributor
Author
There was a problem hiding this comment.
this caught my attention thanks to json-schema-to-ts 👑
Comment on lines
+9
to
+10
| "$schema": { "type": "string" }, | ||
| "apis": { "type": "array", "description": "The list of installed APIs", "items": { "$ref": "#/definitions/api" } } |
| "scripts": { | ||
| "attw": "attw --pack --format table-flipped", | ||
| "build": "tsc", | ||
| "build:versionedfiles": "NODE_OPTIONS=--no-warnings node --loader ts-node/esm bin/buildVersionedFiles.ts", |
Contributor
Author
There was a problem hiding this comment.
i don't love this file name nor its corresponding package.json script name, open to ideas here 😬
| export enum SupportedLanguages { | ||
| JS = 'js', | ||
| } | ||
| export const SupportedLanguages = { |
Contributor
Author
There was a problem hiding this comment.
we can't use TS enums here anymore since we're deriving our supported languages from the JSON schema
kanadgupta
added
enhancement
erunion
requested changes
Oct 20, 2023
Member
erunion
left a comment
erunion
left a comment
There was a problem hiding this comment.
some very small changes but otherwise this looks great.
Co-authored-by: Jon Ursenbach <erunion@users.noreply.github.com>
Co-Authored-By: Jon Ursenbach <jon@ursenba.ch>
Co-Authored-By: Jon Ursenbach <jon@ursenba.ch>
erunion
approved these changes
Oct 20, 2023
packages/api/src/commands/install.ts
Outdated
| new Option('-l, --lang <language>', 'SDK language').default(SupportedLanguages.JS).choices([SupportedLanguages.JS]), | ||
| ) | ||
| .addOption(new Option('-y, --yes', 'Automatically answer "yes" to any prompts printed')) | ||
| .action(async (uri: string, options: { identifier?: string; lang: string; yes?: boolean }) => { |
Member
There was a problem hiding this comment.
Suggested change
| .action(async (uri: string, options: { identifier?: string; lang: string; yes?: boolean }) => { | |
| .action(async (uri: string, options: { identifier?: string; lang: SupportedLanguage; yes?: boolean }) => { |
packages/api/src/commands/install.ts
Outdated
| let language: SupportedLanguage; | ||
| if (options.lang) { | ||
| language = options.lang as SupportedLanguages; | ||
| language = options.lang as SupportedLanguage; |
Member
There was a problem hiding this comment.
Suggested change
| language = options.lang as SupportedLanguage; | |
| language = options.lang; |
Co-Authored-By: Jon Ursenbach <jon@ursenba.ch>
kanadgupta
added
the
area:api
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🧰 Changes
This does a bit of quality-of-life work to consolidate our TS types and our JSON Schema definition for the
apilockfile schema. We now rebuild theschema.jsonfile every time we runnpm version, similar to how we do forpackageInfo.ts.🧬 QA & Testing
Does the
buildVersionedFiles.tswork as expected when you run it locally? If the TS build and all the tests pass, we should be in good shape.