Effect-TS / docgen

An opinionated documentation generator for Effect projects
https://effect-ts.github.io/docgen
MIT License
36 stars 8 forks source link

feat: support using tsconfig files for compilerOptions #26

Closed TylorS closed 1 year ago

TylorS commented 1 year ago

Summary

Details

I'm working on creating a monorepo based on @effect/platform, but with 19 different packages, and I'm finding that the repetition is quite a lot to write and maintain. Being able to utilize extends would be really helpful to minimizing duplication.

Additionally, things like "moduleResolution": "node" leads to runtime errors with the current compilerOptions provided to ts-morph since they are not converted to the corresponding enums defined by TS. Becomes a lot more noticeable when you're reading from tsconfigs which likely define more options.

changeset-bot[bot] commented 1 year ago

🦋 Changeset detected

Latest commit: 8235ab2f0191b2e2234e788b3d3c81a906029379

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | -------------- | ----- | | @effect/docgen | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

gcanti commented 1 year ago

@TylorS thanks!