create-vag 0.1.0

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.
Files changed (2) hide show
  1. package/README.md +75 -0
  2. package/package.json +97 -0
package/README.md ADDED
@@ -0,0 +1,75 @@
1
+ create-vag
2
+ ==========
3
+
4
+
5
+ Presentation
6
+ ------------
7
+
8
+ *create-vag* is the *initializer* used by *npm* for creating a new [vag](https://github.com/charlyoleg2/vag) repository. It contains the *command line interface* application called by `npm create vag@latest`.
9
+
10
+
11
+ Links
12
+ -----
13
+
14
+ - [sources](https://github.com/charlyoleg2/create-vag)
15
+ - [pkg](https://www.npmjs.com/package/create-vag)
16
+
17
+
18
+ Requirements
19
+ ------------
20
+
21
+ - [node](https://nodejs.org) > 20.10.0
22
+ - [npm](https://docs.npmjs.com/cli) > 10.5.0
23
+
24
+
25
+ Usage
26
+ -----
27
+
28
+ *create-vag* is not intended to be installed directly but rather used via one of the following commands:
29
+
30
+ ```bash
31
+ npm create vag@latest
32
+ npm create vag@latest projAbc
33
+ npm init vag@latest projAbc
34
+ npm exec create-vag@latest projAbc
35
+ npx create-vag@latest projAbc
36
+ ```
37
+
38
+ Dev
39
+ ---
40
+
41
+ ```bash
42
+ git clone https://github.com/charlyoleg2/create-vag
43
+ cd create-vag
44
+ npm install
45
+ npm run ci
46
+ npm run run
47
+ ```
48
+
49
+ Upgrade dependencies
50
+ --------------------
51
+
52
+ ```bash
53
+ npm outdated
54
+ npm update --save
55
+ git commit -am 'npm update --save'
56
+ ```
57
+ or
58
+ ```bash
59
+ npx npm-check-updates
60
+ npx npm-check-updates --upgrade
61
+ npm install
62
+ git commit -am 'npx npm-check-updates --upgrade'
63
+ ```
64
+
65
+ Publish a new release
66
+ ---------------------
67
+
68
+ ```bash
69
+ npm version patch
70
+ git push
71
+ git push origin v0.5.6
72
+ ```
73
+
74
+
75
+
package/package.json ADDED
@@ -0,0 +1,97 @@
1
+ {
2
+ "name": "create-vag",
3
+ "version": "0.1.0",
4
+ "description": "The npm-initializer for creating a new vag repo",
5
+ "private": false,
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/charlyoleg2/create-vag.git"
9
+ },
10
+ "homepage": "https://www.npmjs.com/package/create-vag",
11
+ "author": "charlyoleg",
12
+ "license": "ISC",
13
+ "keywords": [
14
+ "git",
15
+ "sub-repo",
16
+ "vcstool",
17
+ "subg",
18
+ "vag"
19
+ ],
20
+ "type": "module",
21
+ "exports": {
22
+ ".": {
23
+ "types": "./dist/create-vag-api.d.ts",
24
+ "default": "./dist/create-vag-api.js"
25
+ }
26
+ },
27
+ "bin": {
28
+ "create-vag": "dist/create-vag-cli.js"
29
+ },
30
+ "files": [
31
+ "dist/create-vag-cli.js",
32
+ "dist/template/",
33
+ "!dist/**/*.map",
34
+ "!dist/**/*.spec.*"
35
+ ],
36
+ "tsup": {
37
+ "entry": [
38
+ "src/create-vag-api.ts",
39
+ "src/create-vag-ref.ts",
40
+ "src/create-vag-cli.ts"
41
+ ],
42
+ "format": "esm",
43
+ "splitting": false,
44
+ "dts": false,
45
+ "sourcemap": false,
46
+ "clean": true
47
+ },
48
+ "prettier": {
49
+ "useTabs": true,
50
+ "singleQuote": true,
51
+ "trailingComma": "none",
52
+ "printWidth": 100,
53
+ "plugins": [],
54
+ "overrides": []
55
+ },
56
+ "scripts": {
57
+ "dev": "tsup --watch",
58
+ "build": "tsup",
59
+ "check": "tsc --noEmit",
60
+ "pretty": "prettier --check .",
61
+ "format": "prettier --write .",
62
+ "lint": "eslint .",
63
+ "test:unit": "vitest",
64
+ "test:unit:once": "vitest --run",
65
+ "copy_template": "shx cp -r template dist/",
66
+ "cleanCopy_template": "run-s clean:template copy_template",
67
+ "ci": "run-s check build pretty lint test:unit:once cleanCopy_template",
68
+ "run": "dist/create-vag-cli.js",
69
+ "run:ref": "dist/create-vag-ref.js tmp2",
70
+ "run:diff": "diff -rq tmp tmp2",
71
+ "run:check": "run-s run:ref run:diff",
72
+ "cycle": "run-s clean ci run",
73
+ "clean:template": "shx rm -fr dist/template",
74
+ "clean:build": "shx rm -fr dist",
75
+ "clean:output": "shx rm -fr tmp tmp2",
76
+ "clean": "run-s clean:build clean:output"
77
+ },
78
+ "dependencies": {
79
+ "@clack/prompts": "^0.7.0",
80
+ "chalk": "^5.3.0",
81
+ "handlebars": "^4.7.8"
82
+ },
83
+ "devDependencies": {
84
+ "@eslint/js": "^9.10.0",
85
+ "@types/eslint__js": "^8.42.3",
86
+ "@types/node": "^22.5.5",
87
+ "eslint": "^9.10.0",
88
+ "eslint-config-prettier": "^9.1.0",
89
+ "npm-run-all": "^4.1.5",
90
+ "prettier": "^3.3.3",
91
+ "shx": "^0.3.4",
92
+ "tsup": "^8.3.0",
93
+ "typescript": "^5.6.2",
94
+ "typescript-eslint": "^8.6.0",
95
+ "vitest": "^2.1.1"
96
+ }
97
+ }