[FEATURE] support yarn workspaces / monorepo with multiple packages
See original GitHub issueOverview of the feature
yarn workspaces are a nice possibility to handle dependencies in a monorepo.
You can define workspaces in the package.json. For example a structure like this:
.
├── package.json
├── packages
│ ├── stencil-components
│ │ └── ...
│ ├── angular-components
│ │ └── ...
Using Compodoc for each of these packages separately works fine.
This feature request is about generating a bundled documentation of all those packages (they are not necessarily own projects).
I created a global tsconfig.compodoc.json which should include all necessary components:
{
"exclude": [
"**/node_modules/*"
],
"include": [
"packages/**/*"
]
}
Currently the generated documentation only contains the Angular components in packages (probably recognising angular.json somewhere).
Example:
git clone https://github.com/kerosin/compodocs-workspaces-example.git
yarn
yarn doc:serve
Issue Analytics
- State:
- Created 4 years ago
- Comments:5
Top Results From Across the Web
Workspaces in Yarn | Yarn Blog
Yarn Workspaces is a feature that allows users to install dependencies from multiple package.json files in subfolders of a single root package.
Read more >Yarn workspaces — monorepo beginner's guide - Medium
Yarn Workspaces is a feature that allows users to install dependencies from multiple package.json files in subfolders of a single root package.json file, ......
Read more >Scaling out JavaScript Monorepos with Yarn Workspaces
Workspaces : Yarn can now manage dependencies across many independent projects in the same repository. Instead of having several big node_modules ...
Read more >Yarn Workspaces Setup - Multiple JavaScript Packages ...
In this video we are going to see what is mono-repo and multi -repo project structures looking like and we will see an...
Read more >Managing Monorepo using Lerna and Yarn workspaces
Yarn Workspaces · Manage multiple npm packages on a single repository · yarn install command installs all package's dependencies · Hoist duplicated ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.
This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.