Giter Site home page Giter Site logo

Comments (3)

elevatebart avatar elevatebart commented on May 28, 2024 1

@patric-eberle,

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.

patric-eberle avatar patric-eberle commented on May 28, 2024

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.

vue-styleguidist-bot avatar vue-styleguidist-bot commented on May 28, 2024

🎉 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)

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.