@elo/elo-cli 1.0.2 → 1.0.3
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 +15 -8
- package/package.json +2 -2
- package/sbom.json +1 -1
package/README.md
CHANGED
|
@@ -87,11 +87,11 @@ Install elo-cli as a development dependency in the project:
|
|
|
87
87
|
This installs elo-cli as a devDependency so it can be used in the project context. The cli command
|
|
88
88
|
**elo** is not directly available, but can only be used via npx elo or an npm script.
|
|
89
89
|
|
|
90
|
-
For the initial setup, a global settings file must be created. This is done with the [setup](setup
|
|
90
|
+
For the initial setup, a global settings file must be created. This is done with the [setup](#setup) command.
|
|
91
91
|
|
|
92
92
|
npx elo setup
|
|
93
93
|
|
|
94
|
-
Inputs see [Setup](setup
|
|
94
|
+
Inputs see [Setup](#setup).
|
|
95
95
|
|
|
96
96
|
This creates a file `.elo-cli-settings.json` in the user directory. It stores a default developer archive access
|
|
97
97
|
and general (typically unchanging) development data (default language, namespace, etc.).
|
|
@@ -101,7 +101,7 @@ flag `--repository` and the name of the access (in this case 'dev').
|
|
|
101
101
|
|
|
102
102
|
npx elo setup --repository dev
|
|
103
103
|
|
|
104
|
-
Inputs see [Setup](setup
|
|
104
|
+
Inputs see [Setup](#setup).
|
|
105
105
|
|
|
106
106
|
Specific archives for the project are stored in the `.elo-repository` directory. This makes it possible to store separate
|
|
107
107
|
connection data for CI/CD or shared ELO servers and to check them into source control together with the app code.
|
|
@@ -117,9 +117,16 @@ library @elo/elo-base-lib.
|
|
|
117
117
|
|
|
118
118
|
npm install @elo/elo-base-lib
|
|
119
119
|
|
|
120
|
+
In order to import client types, the library @elo/ix-client-typescript is also needed.
|
|
121
|
+
|
|
122
|
+
npm install @elo/ix-client-typescript
|
|
123
|
+
|
|
124
|
+
Both libraries are available for different ELO versions. Specific version are taged e.g. "release-25-0" will point to
|
|
125
|
+
the newest ELO 25 LTS version. The "latest" tag points to the last published feature version.
|
|
126
|
+
|
|
120
127
|
Connect the app to the ELOwf; the app will be marked as 'In Development'.
|
|
121
128
|
This instructs the ELOwf to allow the app during a login attempt and redirect to the local
|
|
122
|
-
development server. Use the [init](init
|
|
129
|
+
development server. Use the [init](#init) command with the flag --repository and the name of the
|
|
123
130
|
archive access (in this case 'dev').
|
|
124
131
|
|
|
125
132
|
npx elo init --repository dev
|
|
@@ -212,7 +219,7 @@ The entries in this file should be written in the default language (see manifest
|
|
|
212
219
|
APP.FAREWELL=Goodbye!
|
|
213
220
|
|
|
214
221
|
To use the language files in the app, they must be converted into a JavaScript file. This
|
|
215
|
-
is done with the [localize](localize
|
|
222
|
+
is done with the [localize](#localize) command:
|
|
216
223
|
|
|
217
224
|
npx elo localize --src locales/ --dist src/jsLocales/
|
|
218
225
|
|
|
@@ -247,13 +254,13 @@ Build the app with the command:
|
|
|
247
254
|
|
|
248
255
|
The built app is located in the *dist/* directory.
|
|
249
256
|
|
|
250
|
-
To prepare the app for deployment, use the [build](build
|
|
257
|
+
To prepare the app for deployment, use the [build](#build) command:
|
|
251
258
|
|
|
252
259
|
npx elo build
|
|
253
260
|
|
|
254
261
|
This adjusts the index.html so that devData.js is no longer loaded and the data is loaded via relative ELOwf URLs.
|
|
255
262
|
|
|
256
|
-
The app can now be packaged as a ZIP file and deployed in ELOwf. This is done via the [deploy](deploy
|
|
263
|
+
The app can now be packaged as a ZIP file and deployed in ELOwf. This is done via the [deploy](#deploy)
|
|
257
264
|
command:
|
|
258
265
|
|
|
259
266
|
npx elo deploy --repository dev
|
|
@@ -270,7 +277,7 @@ In the archive, the app can be found under Administration/ELOapps/Apps/<namespac
|
|
|
270
277
|
To further develop the app, the steps Initialization, Localization, Build, and Deployment
|
|
271
278
|
can be repeated as often as desired.
|
|
272
279
|
|
|
273
|
-
With the [init](init
|
|
280
|
+
With the [init](#init) command, the installed app is removed and the manifest with the devRedirect is re-imported.
|
|
274
281
|
The app remains in the archive and is again in the 'In Development' state. It can then either be overwritten with a new
|
|
275
282
|
version via elo-cli (deploy) or reset to the archived version (install) via AppManager.
|
|
276
283
|
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"publishConfig": {
|
|
4
4
|
"access": "public"
|
|
5
5
|
},
|
|
6
|
-
"version": "1.0.
|
|
6
|
+
"version": "1.0.3",
|
|
7
7
|
"description": "ELO Apps command line build system for Node.js.",
|
|
8
8
|
"keywords": [
|
|
9
9
|
"@elo/elo-cli",
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
"create-vh": "npx elo-vh create --create-config ./elo-vh.env --no-release-date --no-release-version"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"@elo/ix-client-typescript": "
|
|
50
|
+
"@elo/ix-client-typescript": "latest",
|
|
51
51
|
"archiver": "7.0.1",
|
|
52
52
|
"axios": "1.13.6",
|
|
53
53
|
"axios-cookiejar-support": "6.0.5",
|