Comments (13)
@manekinekko is this experimental approach somehow available (branch or something)?
from ngd.
this issue comes from the Viz dependency. We're trying another approach. Will keep you updated.
from ngd.
@DaSchTour the trick from @manekinekko is for compodoc installed globally in your system.
npm i -g @compodoc/compodoc
from ngd.
any update on this?
from ngd.
so this tool is useless?
from ngd.
same here
from ngd.
@vogloblinsky is working on a possible solution to fix this.
To give you more context, this "solution" will allow rendering the graph deps on the client side (the user's browser). In fact, the library we depend on viz.js
doesn't deal well with large projects. It simply crashes. In addition, it's not maintained anymore.
In the meantime, we've included a "workaround" that simply skip the graph that are very large and don't render. You still should have the rest of the documentation generated and working properly (but without the affected graphs).
To do so, just run compodoc
via a node script:
package.json
{
"scripts": {
"reports:doc": "node ./tools/scripts/compodoc.js"
}
}
tools/scripts/compodoc.js
const { spawn } = require('child_process');
const cmd = spawn('compodoc', ['-p', 'src/tsconfig.app.json', '-d', 'reports/documentation/']);
cmd.stdout.pipe(process.stdout);
cmd.stderr.pipe(process.stdout);
Doing so will trick your CI and not mark your build as FAILED.
from ngd.
@manekinekko I tried your solution but it doesn't work. It just throws an error
events.js:183
throw er; // Unhandled 'error' event
^
Error: spawn compodoc ENOENT
at _errnoException (util.js:1022:11)
at Process.ChildProcess._handle.onexit (internal/child_process.js:190:19)
at onErrorNT (internal/child_process.js:372:16)
at _combinedTickCallback (internal/process/next_tick.js:138:11)
at process._tickCallback (internal/process/next_tick.js:180:9)
at Function.Module.runMain (module.js:695:11)
at startup (bootstrap_node.js:188:16)
at bootstrap_node.js:609:3
I also have no idea how this should work because compodoc is not registered as a binary anywere.
from ngd.
we're experimenting an other approach which would be rendering the graph on the client side (taking into account some performances issues).
from ngd.
Have the same issue here? This thread is 10 months old. Any news?
from ngd.
Same issue. Any news?
from ngd.
running compodoc via a node script worked for me.
from ngd.
Same thing on windows, can't generate main diagram.
from ngd.
Related Issues (20)
- (bug): TypeError: Viz is not a function
- (feat) forRoot HOT 1
- add minimum distance between lines HOT 2
- CLI Silent Option Doesn't Work HOT 1
- fix(): remove dependency on gulp-util from ngd-core pacakge HOT 1
- feat: move the build system to Bazel
- NGD unable to differentiate same component name in different moudles
- dot npm package vulnerability (npm audit failing) HOT 7
- parameter for layouting HOT 2
- parametr for filtering what element to render
- highlight the element or relationship on click
- AngularJS Dependency graph
- NGD does not recognise -l or --files option HOT 1
- Since 2.1, `@compodoc/ngd-transformer` now requires Node >= 12.17.0 HOT 2
- Plugin does not support tsconfig.json file with multi-line comments HOT 1
- Arbitrary Code Injection Vulnerability for dependency
- Max call stack size exceeded HOT 2
- Compodoc installation : Pb with ngd-tranformer which download "dot" 2.0.0 beta version
- Question: Is it possible to just show the dependency tree of a given component? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ngd.