vag_tools 0.0.4 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,8 +1,81 @@
1
- README of vag (core-package)
2
- ============================
1
+ README of vag\_tools
2
+ ====================
3
3
 
4
4
 
5
5
  Presentation
6
6
  ------------
7
7
 
8
- *vag* is a tool for managing git repositories.
8
+ *vag\_tools* is a *nodejs* package for managing git sub-repositories. It contains:
9
+
10
+ - vag\_core: a javascript library proposing all the featues via an API
11
+ - vag: a CLI-app with the same features for the command-line
12
+ - vagg: a Web-UI (starting a server and opening a UI-page in the browser) with the same features
13
+
14
+
15
+ Requirements
16
+ ------------
17
+
18
+ - [node](https://nodejs.org) > 20.10.0
19
+ - [npm](https://docs.npmjs.com/cli) > 10.1.0
20
+
21
+
22
+ Installation
23
+ ------------
24
+
25
+ ```bash
26
+ npm i -D vag_tools
27
+ npx vag --help
28
+ ```
29
+
30
+
31
+ Config file
32
+ -----------
33
+
34
+ An example of config file for *vag*:
35
+
36
+ ```yaml
37
+ repositories:
38
+ repos/parametrix:
39
+ type: git
40
+ url: git@github.com:charlyoleg2/parametrix.git
41
+ version: main
42
+ repos/parame_paxApps:
43
+ url: https://github.com/charlyoleg2/parame_paxApps.git
44
+ version: main
45
+ parame51:
46
+ url: https://github.com/charlyoleg2/parame51.git
47
+ version: main
48
+ ```
49
+
50
+
51
+ Usage in script
52
+ ---------------
53
+
54
+ ```javascript
55
+ import { Vag } from 'vag_core';
56
+
57
+ Vag.version_short()
58
+
59
+ const vag = new Vag(argv.discoverDir, argv.deepSearch, argv.importYaml, argv.importDir);
60
+ await vag.init();
61
+
62
+ await vag.c_clone();
63
+ await vag.cd_checkout();
64
+ await vag.d_pull(argv.only_configured);
65
+ await vag.d_push(argv.only_configured);
66
+ ```
67
+
68
+
69
+ Usage in command-line
70
+ ---------------------
71
+
72
+ ```bash
73
+ npx vag --help
74
+ npx vag --importYaml=parametrix_repos.yml list
75
+ npx vag --importYaml=parametrix_repos.yml clone
76
+ ```
77
+
78
+
79
+
80
+
81
+
package/dist/vag_cli.js CHANGED
@@ -15,7 +15,7 @@ import { simpleGit } from "simple-git";
15
15
  // package.json
16
16
  var package_default = {
17
17
  name: "vag_tools",
18
- version: "0.0.4",
18
+ version: "0.0.6",
19
19
  description: "api and cli for managing sub-git-repositories",
20
20
  type: "module",
21
21
  main: "./dist/vag_core.js",
package/dist/vag_core.js CHANGED
@@ -9,7 +9,7 @@ import { simpleGit } from "simple-git";
9
9
  // package.json
10
10
  var package_default = {
11
11
  name: "vag_tools",
12
- version: "0.0.4",
12
+ version: "0.0.6",
13
13
  description: "api and cli for managing sub-git-repositories",
14
14
  type: "module",
15
15
  main: "./dist/vag_core.js",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "vag_tools",
3
- "version": "0.0.4",
3
+ "version": "0.0.6",
4
4
  "description": "api and cli for managing sub-git-repositories",
5
5
  "type": "module",
6
6
  "main": "./dist/vag_core.js",