question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[FEATURE] support yarn workspaces / monorepo with multiple packages

See original GitHub issue
Overview 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:

  1. git clone https://github.com/kerosin/compodocs-workspaces-example.git
  2. yarn
  3. yarn doc:serve

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:5

github_iconTop GitHub Comments

1reaction
stale[bot]commented, Nov 29, 2019

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.

0reactions
lock[bot]commented, Feb 4, 2020

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.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found