Skip to content

Commit 256ca0d

Browse files
committed
Fixed paths to images in the ReadMe. Updated package.json with correct extension and author information.
1 parent 5c89933 commit 256ca0d

File tree

3 files changed

+17
-11
lines changed

3 files changed

+17
-11
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,39 +20,39 @@ The Generate Directed Graph Markup Language ([dgml](https://docs.microsoft.com/e
2020

2121
The dgml file can be viewed and modified using Microsoft Visual Studio. I don't believe there is an extension for Visual Studio Code yet for viewing dgml files.
2222

23-
![Generate DGML graph](images/GenerateDgml.gif)
23+
![Generate DGML graph](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/GenerateDgml.gif)
2424

2525
### Show the component hierarchy [#](#show-component-hierarchy- 'Show the component hierarchy')
2626

2727
If you don't want install Microsoft Visual Studio or you are on a platform not supporting Microsoft Visual Studio to view the dgml files with the component relationship, you can use the 'Show the component hierarchy' command to render the hierarchy and show it directly in vscode.
2828

2929
This command uses a vscode webview extension component to render the hierarchy using html, javascript and the [Vis.js](https://visjs.org/index.html) javascript library. This has the downside that copying the generated graph to the clipboard is not yet possible due to limitations in the vscode extension api. So to overcome this limitation the generated graph can be saved as a Png file to the root of the project you are analyzing.
3030

31-
![Show component hierarchy](images/ShowComponentHierarchy.gif)
31+
![Show component hierarchy](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/ShowComponentHierarchy.gif)
3232

3333
You can also choose to save a selection from the graph as shown in the example below.
3434

35-
![Show component hierarchy](images/ShowComponentHierarchy2.gif)
35+
![Show component hierarchy](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/ShowComponentHierarchy2.gif)
3636

3737
### Show the directory structure of the project [#](#directory-structure- 'Show the directory structure of the project')
3838

3939
This command lists the entire directory structure of the currently open project. Sometimes this can be a quick way to get an overview of the project if you are new to the project before og maybe need to document it.
4040

4141
The directory structure will be listed in the output window for the AngularTools extension for easy copy/pasting.
4242

43-
![Show the directory structure of the project](images/ShowProjectStructure.gif)
43+
![Show the directory structure of the project](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/ShowProjectStructure.gif)
4444

4545
### Generate list of packages used in the project [#](#package-json-to-markdown- 'Generate list of packages used in the project')
4646

4747
Sometimes your boss or a customer requires documentation of which packages is used in the project. This command can save you a lot of tedious manual work by analyzing the package.json file and for each referenced package queries the [npmjs.com](https://www.npmjs.com/) website to fetch the description for the package and from that generates a Markdown file with a table of the packages with their descriptions.
4848

49-
![Generate list of packages used in the project](images/PackageMarkdown.gif)
49+
![Generate list of packages used in the project](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/PackageMarkdown.gif)
5050

5151
### List all imports [#](#list-all-imports- 'List all imports')
5252

5353
This command will analyse all Angular components in the project and collect all the imports of the components together with the number of times the imported component is used. This can be useful when refactoring or identifying frequently used modules. Usually frequently used modules needs extra attention or care before being changed during refactoring. You can also use the command to identify modules that are not referenced in a consistent way where some components are using relative path and some components using path-aliases.
5454

55-
![List all imports](images/ListAllImports.gif)
55+
![List all imports](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/ListAllImports.gif)
5656

5757
## Third party components and resources
5858

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
{
2-
"name": "angulartools",
2+
"name": "vscode-angulartools",
3+
"publisher": "coderAllan",
34
"displayName": "AngularTools",
4-
"description": "Various tools for Angular development",
5-
"version": "0.0.1",
5+
"description": "AngularTools is a collection of tools for exploring an Angular project, help you with documenting, reverse engineering a project or help when refactoring.",
6+
"version": "1.0.0",
7+
"repository": "https://github.com/CoderAllan/vscode-angulartools",
8+
"author": {
9+
"name": "Allan Simonsen",
10+
"url": "https://github.com/CoderAllan"
11+
},
612
"engines": {
713
"vscode": "^1.49.0"
814
},

0 commit comments

Comments
 (0)