Comments (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.
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.
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)
- node_modules\.bin\gatsby HOT 3
- gh repo clone github/docs HOT 1
- Port not used from custom gatsby-config.js file
- Can't resolve '@emotion/core' HOT 9
- Error on first install. nError handler for invocation 'building-schema', error was 'TypeError: (0 , _buildASTSchema.getDescription) HOT 2
- Test out possibly breaking changes on security updates made from dependabot pull-requests HOT 3
- pnpm bare installs broken HOT 2
- What font is used in Docz image? HOT 3
- Error in setting up development environment HOT 4
- Release notes for 2.4.0 are missing HOT 1
- Multiple errors after installing docz HOT 11
- Error while initializing babel in docz HOT 3
- Can't resolve '@babel/runtime/helpers/esm/regeneratorRuntime'
- Error: Cannot find module 'typescript' docz HOT 2
- Add a visible notice on the documentation on why docz will not work
- Can we say that the project is Dead now? What are the alternatives? HOT 1
- how to use in react 18 HOT 4
- Error docz build
- When I try to run the project in the development environment, I get the following error: HOT 1
- An error occurred while accessing the file after local packaging.
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 docz.