Comments (3)
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.
@ndelangen
I just found out today that the Docz project inserts this loader when the user enables TypeScript support in the config.
The documentation for their config file: https://www.docz.site/documentation/project-configuration
from react-docgen-typescript-loader.
I'm closing this issue for house keeping purposes.
from react-docgen-typescript-loader.
Related Issues (20)
- Discrepancy with ts-loader in monorepos
- Failure to describe props defined externally (without a corresponding component) HOT 1
- There is a bug when my filename is "switch" HOT 2
- React-native support ?
- Failed to launch - TypeError: Cannot read property 'getSourceFile' of undefined HOT 1
- Code fails when using displayName that contains invalid characters or reserved words HOT 4
- Missing peerDependency for @webpack-contrib/schema-utils
- Doesn't support union types HOT 7
- Crashing and performance issues with storybook 5.3 HOT 4
- Typescript errors HOT 6
- Importing component defined in index breaks the docgen HOT 1
- Component description detection doesn't work well with the Component Story Format (CSF) HOT 1
- The component file Name should be Capital Case to show Props
- Output more information on union types in prop values HOT 2
- Reversal of 3.7.0 HOT 3
- defaultValue value without double quotes
- question about customization of page layout? HOT 1
- Inline subtype shape inferred as "signature" HOT 1
- Looking for maintainer
- Can the loader use *.js+*.d.ts and work without TS source files and without ts-loader? HOT 1
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 react-docgen-typescript-loader.