Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/compodoc/ngd
View the dependencies tree of you Angular application
https://github.com/compodoc/ngd
angular dependencies dependency-graph graph typescript visualization
Last synced: 2 months ago
JSON representation
View the dependencies tree of you Angular application
- Host: GitHub
- URL: https://github.com/compodoc/ngd
- Owner: compodoc
- License: mit
- Created: 2015-12-09T23:25:17.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T17:15:56.000Z (over 1 year ago)
- Last Synced: 2024-10-13T01:13:42.046Z (3 months ago)
- Topics: angular, dependencies, dependency-graph, graph, typescript, visualization
- Language: TypeScript
- Homepage:
- Size: 8.02 MB
- Stars: 619
- Watchers: 33
- Forks: 86
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular-components - @compodoc/ngd-cli - View the dependencies tree of you Angular2 application. (Uncategorized / Uncategorized)
- awesome-angular-components - @compodoc/ngd-cli - View the dependencies tree of you Angular2 application. (Uncategorized / Uncategorized)
README
[](https://ci.appveyor.com/project/vogloblinsky/ngd/branch/master)
[](https://circleci.com/gh/compodoc/ngd/tree/master)
[](https://codeclimate.com/github/compodoc/ngd)
CLI
Core
Compiler
Transformer
# NGD: Angular Dependencies Graph
A tool that allows you to view your Angular application dependencies.
## Generated Graphs (sample)
#### Sample Application
#### Angular Material 2
#### ng-bootstrap
#### soundcloud-ngrx
## Install
Install from npm:
```
npm install -g @compodoc/ngd-cli
```
Install from Yarn:
```
yarn global add @compodoc/ngd-cli
```
## Usage the CLI
```
$ ngd --help
Usage: ngd [options]
Options:
-h, --help Output usage information
-V, --version Output the version number
-f, --file [file] Entry *.ts file
-p, --tsconfig [config] A tsconfig.json
-o, --open Open the generated HTML diagram file
-g, --display-legend Display the legend in the generated graph (default: true)
-s, --silent In silent mode, log messages aren't logged in the console
-t, --output-formats [formats] Output formats (default: html,svg,dot,json)
-d, --output [folder] Where to store the generated files
```
### 1) use a `tsconfig.json`:
Run inside your project (where your `tsconfig.json` is located):
```bash
$ cd my-awesome-cli-angular-app/
$ ngd
$ # or
$ ngd -p ./tsconfig.json
```
Note: This will read the `files` entry point in your `tsconfig.json` and crawl your app. If the entry point is not
found, all `*.ts` files will be crawled, but not those mentioned in the `exclude` property ([more details](https://www.typescriptlang.org/docs/handbook/tsconfig.json.html#details)).
### 2) provide an entry file:
```bash
$ cd my-awesome-cli-angular-app/
$ ngd -f src/main.ts
```
NOTE: The file you provide should contain your root component.
## Usage the API
1. Import the `DotEngine` and `Compiler` from `@compodoc/ngd-transformer` and `@compodoc/ngd-compiler`:
```javascript
import { DotEngine } from '@compodoc/ngd-transformer';
import { Compiler } from '@compodoc/ngd-compiler';
```
2. Create an instance of a compiler:
```javascript
const compiler = new Compiler(files, {
tsconfigDirectory: cwd,
});
```
3. Get the found dependencies:
```javascript
const deps = compiler.getDependencies();
```
4. Pass those dependencies to the transformer:
```javascript
const engine = new DotEngine({
output: program.output,
displayLegend: program.displayLegend,
outputFormats: program.outputFormats.split(','),
});
```
5. Generate the graph:
```javascript
engine.generateGraph(deps).then(file => { ... });
```
## Have a PR?
All contributions are welcome ;)
## License
The MIT License (MIT)
Copyright (c) 2016 - Wassim CHEGHAM
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.