auto-generate type definitions from the json schema #177
Conversation
This file contains 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
tordans
approved these changes
Dec 26, 2024
| import shell from 'shelljs'; | ||
| import YAML from 'js-yaml'; | ||
| import marky from 'marky'; | ||
| import { createRequire } from 'module'; | ||
| import { compileFromFile } from 'json-schema-to-typescript'; | ||
| import { toSafeString } from 'json-schema-to-typescript/dist/src/utils.js'; |
There was a problem hiding this comment.
Should we maybe ask in the repo to make this a public API?
I could not find any issue on this, yet https://github.com/search?q=repo%3Abcherny%2Fjson-schema-to-typescript+toSafeString&type=issues
| @@ -30,7 +30,6 @@ export default [ | |||
| 'indent': ['off', 4], | |||
| 'keyword-spacing': 'error', | |||
| 'linebreak-style': ['error', 'unix'], | |||
| 'no-await-in-loop': 'error', | |||
There was a problem hiding this comment.
✅
For reference https://eslint.org/docs/latest/rules/no-await-in-loop
Don't see a reason why we would want to prevent this.
| @@ -16,6 +16,7 @@ | |||
| "chalk": "^5.0.1", | |||
| "glob": "^10.1.0", | |||
| "js-yaml": "^4.0.0", | |||
| "json-schema-to-typescript": "^15.0.3", | |||
There was a problem hiding this comment.
Does it matter if this is in devDependencies or dependencies? It is only used during build so I kind of expected it to be a devDependencies?
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.
Besides from iD, there are several typescript projects which use this library. Currently, each project has to write their own type-definitions (see examples from overpass-turbo and osmapp). This is inconvenient and the definitions could easily become out-of-date.
This PR uses json-schema-to-typescript to generate TS definition files for the main JSON files in
dist/*. This means that the next release of @openstreetmap/id-tagging-schema will include.d.json.tsfiles - example hereExamples: