vyriy 0.8.1 → 0.8.4
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 +47 -0
- package/args.js +5 -1
- package/cli.js +21 -1
- package/index.d.ts +1 -0
- package/index.js +1 -0
- package/package.json +7 -6
- package/types.d.ts +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,9 @@
|
|
|
1
1
|
# vyriy
|
|
2
2
|
|
|
3
|
+
Part of [Vyriy](https://vyriy.dev) - a calm architecture toolkit for TypeScript, React, SSR, SSG, APIs, and cloud-ready apps.
|
|
4
|
+
|
|
5
|
+
Full documentation: https://vyriy.dev/docs/vyriy/
|
|
6
|
+
|
|
3
7
|
Interactive project master for Vyriy projects.
|
|
4
8
|
|
|
5
9
|
## Purpose
|
|
@@ -30,6 +34,7 @@ vyriy create . Initialise a new Vyriy project in the current directory
|
|
|
30
34
|
vyriy dist Prepare dist package metadata without publishing to npm
|
|
31
35
|
vyriy static [dir] Serve a static directory (defaults to .)
|
|
32
36
|
vyriy check Check local environment (Node.js and Yarn versions)
|
|
37
|
+
vyriy tooling [tool] Generate thin local tooling config files
|
|
33
38
|
vyriy --help, -h Show help
|
|
34
39
|
vyriy --version, -v Show version
|
|
35
40
|
```
|
|
@@ -77,6 +82,48 @@ vyriy check --help
|
|
|
77
82
|
vyriy check --version
|
|
78
83
|
```
|
|
79
84
|
|
|
85
|
+
### `tooling`
|
|
86
|
+
|
|
87
|
+
Vyriy can generate thin local config files that connect your project to Vyriy
|
|
88
|
+
standards.
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
vyriy tooling init
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Or configure tools one by one:
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
vyriy tooling typescript
|
|
98
|
+
vyriy tooling eslint
|
|
99
|
+
vyriy tooling prettier
|
|
100
|
+
vyriy tooling jest
|
|
101
|
+
vyriy tooling storybook
|
|
102
|
+
vyriy tooling stylelint
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Generated files stay intentionally small. For TypeScript, Vyriy writes a local
|
|
106
|
+
`tsconfig.json` that extends `@vyriy/typescript-config` and includes common
|
|
107
|
+
project paths such as `.storybook`, `packages`, `workspaces`, and root
|
|
108
|
+
TypeScript files.
|
|
109
|
+
|
|
110
|
+
Existing files are skipped by default:
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
vyriy tooling typescript --force
|
|
114
|
+
vyriy tooling init --dry-run
|
|
115
|
+
vyriy tooling --help
|
|
116
|
+
vyriy tooling --version
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
The command does not install dependencies. If required Vyriy config packages are
|
|
120
|
+
missing from `package.json`, it prints a suggested install command:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
yarn add -D @vyriy/typescript-config @vyriy/eslint-config
|
|
124
|
+
npm install --save-dev @vyriy/typescript-config @vyriy/eslint-config
|
|
125
|
+
```
|
|
126
|
+
|
|
80
127
|
### `dist`
|
|
81
128
|
|
|
82
129
|
Prepares every package inside the `dist/` directory for npm publishing:
|
package/args.js
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
export const parseArgs = (args) => {
|
|
2
2
|
const [command = '', ...commandArgs] = args;
|
|
3
|
-
if (command === 'check' ||
|
|
3
|
+
if (command === 'check' ||
|
|
4
|
+
command === 'create' ||
|
|
5
|
+
command === 'dist' ||
|
|
6
|
+
command === 'static' ||
|
|
7
|
+
command === 'tooling') {
|
|
4
8
|
return { type: command, args: commandArgs };
|
|
5
9
|
}
|
|
6
10
|
if (args.includes('--help') || args.includes('-h')) {
|
package/cli.js
CHANGED
|
@@ -8,6 +8,7 @@ Usage:
|
|
|
8
8
|
vyriy dist Prepare dist package metadata without publishing to npm
|
|
9
9
|
vyriy static [dir] Serve a static directory (defaults to .)
|
|
10
10
|
vyriy check Check local environment
|
|
11
|
+
vyriy tooling [tool] Generate thin local tooling config files
|
|
11
12
|
vyriy --help, -h Show help
|
|
12
13
|
vyriy --version, -v Show version
|
|
13
14
|
|
|
@@ -26,6 +27,18 @@ Static options:
|
|
|
26
27
|
vyriy static dist --spa Enable SPA fallback mode
|
|
27
28
|
vyriy static dist --fallback index.html SPA fallback file
|
|
28
29
|
|
|
30
|
+
Tooling options:
|
|
31
|
+
vyriy tooling init Select configs to create
|
|
32
|
+
vyriy tooling typescript Create tsconfig.json
|
|
33
|
+
vyriy tooling eslint Create eslint.config.js
|
|
34
|
+
vyriy tooling prettier Create prettier.config.js
|
|
35
|
+
vyriy tooling jest Create jest.config.js
|
|
36
|
+
vyriy tooling storybook Create .storybook config files
|
|
37
|
+
vyriy tooling stylelint Create stylelint.config.js
|
|
38
|
+
vyriy tooling init --force Overwrite existing config files
|
|
39
|
+
vyriy tooling init --dry-run Print config files without writing them
|
|
40
|
+
vyriy tooling --version Show tooling generator version
|
|
41
|
+
|
|
29
42
|
Examples:
|
|
30
43
|
vyriy create app
|
|
31
44
|
vyriy create app --dry-run
|
|
@@ -37,7 +50,9 @@ Examples:
|
|
|
37
50
|
vyriy static dist --cache static
|
|
38
51
|
vyriy static dist --spa --fallback index.html --cache static
|
|
39
52
|
vyriy static dist
|
|
40
|
-
vyriy check
|
|
53
|
+
vyriy check
|
|
54
|
+
vyriy tooling init
|
|
55
|
+
vyriy tooling typescript`;
|
|
41
56
|
export const cli = async (args = []) => {
|
|
42
57
|
const command = parseArgs(args);
|
|
43
58
|
switch (command.type) {
|
|
@@ -69,6 +84,11 @@ export const cli = async (args = []) => {
|
|
|
69
84
|
await runCreateCli(command.args, 'vyriy create', false);
|
|
70
85
|
break;
|
|
71
86
|
}
|
|
87
|
+
case 'tooling': {
|
|
88
|
+
const { runToolingCli } = await import('@vyriy/tooling');
|
|
89
|
+
await runToolingCli(command.args, 'vyriy tooling', false);
|
|
90
|
+
break;
|
|
91
|
+
}
|
|
72
92
|
default:
|
|
73
93
|
console.error(`Unknown command: ${command.command}\n`);
|
|
74
94
|
console.log(text);
|
package/index.d.ts
CHANGED
package/index.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "vyriy",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.4",
|
|
4
4
|
"description": "Interactive project master for calm cloud-ready applications.",
|
|
5
5
|
"homepage": "https://vyriy.dev/docs/vyriy/",
|
|
6
6
|
"type": "module",
|
|
@@ -10,10 +10,11 @@
|
|
|
10
10
|
},
|
|
11
11
|
"packageManager": "yarn@4.16.0",
|
|
12
12
|
"dependencies": {
|
|
13
|
-
"@vyriy/check": "0.8.
|
|
14
|
-
"@vyriy/create": "0.8.
|
|
15
|
-
"@vyriy/dist": "0.8.
|
|
16
|
-
"@vyriy/static": "0.8.
|
|
13
|
+
"@vyriy/check": "0.8.4",
|
|
14
|
+
"@vyriy/create": "0.8.4",
|
|
15
|
+
"@vyriy/dist": "0.8.4",
|
|
16
|
+
"@vyriy/static": "0.8.4",
|
|
17
|
+
"@vyriy/tooling": "0.8.4"
|
|
17
18
|
},
|
|
18
19
|
"peerDependencies": {
|
|
19
20
|
"@testing-library/dom": "^10.4.1",
|
|
@@ -33,7 +34,7 @@
|
|
|
33
34
|
"rimraf": "^6.1.3",
|
|
34
35
|
"sass": "^1.101.0",
|
|
35
36
|
"serve": "^14.2.6",
|
|
36
|
-
"storybook": "^10.4.
|
|
37
|
+
"storybook": "^10.4.5",
|
|
37
38
|
"stylelint": "^17.13.0",
|
|
38
39
|
"tsx": "^4.22.4",
|
|
39
40
|
"typescript": "^6.0.3",
|
package/types.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export type Command = {
|
|
2
2
|
readonly type: 'help' | 'version';
|
|
3
3
|
} | {
|
|
4
|
-
readonly type: 'check' | 'create' | 'dist' | 'static';
|
|
4
|
+
readonly type: 'check' | 'create' | 'dist' | 'static' | 'tooling';
|
|
5
5
|
readonly args: readonly string[];
|
|
6
6
|
} | {
|
|
7
7
|
readonly type: 'unknown';
|