Giter Site home page Giter Site logo

Comments (3)

pedronauck avatar pedronauck commented on April 27, 2024 3

Glad you liked it @mquandalle. I'm using typescript a lot in a bunch of projects nowadays, to be honest, I'm using it for all projects and I really like it. Unfortunately, since I did not have much time, I ended up choosing to get some tool that makes this annotation integration already. In this version of docz we're using react-docgen to generate the properties table, but it is kinda limited, have a lot of trade-offs and can be a performance problem 😒One of these trade-offs is about default properties using typescript. Flow integration is so much better than typescript!

Maybe in future is good thing create something or improve react-docgen to fix these problems.

About annotations in normal functions, this is awesome and I think that is something really easy and viable to do with docz. I'm thinking about that this week and JSDocs until now is the better alternative!

from docz.

mquandalle avatar mquandalle commented on April 27, 2024

I really don't know much about meta analyse of JS files, but do you think it might be viable to use the typescript language server (for both TS and JS files) to gather meta informations like types and field descriptions using the same API than IDE like VS Code?

The idea would be to use a mature high level API instead of transforming AST.

from docz.

gtkatakura avatar gtkatakura commented on April 27, 2024

I think it's best to open an issue at react-docgen-typescript. I've seen that this project uses react-docgen-typescript-loader, and this and this point out that this is the responsibility of react-docgen-typescript.

from docz.

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.