@rxap/plugin-storybook 20.0.5-dev.3 → 20.1.0-dev.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.
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [20.1.0-dev.0](https://gitlab.com/rxap/packages/compare/@rxap/plugin-storybook@20.0.5-dev.3...@rxap/plugin-storybook@20.1.0-dev.0) (2026-01-12)
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
- **schema:** enhance generator schema documentation with descriptions and examples ([0ae4939](https://gitlab.com/rxap/packages/commit/0ae4939d77e3e313ace4a77d8f5dd86c3c918d29))
|
|
11
|
+
|
|
6
12
|
## [20.0.5-dev.3](https://gitlab.com/rxap/packages/compare/@rxap/plugin-storybook@20.0.5-dev.2...@rxap/plugin-storybook@20.0.5-dev.3) (2025-09-18)
|
|
7
13
|
|
|
8
14
|
**Note:** Version bump only for package @rxap/plugin-storybook
|
package/README.md
CHANGED
|
@@ -34,11 +34,11 @@ nx g @rxap/plugin-storybook:init
|
|
|
34
34
|
|
|
35
35
|
Option | Type | Default | Description
|
|
36
36
|
--- | --- | --- | ---
|
|
37
|
-
project | string | |
|
|
38
|
-
projects | array | |
|
|
39
|
-
skipFormat | boolean | false |
|
|
40
|
-
overwrite | boolean | false | Whether to overwrite existing files
|
|
41
|
-
skipProjects | boolean | false | Whether to skip executing project
|
|
37
|
+
project | string | | The name of the project to initialize.
|
|
38
|
+
projects | array | | A list of projects to initialize.
|
|
39
|
+
skipFormat | boolean | false | Whether to skip formatting generated files.
|
|
40
|
+
overwrite | boolean | false | Whether to overwrite existing files.
|
|
41
|
+
skipProjects | boolean | false | Whether to skip executing project-specific initialization logic.
|
|
42
42
|
|
|
43
43
|
## init-application
|
|
44
44
|
> init-application generator
|
|
@@ -49,9 +49,9 @@ nx g @rxap/plugin-storybook:init-application
|
|
|
49
49
|
|
|
50
50
|
Option | Type | Default | Description
|
|
51
51
|
--- | --- | --- | ---
|
|
52
|
-
project | string | |
|
|
53
|
-
projects | array | |
|
|
54
|
-
overwrite | boolean | false | Whether to overwrite existing files
|
|
52
|
+
project | string | | The name of the project.
|
|
53
|
+
projects | array | | A list of projects to initialize Storybook for.
|
|
54
|
+
overwrite | boolean | false | Whether to overwrite existing files.
|
|
55
55
|
skipProjects | boolean | false | Whether to skip executing project specific initialization
|
|
56
56
|
interactionTests | boolean | true | Set up Storybook interaction tests.
|
|
57
57
|
configureCypress | boolean | | Specifies whether to configure Cypress or not.
|
|
@@ -74,9 +74,9 @@ nx g @rxap/plugin-storybook:init-library
|
|
|
74
74
|
|
|
75
75
|
Option | Type | Default | Description
|
|
76
76
|
--- | --- | --- | ---
|
|
77
|
-
project | string | |
|
|
78
|
-
projects | array | |
|
|
79
|
-
overwrite | boolean | false | Whether to overwrite existing files
|
|
77
|
+
project | string | | The name of the project.
|
|
78
|
+
projects | array | | A list of projects to initialize Storybook for.
|
|
79
|
+
overwrite | boolean | false | Whether to overwrite existing files.
|
|
80
80
|
skipProjects | boolean | false | Whether to skip executing project specific initialization
|
|
81
81
|
interactionTests | boolean | true | Set up Storybook interaction tests.
|
|
82
82
|
configureCypress | boolean | | Specifies whether to configure Cypress or not.
|
package/package.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "20.0
|
|
2
|
+
"version": "20.1.0-dev.0",
|
|
3
3
|
"name": "@rxap/plugin-storybook",
|
|
4
4
|
"description": "This package provides generators to initialize Storybook for Angular projects within an Nx workspace. It automates the configuration of Storybook, including adding dependencies, setting up configurations, and generating stories. It supports both application and library projects, and offers options to customize the setup, such as enabling Compodoc integration and skipping format checks.\n",
|
|
5
5
|
"license": "MIT",
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
},
|
|
45
45
|
"schematics": "./generators.json",
|
|
46
46
|
"type": "commonjs",
|
|
47
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "f6923aa9d989b25018f2fcac470963fb1e68049a",
|
|
48
48
|
"types": "./src/index.d.ts",
|
|
49
49
|
"main": "./src/index.js"
|
|
50
50
|
}
|
|
@@ -5,27 +5,51 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the project to initialize.",
|
|
10
|
+
"examples": [
|
|
11
|
+
"my-app"
|
|
12
|
+
]
|
|
9
13
|
},
|
|
10
14
|
"projects": {
|
|
11
15
|
"type": "array",
|
|
12
16
|
"items": {
|
|
13
17
|
"type": "string"
|
|
14
|
-
}
|
|
18
|
+
},
|
|
19
|
+
"description": "A list of projects to initialize.",
|
|
20
|
+
"examples": [
|
|
21
|
+
[
|
|
22
|
+
"app1",
|
|
23
|
+
"app2"
|
|
24
|
+
]
|
|
25
|
+
]
|
|
15
26
|
},
|
|
16
27
|
"skipFormat": {
|
|
17
28
|
"type": "boolean",
|
|
18
|
-
"default": false
|
|
29
|
+
"default": false,
|
|
30
|
+
"description": "Whether to skip formatting generated files.",
|
|
31
|
+
"examples": [
|
|
32
|
+
true,
|
|
33
|
+
false
|
|
34
|
+
]
|
|
19
35
|
},
|
|
20
36
|
"overwrite": {
|
|
21
37
|
"type": "boolean",
|
|
22
38
|
"default": false,
|
|
23
|
-
"description": "Whether to overwrite existing files"
|
|
39
|
+
"description": "Whether to overwrite existing files.",
|
|
40
|
+
"examples": [
|
|
41
|
+
true,
|
|
42
|
+
false
|
|
43
|
+
]
|
|
24
44
|
},
|
|
25
45
|
"skipProjects": {
|
|
26
46
|
"type": "boolean",
|
|
27
47
|
"default": false,
|
|
28
|
-
"description": "Whether to skip executing project
|
|
48
|
+
"description": "Whether to skip executing project-specific initialization logic.",
|
|
49
|
+
"examples": [
|
|
50
|
+
true,
|
|
51
|
+
false
|
|
52
|
+
]
|
|
29
53
|
}
|
|
30
54
|
},
|
|
31
55
|
"required": []
|
|
@@ -5,72 +5,126 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the project.",
|
|
10
|
+
"examples": [
|
|
11
|
+
"my-app"
|
|
12
|
+
]
|
|
9
13
|
},
|
|
10
14
|
"projects": {
|
|
11
15
|
"type": "array",
|
|
12
16
|
"items": {
|
|
13
17
|
"type": "string"
|
|
14
|
-
}
|
|
18
|
+
},
|
|
19
|
+
"description": "A list of projects to initialize Storybook for.",
|
|
20
|
+
"examples": [
|
|
21
|
+
[
|
|
22
|
+
"app1",
|
|
23
|
+
"app2"
|
|
24
|
+
]
|
|
25
|
+
]
|
|
15
26
|
},
|
|
16
27
|
"overwrite": {
|
|
17
28
|
"type": "boolean",
|
|
18
29
|
"default": false,
|
|
19
|
-
"description": "Whether to overwrite existing files"
|
|
30
|
+
"description": "Whether to overwrite existing files.",
|
|
31
|
+
"examples": [
|
|
32
|
+
true,
|
|
33
|
+
false
|
|
34
|
+
]
|
|
20
35
|
},
|
|
21
36
|
"skipProjects": {
|
|
22
37
|
"type": "boolean",
|
|
23
38
|
"default": false,
|
|
24
|
-
"description": "Whether to skip executing project specific initialization"
|
|
39
|
+
"description": "Whether to skip executing project specific initialization",
|
|
40
|
+
"examples": [
|
|
41
|
+
true,
|
|
42
|
+
false
|
|
43
|
+
]
|
|
25
44
|
},
|
|
26
45
|
"interactionTests": {
|
|
27
46
|
"type": "boolean",
|
|
28
47
|
"description": "Set up Storybook interaction tests.",
|
|
29
48
|
"alias": ["configureTestRunner"],
|
|
30
49
|
"x-priority": "important",
|
|
31
|
-
"default": true
|
|
50
|
+
"default": true,
|
|
51
|
+
"examples": [
|
|
52
|
+
true,
|
|
53
|
+
false
|
|
54
|
+
]
|
|
32
55
|
},
|
|
33
56
|
"configureCypress": {
|
|
34
57
|
"type": "boolean",
|
|
35
|
-
"description": "Specifies whether to configure Cypress or not."
|
|
58
|
+
"description": "Specifies whether to configure Cypress or not.",
|
|
59
|
+
"examples": [
|
|
60
|
+
true,
|
|
61
|
+
false
|
|
62
|
+
]
|
|
36
63
|
},
|
|
37
64
|
"generateStories": {
|
|
38
65
|
"type": "boolean",
|
|
39
66
|
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
|
|
40
67
|
"default": true,
|
|
41
|
-
"x-priority": "important"
|
|
68
|
+
"x-priority": "important",
|
|
69
|
+
"examples": [
|
|
70
|
+
true,
|
|
71
|
+
false
|
|
72
|
+
]
|
|
42
73
|
},
|
|
43
74
|
"generateCypressSpecs": {
|
|
44
75
|
"type": "boolean",
|
|
45
|
-
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app."
|
|
76
|
+
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
|
|
77
|
+
"examples": [
|
|
78
|
+
true,
|
|
79
|
+
false
|
|
80
|
+
]
|
|
46
81
|
},
|
|
47
82
|
"configureStaticServe": {
|
|
48
83
|
"type": "boolean",
|
|
49
84
|
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
|
|
50
85
|
"default": true,
|
|
51
|
-
"x-priority": "important"
|
|
86
|
+
"x-priority": "important",
|
|
87
|
+
"examples": [
|
|
88
|
+
true,
|
|
89
|
+
false
|
|
90
|
+
]
|
|
52
91
|
},
|
|
53
92
|
"cypressDirectory": {
|
|
54
93
|
"type": "string",
|
|
55
|
-
"description": "A directory where the Cypress project will be placed. Placed at the root by default."
|
|
94
|
+
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
|
|
95
|
+
"examples": [
|
|
96
|
+
"apps/my-app-e2e"
|
|
97
|
+
]
|
|
56
98
|
},
|
|
57
99
|
"linter": {
|
|
58
100
|
"description": "The tool to use for running lint checks.",
|
|
59
101
|
"type": "string",
|
|
60
102
|
"enum": ["eslint", "none"],
|
|
61
|
-
"default": "eslint"
|
|
103
|
+
"default": "eslint",
|
|
104
|
+
"examples": [
|
|
105
|
+
"eslint",
|
|
106
|
+
"none"
|
|
107
|
+
]
|
|
62
108
|
},
|
|
63
109
|
"tsConfiguration": {
|
|
64
110
|
"type": "boolean",
|
|
65
111
|
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
|
|
66
112
|
"default": true,
|
|
67
|
-
"x-priority": "important"
|
|
113
|
+
"x-priority": "important",
|
|
114
|
+
"examples": [
|
|
115
|
+
true,
|
|
116
|
+
false
|
|
117
|
+
]
|
|
68
118
|
},
|
|
69
119
|
"skipFormat": {
|
|
70
120
|
"description": "Skip formatting files.",
|
|
71
121
|
"type": "boolean",
|
|
72
122
|
"default": false,
|
|
73
|
-
"x-priority": "internal"
|
|
123
|
+
"x-priority": "internal",
|
|
124
|
+
"examples": [
|
|
125
|
+
true,
|
|
126
|
+
false
|
|
127
|
+
]
|
|
74
128
|
},
|
|
75
129
|
"ignorePaths": {
|
|
76
130
|
"type": "array",
|
|
@@ -90,7 +144,11 @@
|
|
|
90
144
|
"compodoc": {
|
|
91
145
|
"type": "boolean",
|
|
92
146
|
"description": "Generate documentation using Compodoc.",
|
|
93
|
-
"default": true
|
|
147
|
+
"default": true,
|
|
148
|
+
"examples": [
|
|
149
|
+
true,
|
|
150
|
+
false
|
|
151
|
+
]
|
|
94
152
|
}
|
|
95
153
|
},
|
|
96
154
|
"required": []
|
|
@@ -5,72 +5,126 @@
|
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"project": {
|
|
8
|
-
"type": "string"
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "The name of the project.",
|
|
10
|
+
"examples": [
|
|
11
|
+
"my-lib"
|
|
12
|
+
]
|
|
9
13
|
},
|
|
10
14
|
"projects": {
|
|
11
15
|
"type": "array",
|
|
12
16
|
"items": {
|
|
13
17
|
"type": "string"
|
|
14
|
-
}
|
|
18
|
+
},
|
|
19
|
+
"description": "A list of projects to initialize Storybook for.",
|
|
20
|
+
"examples": [
|
|
21
|
+
[
|
|
22
|
+
"lib1",
|
|
23
|
+
"lib2"
|
|
24
|
+
]
|
|
25
|
+
]
|
|
15
26
|
},
|
|
16
27
|
"overwrite": {
|
|
17
28
|
"type": "boolean",
|
|
18
29
|
"default": false,
|
|
19
|
-
"description": "Whether to overwrite existing files"
|
|
30
|
+
"description": "Whether to overwrite existing files.",
|
|
31
|
+
"examples": [
|
|
32
|
+
true,
|
|
33
|
+
false
|
|
34
|
+
]
|
|
20
35
|
},
|
|
21
36
|
"skipProjects": {
|
|
22
37
|
"type": "boolean",
|
|
23
38
|
"default": false,
|
|
24
|
-
"description": "Whether to skip executing project specific initialization"
|
|
39
|
+
"description": "Whether to skip executing project specific initialization",
|
|
40
|
+
"examples": [
|
|
41
|
+
true,
|
|
42
|
+
false
|
|
43
|
+
]
|
|
25
44
|
},
|
|
26
45
|
"interactionTests": {
|
|
27
46
|
"type": "boolean",
|
|
28
47
|
"description": "Set up Storybook interaction tests.",
|
|
29
48
|
"alias": ["configureTestRunner"],
|
|
30
49
|
"x-priority": "important",
|
|
31
|
-
"default": true
|
|
50
|
+
"default": true,
|
|
51
|
+
"examples": [
|
|
52
|
+
true,
|
|
53
|
+
false
|
|
54
|
+
]
|
|
32
55
|
},
|
|
33
56
|
"configureCypress": {
|
|
34
57
|
"type": "boolean",
|
|
35
|
-
"description": "Specifies whether to configure Cypress or not."
|
|
58
|
+
"description": "Specifies whether to configure Cypress or not.",
|
|
59
|
+
"examples": [
|
|
60
|
+
true,
|
|
61
|
+
false
|
|
62
|
+
]
|
|
36
63
|
},
|
|
37
64
|
"generateStories": {
|
|
38
65
|
"type": "boolean",
|
|
39
66
|
"description": "Specifies whether to automatically generate `*.stories.ts` files for components declared in this project or not.",
|
|
40
67
|
"default": true,
|
|
41
|
-
"x-priority": "important"
|
|
68
|
+
"x-priority": "important",
|
|
69
|
+
"examples": [
|
|
70
|
+
true,
|
|
71
|
+
false
|
|
72
|
+
]
|
|
42
73
|
},
|
|
43
74
|
"generateCypressSpecs": {
|
|
44
75
|
"type": "boolean",
|
|
45
|
-
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app."
|
|
76
|
+
"description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
|
|
77
|
+
"examples": [
|
|
78
|
+
true,
|
|
79
|
+
false
|
|
80
|
+
]
|
|
46
81
|
},
|
|
47
82
|
"configureStaticServe": {
|
|
48
83
|
"type": "boolean",
|
|
49
84
|
"description": "Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.",
|
|
50
85
|
"default": true,
|
|
51
|
-
"x-priority": "important"
|
|
86
|
+
"x-priority": "important",
|
|
87
|
+
"examples": [
|
|
88
|
+
true,
|
|
89
|
+
false
|
|
90
|
+
]
|
|
52
91
|
},
|
|
53
92
|
"cypressDirectory": {
|
|
54
93
|
"type": "string",
|
|
55
|
-
"description": "A directory where the Cypress project will be placed. Placed at the root by default."
|
|
94
|
+
"description": "A directory where the Cypress project will be placed. Placed at the root by default.",
|
|
95
|
+
"examples": [
|
|
96
|
+
"libs/my-lib-e2e"
|
|
97
|
+
]
|
|
56
98
|
},
|
|
57
99
|
"linter": {
|
|
58
100
|
"description": "The tool to use for running lint checks.",
|
|
59
101
|
"type": "string",
|
|
60
102
|
"enum": ["eslint", "none"],
|
|
61
|
-
"default": "eslint"
|
|
103
|
+
"default": "eslint",
|
|
104
|
+
"examples": [
|
|
105
|
+
"eslint",
|
|
106
|
+
"none"
|
|
107
|
+
]
|
|
62
108
|
},
|
|
63
109
|
"tsConfiguration": {
|
|
64
110
|
"type": "boolean",
|
|
65
111
|
"description": "Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.",
|
|
66
112
|
"default": true,
|
|
67
|
-
"x-priority": "important"
|
|
113
|
+
"x-priority": "important",
|
|
114
|
+
"examples": [
|
|
115
|
+
true,
|
|
116
|
+
false
|
|
117
|
+
]
|
|
68
118
|
},
|
|
69
119
|
"skipFormat": {
|
|
70
120
|
"description": "Skip formatting files.",
|
|
71
121
|
"type": "boolean",
|
|
72
122
|
"default": false,
|
|
73
|
-
"x-priority": "internal"
|
|
123
|
+
"x-priority": "internal",
|
|
124
|
+
"examples": [
|
|
125
|
+
true,
|
|
126
|
+
false
|
|
127
|
+
]
|
|
74
128
|
},
|
|
75
129
|
"ignorePaths": {
|
|
76
130
|
"type": "array",
|
|
@@ -90,7 +144,11 @@
|
|
|
90
144
|
"compodoc": {
|
|
91
145
|
"type": "boolean",
|
|
92
146
|
"description": "Generate documentation using Compodoc.",
|
|
93
|
-
"default": true
|
|
147
|
+
"default": true,
|
|
148
|
+
"examples": [
|
|
149
|
+
true,
|
|
150
|
+
false
|
|
151
|
+
]
|
|
94
152
|
}
|
|
95
153
|
},
|
|
96
154
|
"required": []
|