GithubHelp home page GithubHelp logo

Comments (3)

strothj avatar strothj commented on June 3, 2024

Hello,

I made a pull request to the project react-docgen-typescript to make it possible to use their package as a peer dependency. My goal is to allow users to take advantage of improvements on their parser without relying on new releases to this one. I have some work on-going on the v3 branch.

I'm also in the process of simplifying the configuration per: #15, also in that branch.

A major consideration at present is the high cost of the type checking used to produce the docgen information. I've encountered very long start times for development on projects containing 80+ components. This is a problem when all components are loaded at once by Storybook. Because of this problem, I'm not sure it would be feasible to have this enabled by default without some other approach.

I think the integration can be made easier and the documentation improved. I was planning some documentation improvements for this package, especially around the confusion with where users should report parsing issues.

I'll have to think a bit more on what else can be done. What ideas did you have in mind for making TypeScript easier to use? I'd be happy to help with the documentation.

from react-docgen-typescript-loader.

strothj avatar strothj commented on June 3, 2024

@ndelangen
I just found out today that the Docz project inserts this loader when the user enables TypeScript support in the config.

https://github.com/pedronauck/docz/blob/master/packages/docz-core/src/bundlers/webpack/loaders.ts#L23

The documentation for their config file: https://www.docz.site/documentation/project-configuration

from react-docgen-typescript-loader.

strothj avatar strothj commented on June 3, 2024

I'm closing this issue for house keeping purposes.

from react-docgen-typescript-loader.

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.