Git Product home page Git Product logo

Comments (4)

codan84 avatar codan84 commented on June 18, 2024

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.

gino-m avatar gino-m commented on June 18, 2024

@codan84 Are you also seeing duplicate interface declarations in the resulting output for $refs 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.

gino-m avatar gino-m commented on June 18, 2024

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.

MattLJoslin avatar MattLJoslin commented on June 18, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.