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.

[BUG] Does not work with NRWL integrated Angular Project

See original GitHub issue
Does not generate documentation for NRWL integrated angular project

I’m using NX to structure my project and accommodate multiple apps and reuse components via libraries. Upon following instructions in compodoc guide I didn’t encounter any error, only couple of warnings and was able to serve the documentation. However, it wasn’t able to document the components.

Operating System, Node.js, npm, compodoc version(s)

Angular CLI: 7.0.1 Node: 8.12.0 OS: win10 x64 Angular: 7

Angular configuration, a package.json file in the root folder
 "dependencies": {
    "@angular/animations": "^7.1.3",
    "@angular/cdk": "^7.1.1",
    "@angular/common": "^7.0.0",
    "@angular/compiler": "^7.0.0",
    "@angular/core": "^7.0.0",
    "@angular/forms": "^7.0.0",
    "@angular/material": "^7.1.1",
    "@angular/material-moment-adapter": "^7.1.1",
    "@angular/platform-browser": "^7.0.0",
    "@angular/platform-browser-dynamic": "^7.0.0",
    "@angular/router": "^7.0.0",
    "@nrwl/nx": "7.1.1",
    "@ngrx/effects": "6.1.0",
    "@ngrx/entity": "6.1.0",
    "@ngrx/router-store": "6.1.0",
    "@ngrx/store": "6.1.0",
    "core-js": "^2.5.4",
    "rxjs": "~6.3.3",
    "zone.js": "^0.8.26"
     ....
  },
  "devDependencies": {
    "@angular-devkit/build-angular": "^0.12.4",
    "@angular/cli": "7.0.1",
    "@angular/compiler-cli": "^7.0.0",
    "@angular/language-service": "^7.0.0",
    "@ngrx/store-devtools": "6.1.0",
    "@nrwl/schematics": "7.1.1",
    "@types/node": "^8.9.5",
     ....
}
Compodoc installed globally or locally ?

installed globally

If possible sourcecode of the file where it breaks

It runs fine w/ some warnings.

If possible your terminal logs before the error

Warning when running npm run compodoc i got these warnings.

capture

Motivation for or Use Case

I’m using NX to structure multiple applications and reuse libraries. And looking forward for compodoc to document it.

Reproduce the error

Create new angular project via nrwl@7.1.1 and add compodoc. Serve it.

Related issues
Suggest a Fix

Issue Analytics

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

github_iconTop GitHub Comments

1reaction
tashoecraftcommented, Jun 25, 2019

I have the exact same issue as @MarkPieszak. One project randomly doesn’t use the aliases. Using the setup specified by the docs results in having each app have it’s own doc site that doesn’t include the libraries, which isn’t exactly what I’d want. This may be more user specific, but I’d rather have the docs all in one place, but a way to segment out each app and see it’s tree.

0reactions
lock[bot]commented, Dec 6, 2019

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

NX build: Error - No cached ProjectGraph is available
While trying to run my application built in angular 13 throwing below error. Don't know the reason for this. Any help would be...
Read more >
From AngularJS
Migrating an AngularJS Project into an Nx Workspace. Nx offers first-class support for Angular and React out-of-the-box. But one of the questions the...
Read more >
What's your biggest gripes with NRWL NX? : r/Angular2
My problem is, when researching I am seeing mostly positive feedback on NX. I am hoping to hear gripes from actual devs utilizing...
Read more >
single-spa-angular
The single-spa-angular schematics are not supported by Angular 2, so you'll have to follow the steps for manual installation. The single-spa helpers work ......
Read more >
Adding Nx to an Existing Monorepo by Running One Command
Affected Works. Nx will automatically analyze your workspace to know what projects are affected by your commit. Simply run: npx nx affected -- ......
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