GithubHelp home page GithubHelp logo

effect-ts / docgen Goto Github PK

View Code? Open in Web Editor NEW
26.0 2.0 6.0 594 KB

An opinionated documentation generator for Effect projects

Home Page: https://effect-ts.github.io/docgen

License: MIT License

JavaScript 6.54% TypeScript 93.10% Nix 0.35% Shell 0.01%

docgen's Issues

Not reporting TSC or TSX errors

What version of Effect is running?

2.4.11

What steps can reproduce the bug?

Add some invalid typescript or an invalid assert to an example, run docgen.

What is the expected behavior?

Docgen should report the TSC and TSX errors?

What do you see instead?

Docgen reports no errors

Additional information

Here is a repro, also tried updating all dependencies but still no change.

When I add debug logs to the output of the TSC command, I can see the errors and non-zero exit code, but docgen succeeds anyways:
Screenshot 2024-04-07 at 1 16 40 PM

modules not found on windows

I don't know if I'm missing something, but running pnpm run docgen on windows is logging [INFO] 0 module(s) found and no docs are generated. Ran on effect and schema projects.

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.