AngularDoc / angulardoc.github.io

angulardoc.github.io web site
https://angulardoc.github.io
34 stars 1 forks source link

Found .angulardoc.json file in my newly generated Angular project #46

Closed orimdominic closed 4 years ago

orimdominic commented 4 years ago

In response to this tweet, I am filing this issue.

I have been generating new Angular projects before now and I have never seen a .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 a value of 0 for now.

What is the purpose of this file? Is this a VSCode thing or an Angular thing? Could you also please answer a question I posted on Stackoverflow on this issue?

Thanks

danvic712 commented 4 years ago

I have already seen this file when I run my new created project, did you installed a vs code plugin named AngularDoc for Visual Studio Code? I think this file may generated by this plugin, when I uninstall it, it's disappears. image

orimdominic commented 4 years ago

Thanks. I checked my extensions for it and found that I do not have the extension installed. I have a colleague (@taiwosunday99) who also has the same issue. In fact, I saw it on his computer first and when I created a new project, I saw it on mine too. He also doesn't have the extension installed.

angulardoc

agiledigits commented 4 years ago

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).

orimdominic commented 4 years ago

I'm closing the issue because I have come to know what the purpose of the file is, but I still don't understand how it was generated when I don't even have the extension installed.

Thanks.

Jopie64 commented 1 year ago

Should it be added to source control? (Git)

orimdominic commented 1 year ago

@Jopie64 I think from what @agiledigits has said, if it is a project being worked on by multiple developers, it should be.