Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What is the purpose of the .angulardoc.json file in an angular project?

I have been generating new Angular projects before now and I have never seen an .angulardoc.json file in the folder in which I generated my Angular project.

Recently, I upgraded my angular Cli to the following

Angular CLI: 9.0.1
Node: 12.13.0
OS: win32 x64

Angular: 9.0.0
... animations, common, compiler, compiler-cli, core, forms
... language-service, platform-browser, platform-browser-dynamic
... router
Ivy Workspace: Yes

Package                           Version
-----------------------------------------------------------
@angular-devkit/architect         0.900.1
@angular-devkit/build-angular     0.900.1
@angular-devkit/build-optimizer   0.900.1
@angular-devkit/build-webpack     0.900.1
@angular-devkit/core              9.0.1
@angular-devkit/schematics        9.0.1
@angular/cli                      9.0.1
@ngtools/webpack                  9.0.1
@schematics/angular               9.0.1
@schematics/update                0.900.1
rxjs                              6.5.4
typescript                        3.7.5
webpack                           4.41.2

and now when I generate a new project, I see a .angulardoc.json file in the same folder with the folder in which I my project was generated.

The file contains an object with two keys: repoId which has the value of an auto-generated key, and lastSync which has the value of 0 for now.

What is the purpose of this file? Is this a VSCode thing or an Angular thing?

like image 992
orimdominic Avatar asked Feb 10 '20 05:02

orimdominic


People also ask

What is the purpose of Angular JSON file Angular?

A file named angular. json at the root level of an Angular workspace provides workspace-wide and project-specific configuration defaults for build and development tools provided by the Angular CLI. Path values given in the configuration are relative to the root workspace folder.

What is the use of Angular json and package json?

package. json file locates in project root and contains information about your web application. The main purpose of the file comes from its name package, so it'll contain the information about npm packages installed for the project.

Where is Angular JSON file?

The angular-cli. json should be located in the root folder of the project. This is using the latest version "@angular/cli": "1.0. 0-beta.

Is Angular json needed?

Every angular project has an “angular. json” file. We all understand that this file is very important. This file contains the settings of the Angular project.

What is @angulardoc for Visual Studio?

AngularDoc for Visual Studio Code. This extension adds Angular development tooling. "Angular" view that lets you browse the Angular application's modules and components, and the top level constructs in the TypeScript file.

What is the purpose of using package JSON in angular project?

What is the purpose of using package.json in the angular project? With the existence of package.json, it will be easy to manage the dependencies of the project. If we are using typescript in the angular project then we can mention the typescript package and version of typescript in package.json.

What is the use of the angular extension?

This extension adds Angular development tooling. "Angular" view that lets you browse the Angular application's modules and components, and the top level constructs in the TypeScript file. "NgRx Explorer" view that lets you browse the NgRx stores, reducers, selectors, and effects. Invoking schematics commands from the explorer's context menu.

What is the best tool for documenting angular applications?

There used to be another tool for documenting Angular applications called AngularDoc. It was similar to CompoDoc in a way that it would recognize both TypeScript and Angular-specific features. It could directly scan your Github repo and generate documentation available on AngularDoc site.


1 Answers

According to the response on the issue I filed on Github,

This file was generated from AngularDoc's VSCode extension. Its purpose is to uniquely identify this repo when multiple developers are using the AngularDoc service. It doesn't do anything if it's a standalone project (i.e. the AngularDoc analyzer runs locally).

Here is a link to the issue

like image 151
orimdominic Avatar answered Sep 28 '22 13:09

orimdominic