Giter Site home page Giter Site logo

JSX support about esdoc HOT 17 CLOSED

esdoc avatar esdoc commented on May 13, 2024
JSX support

from esdoc.

Comments (17)

winjer avatar winjer commented on May 13, 2024 15

If anyone else comes to this, you should do something like this for your configuration, and it works pretty well:

{
    "source": "./src",
    "destination": "./doc",
    "includes": [".*\\.js", ".*\\.jsx"],
    "index": "./README.md",
    "package": "./package.json",
    "experimentalProposal": {
        "classProperties": true,
        "objectRestSpread": true
    }
}

from esdoc.

h13i32maru avatar h13i32maru commented on May 13, 2024

Sorry, for now, I do not plan that support JSX 😓

from esdoc.

yamalight avatar yamalight commented on May 13, 2024

@h13i32maru alright. would be interested in PR with it? maybe I'll fork and try to implement it myself :)

from esdoc.

h13i32maru avatar h13i32maru commented on May 13, 2024

@yamalight I am not interested in the PR. Because I am not using JSX and can not maintain it. I welcome that you fork and implement it!

from esdoc.

yamalight avatar yamalight commented on May 13, 2024

@h13i32maru alright, fair enough. thanks for responses :)

from esdoc.

h13i32maru avatar h13i32maru commented on May 13, 2024

@yamalight ESDoc supported JSX!
I had thought the support of JSX is difficult. However, espree already supports JSX.
Sorry, I was careless 💦

from esdoc.

yamalight avatar yamalight commented on May 13, 2024

ah, cool. I'll try to use it on my jsx code once more and will report if there are any issues 👍

from esdoc.

resistdesign avatar resistdesign commented on May 13, 2024

@yamalight Any news?

from esdoc.

yamalight avatar yamalight commented on May 13, 2024

@resistdesign no issues so far, works great

from esdoc.

resistdesign avatar resistdesign commented on May 13, 2024

@yamalight Does it auto-doc your props based on static propTypes?

from esdoc.

yamalight avatar yamalight commented on May 13, 2024

@resistdesign no, it doesn't have any jsx specific functions (although that does sounds pretty cool)

from esdoc.

realmike33 avatar realmike33 commented on May 13, 2024

@resistdesign Still getting an error when trying to parse jsx. Not sure what @yamalight solution to this was.

from esdoc.

resistdesign avatar resistdesign commented on May 13, 2024

@realmike33 I haven't tried in a while, been handling other stuff for now.

from esdoc.

JoseInTheArena avatar JoseInTheArena commented on May 13, 2024

@yamalight would you mind sharing an example of some jsx annotated with esdoc tag?

from esdoc.

yamalight avatar yamalight commented on May 13, 2024

@jarzuaga I'm just using it normally within react projects (generating docs for react classes) - seems to work just fine without any additional tweaks.

from esdoc.

JoseInTheArena avatar JoseInTheArena commented on May 13, 2024

Gotcha, thought you were annotating the JSX in some way and got curious. Thanks @yamalight !

from esdoc.

11111000000 avatar 11111000000 commented on May 13, 2024

now youre need to use plugin instead

from esdoc.

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.