@sap-ux/create 0.11.36 → 0.11.38
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 +25 -25
- package/dist/cli/convert/preview.js +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# @sap-ux/create
|
|
2
2
|
Module which provides command line interface to configure features for SAP UX projects or applications.
|
|
3
3
|
|
|
4
|
-
## Installation
|
|
4
|
+
## [Installation](#installation)
|
|
5
5
|
|
|
6
6
|
```sh
|
|
7
7
|
npm init @sap-ux@latest
|
|
@@ -16,7 +16,7 @@ sap-ux
|
|
|
16
16
|
# locally
|
|
17
17
|
npx sap-ux
|
|
18
18
|
```
|
|
19
|
-
## Basic usage
|
|
19
|
+
## [Basic usage](#basic-usage)
|
|
20
20
|
|
|
21
21
|
```sh
|
|
22
22
|
npx sap-ux [command] [sub-command] /path/to/project
|
|
@@ -27,7 +27,7 @@ Options:
|
|
|
27
27
|
- `-v | --version` output the module version number
|
|
28
28
|
- `-h | --help` display help and options for module
|
|
29
29
|
|
|
30
|
-
### Command Options
|
|
30
|
+
### [Command Options](#command-options)
|
|
31
31
|
|
|
32
32
|
To use a option for a specific command run:
|
|
33
33
|
```sh
|
|
@@ -40,7 +40,7 @@ Common Options:
|
|
|
40
40
|
- `-v | --verbose` show verbose information
|
|
41
41
|
- `-s | --simulate` simulate only do not write config; sets also --verbose
|
|
42
42
|
|
|
43
|
-
## Command Overview
|
|
43
|
+
## [Command Overview](#command-overview)
|
|
44
44
|
The `@sap-ux/create` modules provides commands for the following cases:
|
|
45
45
|
- `sap-ux add` - allows adding a feature
|
|
46
46
|
- `sap-ux change` allows changing a feature
|
|
@@ -49,11 +49,11 @@ The `@sap-ux/create` modules provides commands for the following cases:
|
|
|
49
49
|
- `sap-ux generate` allows generating a new project
|
|
50
50
|
|
|
51
51
|
|
|
52
|
-
## sap-ux add
|
|
52
|
+
## [sap-ux add](#sap-ux-add)
|
|
53
53
|
Calling `sap-ux add` allows adding a feature to a project.
|
|
54
54
|
|
|
55
55
|
|
|
56
|
-
### annotations
|
|
56
|
+
### [annotations](#add-annotations)<a id="add-annotations"></a>
|
|
57
57
|
Calling `sap-ux add annotations` allows adding an annotation to the OData Source of the base application in an adaptation project.
|
|
58
58
|
```sh
|
|
59
59
|
sap-ux add annotations [path]
|
|
@@ -61,21 +61,21 @@ sap-ux add annotations [path]
|
|
|
61
61
|
- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
|
|
62
62
|
|
|
63
63
|
|
|
64
|
-
### cards-editor
|
|
64
|
+
### [cards-editor](#add-cards-editor)<a id="add-cards-editor"></a>
|
|
65
65
|
Calling `sap-ux add cards-editor` adds a cards editor configuration to a project. To prevent overwriting, existing inbounds will be checked.
|
|
66
66
|
```sh
|
|
67
67
|
sap-ux add cards-editor [path]
|
|
68
68
|
```
|
|
69
69
|
- `-n | --skip-install` skip npm install step
|
|
70
70
|
|
|
71
|
-
### component-usages
|
|
71
|
+
### [component-usages](#add-component-usages)<a id="add-component-usages"></a>
|
|
72
72
|
Calling `sap-ux add component-usages` adds the component usages to an adaptation project.
|
|
73
73
|
```sh
|
|
74
74
|
sap-ux add component-usages [path]
|
|
75
75
|
```
|
|
76
76
|
|
|
77
77
|
|
|
78
|
-
### cds-plugin-ui5
|
|
78
|
+
### [cds-plugin-ui5](#add-cds-plugin-ui5)<a id="add-cds-plugin-ui5"></a>
|
|
79
79
|
Calling `sap-ux add cds-plugin-ui5` adds the cds-plugin-ui5 and all prerequisites to a CAP project.
|
|
80
80
|
```sh
|
|
81
81
|
sap-ux add cds-plugin-ui5 [path]
|
|
@@ -83,7 +83,7 @@ sap-ux add cds-plugin-ui5 [path]
|
|
|
83
83
|
- `-n | --skip-install` skip npm install step
|
|
84
84
|
|
|
85
85
|
|
|
86
|
-
### deploy-config
|
|
86
|
+
### [deploy-config](#add-deploy-config)<a id="add-deploy-config"></a>
|
|
87
87
|
Calling `sap-ux add deploy-config` will prompt for ABAP deployment configuration details and add/update the project files accordingly.
|
|
88
88
|
```sh
|
|
89
89
|
sap-ux add deploy-config [path]
|
|
@@ -93,20 +93,20 @@ sap-ux add deploy-config [path]
|
|
|
93
93
|
- `-d | --deploy-file` the name of the deploy config file to be written; default: ui5-deploy.yaml
|
|
94
94
|
|
|
95
95
|
|
|
96
|
-
### html
|
|
96
|
+
### [html](#add-html)<a id="add-html"></a>
|
|
97
97
|
Calling `sap-ux add html` will add html files for local preview and testing to the project. It will use the configuration from the `ui5.yaml` as default, as provided by the `fiori-tools-preview` or `preview-middleware`.
|
|
98
98
|
```sh
|
|
99
99
|
sap-ux add html [path]
|
|
100
100
|
```
|
|
101
101
|
- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
|
|
102
102
|
|
|
103
|
-
### model
|
|
103
|
+
### [model](#add-model)<a id="add-model"></a>
|
|
104
104
|
Calling `sap-ux add model` allows to add new OData Service and SAPUI5 Model to an existing adaptation project.
|
|
105
105
|
```sh
|
|
106
106
|
sap-ux add model [path]
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
-
### mockserver-config
|
|
109
|
+
### [mockserver-config](#add-mockserver-config)<a id="add-mockserver-config"></a>
|
|
110
110
|
Calling `sap-ux add mockserver-config` adds the necessary configuration for mockserver module @sap-ux/ui5-middleware-fe-mockserver.
|
|
111
111
|
```sh
|
|
112
112
|
sap-ux add mockserver-config [path]
|
|
@@ -114,55 +114,55 @@ sap-ux add mockserver-config [path]
|
|
|
114
114
|
- `-i | --interactive` ask for config options, otherwise use defaults'
|
|
115
115
|
- `-n | --skip-install` skip npm install step
|
|
116
116
|
|
|
117
|
-
### smartlinks-config
|
|
117
|
+
### [smartlinks-config](#add-smartlinks-config)<a id="add-smartlinks-config"></a>
|
|
118
118
|
Calling `sap-ux add smartlinks-config` adds a smartLinks configuration to a project
|
|
119
119
|
```sh
|
|
120
120
|
sap-ux add smartlinks-config [path]
|
|
121
121
|
```
|
|
122
122
|
|
|
123
|
-
### add inbound-navigation
|
|
123
|
+
### [add inbound-navigation](#add-inbound-navigation)<a id="add-inbound-navigation"></a>
|
|
124
124
|
Calling `sap-ux add inbound-navigation` adds a Fiori Launchpad configuration to a project.
|
|
125
125
|
```sh
|
|
126
126
|
sap-ux add inbound-navigation [path]
|
|
127
127
|
```
|
|
128
128
|
|
|
129
|
-
### variants-config
|
|
129
|
+
### [variants-config](#add-variants-config)<a id="add-variants-config"></a>
|
|
130
130
|
Calling `sap-ux add variants-config` will add the necessary configuration to an existing yaml file and the script to package.json for variants creation. It will use the configuration from the yaml file passed by cli or default to `ui5.yaml`, as provided by the `fiori-tools-preview` or `preview-middleware`.
|
|
131
131
|
```sh
|
|
132
132
|
sap-ux add variants-config [path]
|
|
133
133
|
```
|
|
134
134
|
- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
|
|
135
135
|
|
|
136
|
-
## sap-ux change
|
|
136
|
+
## [sap-ux change](#sap-ux-change)
|
|
137
137
|
Calling `sap-ux change` allows changing a feature of a project.
|
|
138
138
|
|
|
139
|
-
### data-source
|
|
139
|
+
### [data-source](#change-data-source)<a id="change-data-source"></a>
|
|
140
140
|
Calling `sap-ux change data-source` allows replacing the OData Source of the base application in an adaptation project.
|
|
141
141
|
```sh
|
|
142
142
|
sap-ux change data-source [path]
|
|
143
143
|
```
|
|
144
144
|
- `-c | --config` path to project configuration file in YAML format, e.g.: `-c ui5Custom.yaml`
|
|
145
145
|
|
|
146
|
-
### inbound
|
|
146
|
+
### [inbound](#change-inbound)<a id="change-inbound"></a>
|
|
147
147
|
Calling `sap-ux change inbound` allows replacing the Inbound FLP configurations of the base application in an adaptation project.
|
|
148
148
|
```sh
|
|
149
149
|
sap-ux change inbound [path]
|
|
150
150
|
```
|
|
151
151
|
|
|
152
|
-
## sap-ux convert
|
|
152
|
+
## [sap-ux convert](#sap-ux-convert)
|
|
153
153
|
Executing `sap-ux convert` converts an app to a new feature.
|
|
154
154
|
|
|
155
|
-
### preview
|
|
155
|
+
### [preview-config](#convert-preview-config)<a id="convert-preview-config"></a>
|
|
156
156
|
Executing `sap-ux convert preview-config` in the root folder of an app will convert the respective app to the preview with virtual files. It will use the configuration from the scripts in the `package.json` file to adjust the UI5 configuration YAML files accordingly. The obsolete JS and TS sources will be deleted and the HTML files previously used for the preview will be renamed to `*_old.html`.
|
|
157
157
|
```sh
|
|
158
158
|
sap-ux convert preview-config [path]
|
|
159
159
|
```
|
|
160
160
|
- `-t | --tests` include test suite and test runners in the conversion to virtual files
|
|
161
161
|
|
|
162
|
-
## sap-ux remove
|
|
162
|
+
## [sap-ux remove](#sap-ux-remove)
|
|
163
163
|
Calling `sap-ux remove` allows removing a feature from a project.
|
|
164
164
|
|
|
165
|
-
### mockserver-config
|
|
165
|
+
### [mockserver-config](#remove-mockserver-config)<a id="remove-mockserver-config"></a>
|
|
166
166
|
Calling `sap-ux remove mockserver-config` removes the configuration for mockserver module @sap-ux/ui5-middleware-fe-mockserver.
|
|
167
167
|
```sh
|
|
168
168
|
sap-ux remove mockserver-config [path]
|
|
@@ -170,10 +170,10 @@ sap-ux remove mockserver-config [path]
|
|
|
170
170
|
- `-f | --force` do not ask for confirmation when deleting files
|
|
171
171
|
|
|
172
172
|
|
|
173
|
-
## sap-ux generate
|
|
173
|
+
## [sap-ux generate](#sap-ux-generate)
|
|
174
174
|
Calling `sap-ux generate` allows generating a new project.
|
|
175
175
|
|
|
176
|
-
### adaptation-project
|
|
176
|
+
### [adaptation-project](#adaptation-project)
|
|
177
177
|
Calling `sap-ux generate adaptation-project` allows generating a new adaptation project. Without further parameters the CLI will prompt the required parameters `id`, `reference` and `url`. To run the prompt non-interactively, it is also possible to execute
|
|
178
178
|
```sh
|
|
179
179
|
sap-ux generate adaptation-project --id my.adp --reference the.original.app --url http://my.sapsystem.example
|
|
@@ -32,7 +32,7 @@ async function convertPreview(basePath, simulate, convertTests) {
|
|
|
32
32
|
if (!basePath) {
|
|
33
33
|
basePath = process.cwd();
|
|
34
34
|
}
|
|
35
|
-
logger.debug(`Called convert preview for path '${basePath}'
|
|
35
|
+
logger.debug(`Called convert preview-config for path '${basePath}', simulate is '${simulate}'.`);
|
|
36
36
|
try {
|
|
37
37
|
const fs = await (0, app_config_writer_1.convertToVirtualPreview)(basePath, { convertTests, logger });
|
|
38
38
|
if (!simulate) {
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sap-ux/create",
|
|
3
3
|
"description": "SAP Fiori tools module to add or remove features",
|
|
4
|
-
"version": "0.11.
|
|
4
|
+
"version": "0.11.38",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
7
7
|
"url": "https://github.com/SAP/open-ux-tools.git",
|
|
@@ -30,16 +30,16 @@
|
|
|
30
30
|
"mem-fs": "2.1.0",
|
|
31
31
|
"mem-fs-editor": "9.4.0",
|
|
32
32
|
"prompts": "2.4.2",
|
|
33
|
+
"@sap-ux/abap-deploy-config-inquirer": "1.2.1",
|
|
33
34
|
"@sap-ux/abap-deploy-config-writer": "0.0.75",
|
|
34
|
-
"@sap-ux/app-config-writer": "0.5.15",
|
|
35
35
|
"@sap-ux/adp-tooling": "0.12.112",
|
|
36
|
-
"@sap-ux/
|
|
37
|
-
"@sap-ux/cap-config-writer": "0.8.
|
|
36
|
+
"@sap-ux/app-config-writer": "0.5.16",
|
|
37
|
+
"@sap-ux/cap-config-writer": "0.8.2",
|
|
38
38
|
"@sap-ux/cards-editor-config-writer": "0.4.8",
|
|
39
39
|
"@sap-ux/logger": "0.6.0",
|
|
40
40
|
"@sap-ux/mockserver-config-writer": "0.7.1",
|
|
41
|
-
"@sap-ux/preview-middleware": "0.16.174",
|
|
42
41
|
"@sap-ux/odata-service-writer": "0.25.3",
|
|
42
|
+
"@sap-ux/preview-middleware": "0.16.174",
|
|
43
43
|
"@sap-ux/project-access": "1.29.0",
|
|
44
44
|
"@sap-ux/system-access": "0.5.26",
|
|
45
45
|
"@sap-ux/ui5-config": "0.26.0",
|