Comments (4)
To go around the issue I had to introduce a kind of root-schema
to hold all assets.
root.json
:
{
"id": "Root",
"title": "Root",
"description": "Root schema for all assets",
"type": "object",
"allOf": [
{
"$ref": "schema/new-draft.json"
},
{
"$ref": "schema/draft.json"
},
(.......)
]
}
Each of the ones referenced in the above then references other schemas.
Having this I can run:
npx json2ts --no-additionalProperties --no-enableConstEnums -i 'schema/root.json' -o packages/model/src/generated-types.ts
To get something like:
/**
* Root schema for all assets
*/
export type Root = NewDraft & Draft & (...);
/**
* A new draft
*/
export interface NewDraft {
(...)
export interface Draft {
(...)
export interface (...)
I do not like that export of Root
, but can't figure out a way to get the desired outcome any other way...
from json-schema-to-typescript.
@codan84 Are you also seeing duplicate interface declarations in the resulting output for $ref
s which appear in multiple places? I was trying to use --no-declareExternallyReferenced
, but then individual files generate don't include import
statements. :/
from json-schema-to-typescript.
As a workaround to generate unique classes, the best I could come up with is merged them into a single file. This has the benefit of not requiring a root schema, and provides unique (non-duplicate) class definitions:
mkdir -p dist/generated && \
npx json2ts \
--no-declareExternallyReferenced \
--no-bannerComment \
--cwd=src \
-i 'src/*.schema.json' \
-o dist/tmp/ && \
cat dist/tmp/*.schema.d.ts > dist/generated/schema.d.ts
from json-schema-to-typescript.
This is definitely a bit of a hack but one work around I found was to do
json2ts --bannerComment "/* eslint-disable */
import * from './base_types.d'"
Then I split the schema generation into 2 steps. One for base types which should not import themselves and another for all my other types. Of course this doesn't really solve the full issue but at least gave me a path around this temporarily.
from json-schema-to-typescript.
Related Issues (20)
- `strictIndexSignatures` option is ignored for single pattern properties
- Package lists dev dependencies as dependencies HOT 4
- If `minProperties` is greater than or equal to the number of declared properties and `additionalProperties` is `false`, all properties should be required HOT 2
- properties + anyOf generates incorrect output
- `compile()` ignores `$refOptions.resolve` settings HOT 1
- What package manager does the repo use? HOT 6
- `SyntaxError` while building browser bundle HOT 2
- Add option to remove `[k: string]: unknown | undefined;` from generated types HOT 5
- Add yaml support HOT 3
- bug in vercel production, but development environment is OK HOT 1
- "SyntaxError: Unexpected token in JSON at position 0" when running CLI on MacOS HOT 2
- wrongly transformed array of string HOT 6
- Update to glob 10 HOT 1
- Remove deprecated deps @types/prettier HOT 2
- Indirect dependency on es5-ext: flagged as malicious by some security scanners HOT 2
- `$ref` in `allOf` with depth of 2 is not correctly converted when multi-referenced HOT 3
- YAML support in cli doesn't work HOT 1
- Is there a way to define how types are written? HOT 1
- Referencing specific enum values? HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from json-schema-to-typescript.