Coder Social home page Coder Social logo

Provide the tsdoc/typedoc/jsdoc proper commentaries to generated interfaces based on schema title and/or schema description. about json-schema-to-typescript HOT 2 CLOSED

bcherny avatar bcherny commented on May 16, 2024 1
Provide the tsdoc/typedoc/jsdoc proper commentaries to generated interfaces based on schema title and/or schema description.

from json-schema-to-typescript.

Comments (2)

bcherny avatar bcherny commented on May 16, 2024

Good idea - how about a heuristic:

  • If a property only has a description, use an inline comment
  • If a property has both a description and a title, use a block comment

Feel free to submit a PR, otherwise I'll get to this eventually.

from json-schema-to-typescript.

bcherny avatar bcherny commented on May 16, 2024

If description is set, it will produce a multi-line comment (newlines are supported).
If title is set, it will generate a type alias (see https://github.com/bcherny/json-schema-to-typescript/blob/master/test/cases/named-property.ts).

Both work with intellisense.

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.