{"id":13481849,"url":"https://github.com/compodoc/ngd","last_synced_at":"2025-04-13T00:39:52.044Z","repository":{"id":56900019,"uuid":"47725513","full_name":"compodoc/ngd","owner":"compodoc","description":"View the dependencies tree of you Angular application","archived":false,"fork":false,"pushed_at":"2023-05-17T17:15:56.000Z","size":8412,"stargazers_count":618,"open_issues_count":19,"forks_count":86,"subscribers_count":32,"default_branch":"master","last_synced_at":"2025-03-15T14:15:59.601Z","etag":null,"topics":["angular","dependencies","dependency-graph","graph","typescript","visualization"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/compodoc.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2015-12-09T23:25:17.000Z","updated_at":"2025-03-04T07:56:02.000Z","dependencies_parsed_at":"2024-01-14T09:00:38.482Z","dependency_job_id":null,"html_url":"https://github.com/compodoc/ngd","commit_stats":{"total_commits":202,"total_committers":12,"mean_commits":"16.833333333333332","dds":0.4158415841584159,"last_synced_commit":"60dbb2ac17e1d87f75b2378975607e578ae2a1fd"},"previous_names":["manekinekko/angular2-dependencies-graph"],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fngd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fngd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fngd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/compodoc%2Fngd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/compodoc","download_url":"https://codeload.github.com/compodoc/ngd/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244766579,"owners_count":20507062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","dependencies","dependency-graph","graph","typescript","visualization"],"created_at":"2024-07-31T17:00:56.670Z","updated_at":"2025-03-22T21:05:46.410Z","avatar_url":"https://github.com/compodoc.png","language":"TypeScript","readme":"[![Build status](https://ci.appveyor.com/api/projects/status/45ou8frsi43v7j8r?svg=true)](https://ci.appveyor.com/project/vogloblinsky/ngd/branch/master)\n[![CircleCI](https://circleci.com/gh/compodoc/ngd/tree/master.svg?style=svg)](https://circleci.com/gh/compodoc/ngd/tree/master)\n[![Code Climate](https://codeclimate.com/github/compodoc/ngd/badges/gpa.svg)](https://codeclimate.com/github/compodoc/ngd)\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"right\"\u003eCLI\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://badge.fury.io/js/%40compodoc%2Fngd-cli\"\u003e\u003cimg src=\"https://badge.fury.io/js/%40compodoc%2Fngd-cli.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"right\"\u003eCore\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://badge.fury.io/js/%40compodoc%2Fngd-core\"\u003e\u003cimg src=\"https://badge.fury.io/js/%40compodoc%2Fngd-core.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"right\"\u003eCompiler\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://badge.fury.io/js/%40compodoc%2Fngd-compiler\"\u003e\u003cimg src=\"https://badge.fury.io/js/%40compodoc%2Fngd-compiler.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"right\"\u003eTransformer\u003c/td\u003e\n    \u003ctd\u003e\u003ca href=\"https://badge.fury.io/js/%40compodoc%2Fngd-transformer\"\u003e\u003cimg src=\"https://badge.fury.io/js/%40compodoc%2Fngd-transformer.svg\" alt=\"npm version\" height=\"18\"\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n# NGD: Angular Dependencies Graph\n\nA tool that allows you to view your Angular application dependencies.\n\n## Generated Graphs (sample)\n\n#### Sample Application\n\n![screenshots-4](https://raw.githubusercontent.com/compodoc/ngd/master/screenshots/dependencies-4.png)\n\n#### Angular Material 2\n\n\u003cimg src=\"https://cdn.rawgit.com/compodoc/ngd/master/screenshots/dependencies.material2.svg\"/\u003e\n\n#### ng-bootstrap\n\n\u003cimg src=\"https://cdn.rawgit.com/compodoc/ngd/master/screenshots/dependencies.ng-bootstrap.svg\"/\u003e\n\n#### soundcloud-ngrx\n\n\u003cimg src=\"https://cdn.rawgit.com/compodoc/ngd/master/screenshots/dependencies.soundcloud-ngrx.svg\"/\u003e\n\n## Install\n\nInstall from npm:\n\n```\nnpm install -g @compodoc/ngd-cli\n```\n\nInstall from Yarn:\n\n```\nyarn global add @compodoc/ngd-cli\n```\n\n## Usage the CLI\n\n```\n$ ngd --help\n\nUsage: ngd [options]\n\nOptions:\n\n  -h, --help                    Output usage information\n  -V, --version                 Output the version number\n  -f, --file [file]             Entry *.ts file\n  -p, --tsconfig [config]       A tsconfig.json\n  -o, --open                    Open the generated HTML diagram file\n  -g, --display-legend          Display the legend in the generated graph (default: true)\n  -s, --silent                  In silent mode, log messages aren't logged in the console\n  -t, --output-formats [formats] Output formats (default: html,svg,dot,json)\n  -d, --output [folder]         Where to store the generated files\n```\n\n### 1) use a `tsconfig.json`:\n\nRun inside your project (where your `tsconfig.json` is located):\n\n```bash\n$ cd my-awesome-cli-angular-app/\n$ ngd\n$ # or\n$ ngd -p ./tsconfig.json\n```\n\nNote: This will read the `files` entry point in your `tsconfig.json` and crawl your app. If the entry point is not\nfound, 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)).\n\n### 2) provide an entry file:\n\n```bash\n$ cd my-awesome-cli-angular-app/\n$ ngd -f src/main.ts\n```\n\nNOTE: The file you provide should contain your root component.\n\n## Usage the API\n\n1. Import the `DotEngine` and `Compiler` from `@compodoc/ngd-transformer` and `@compodoc/ngd-compiler`:\n\n```javascript\nimport { DotEngine } from '@compodoc/ngd-transformer';\nimport { Compiler } from '@compodoc/ngd-compiler';\n```\n\n2. Create an instance of a compiler:\n\n```javascript\nconst compiler = new Compiler(files, {\n    tsconfigDirectory: cwd,\n});\n```\n\n3. Get the found dependencies:\n\n```javascript\nconst deps = compiler.getDependencies();\n```\n\n4. Pass those dependencies to the transformer:\n\n```javascript\nconst engine = new DotEngine({\n    output: program.output,\n    displayLegend: program.displayLegend,\n    outputFormats: program.outputFormats.split(','),\n});\n```\n\n5. Generate the graph:\n\n```javascript\nengine.generateGraph(deps).then(file =\u003e { ... });\n```\n\n## Have a PR?\n\nAll contributions are welcome ;)\n\n## License\n\nThe MIT License (MIT)\nCopyright (c) 2016 - Wassim CHEGHAM\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n","funding_links":[],"categories":["TypeScript","Awesome Angular [![Awesome TipeIO](https://img.shields.io/badge/Awesome%20Angular-@TipeIO-6C6AE7.svg)](https://github.com/gdi2290/awesome-angular) [![Awesome devarchy.com](https://img.shields.io/badge/Awesome%20Angular-@devarchy.com-86BDC1.svg)](https://github.com/brillout/awesome-angular-components)","Uncategorized"],"sub_categories":["Angular \u003ca id=\"angular\"\u003e\u003c/a\u003e","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompodoc%2Fngd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcompodoc%2Fngd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcompodoc%2Fngd/lists"}