Comments (3)
TLDR: I know how to fix it, It just needs some quick re-work.
For better performance, docgen does not evaluate components anymore. It uses AST to gather the information. To get all props and methods from mixins, it has to parse mixins the same way it pases components. It has to parse the mixin file. It is not following import patterns indeed.
Unfortunately, the case of an intermediary file is failing.
Expected:
component with mixin -> get variable name from mixin property -> get filePath from variable name -> get documentation from file
With the intermediary file, this solution tries to parse your intermediary file as a component. Of course does not find any component directly in the file.
The solution would be, if the exported varable resolves to an import, resolve the target file instead.
This should be done in utils/resolveExportedComponent.ts
If you feel like it, a PR is most welcome.
from vue-docgen-api.
We found a solution for us, that works at least as a workaround:
import * as bem from '@verstaerker/vue-bem'
export default {
mixins: [bem.bemMixin]
}
This hardens my suspicion that the doc parser is not able to read the import { variable } from
syntax.
from vue-docgen-api.
🎉 This issue has been resolved in version 3.3.6 🎉
The release is available on:
Your semantic-release bot 📦🚀
from vue-docgen-api.
Related Issues (20)
- JSX slot support HOT 5
- Need to add alias parameters to the readme HOT 1
- v2.7.0 not published to npm HOT 3
- Read Props/Methods from external-separate .js file HOT 2
- Prop with Multiple types always shows "array" HOT 2
- Naming mixin mixup HOT 1
- Events are not shown in documentation bug HOT 1
- Api unable to get event name from jsdoc @event HOT 2
- Is there a way to specify an alternate displayName? HOT 2
- String value for `props[name].required` HOT 2
- Default values for Props with type Object or Array display as functions HOT 3
- Return the functional flag HOT 1
- Describe functional components props in a template HOT 1
- Have more than one mixin per js file HOT 1
- Mixin resolution fails with webpack/typescript alias HOT 2
- Basic support for vue-styled-components HOT 2
- Putting html comment besides root element causes TypeError HOT 3
- Parse error: cannot resolve module HOT 2
- How do you guys debug this? HOT 2
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 vue-docgen-api.