@elo/elo-cli 1.0.2 → 1.0.4

package/README.md

@@ -87,11 +87,11 @@ Install elo-cli as a development dependency in the project:
 This installs elo-cli as a devDependency so it can be used in the project context. The cli command
 **elo** is not directly available, but can only be used via npx elo or an npm script.
 
-For the initial setup, a global settings file must be created. This is done with the [setup](setup.md) command.
+For the initial setup, a global settings file must be created. This is done with the [setup](#setup) command.
 
     npx elo setup
 
-Inputs see [Setup](setup.md).
+Inputs see [Setup](#setup).
 
 This creates a file `.elo-cli-settings.json` in the user directory. It stores a default developer archive access
 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').
 
     npx elo setup --repository dev
 
-Inputs see [Setup](setup.md).
+Inputs see [Setup](#setup).
 
 Specific archives for the project are stored in the `.elo-repository` directory. This makes it possible to store separate
 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.
 
     npm install @elo/elo-base-lib
 
+In order to import client types, the library @elo/ix-client-typescript is also needed.
+
+    npm install @elo/ix-client-typescript
+
+Both libraries are available for different ELO versions. Specific version are taged e.g. "release-25-0" will point to 
+the newest ELO 25 LTS version. The "latest" tag points to the last published feature version.
+
 Connect the app to the ELOwf; the app will be marked as 'In Development'.
 This instructs the ELOwf to allow the app during a login attempt and redirect to the local
-development server. Use the [init](init.md) command with the flag --repository and the name of the
+development server. Use the [init](#init) command with the flag --repository and the name of the
 archive access (in this case 'dev').
 
     npx elo init --repository dev
@@ -127,7 +134,7 @@ archive access (in this case 'dev').
 Inputs:
 - **use_sordType_icons**: n Are Sord type icons needed in the app (injects a CSS file from ELOwf).
 - **use_archive_icons**: n Are archive icons needed in the app (injects a CSS file from ELOwf).
-- **indexHtmlPath**: public/
+- **indexHtmlPath**: .
 - **id**: my-project
 - **build_number**: 0
 - **useELOSession**: y
@@ -140,9 +147,9 @@ After initialization, the following files are present in the project:
 - .elo-current-repository - contains the name of the currently used repository (in this case 'dev').
 
 The following files still need to be adjusted; this is also indicated in the console:
-- main.ts - contains the code for loading the ELO libraries.
-
+**main.ts** - contains the code for loading the ELO libraries.
 
+```
     import { createApp } from 'vue'
     import { initEloBaseServices, ixService, logger } from '@elo/elo-base-lib';
     import { LockC, EditInfoC } from '@elo/ix-client-typescript';
@@ -166,7 +173,7 @@ The following files still need to be adjusted; this is also indicated in the con
     } catch (error) {
         logger.error('Failed to initialize ELO Base Lib:', error);
     }
-
+```
 
 
 **vite.config.ts** - contains proxy settings for accessing the ELOwf during development; additionally, the
@@ -174,7 +181,7 @@ base path is set to ''. This links scripts relatively and ensures that the app w
 ELOwf and on the local development server. The TestHelpers allow access to the
 archive configuration of the setup command.
 
-
+```
     import { defineConfig, ProxyOptions } from 'vite'
     import TestHelpers from '@elo/elo-cli'; // load global config from elo-cli
     ...
@@ -195,6 +202,7 @@ archive configuration of the setup command.
       changeOrigin: true
     };
     export default defineConfig(config);
+```
 
 ### Localization
 
@@ -212,7 +220,7 @@ The entries in this file should be written in the default language (see manifest
     APP.FAREWELL=Goodbye!
 
 To use the language files in the app, they must be converted into a JavaScript file. This
-is done with the [localize](localize.md) command:
+is done with the [localize](#localize) command:
 
     npx elo localize --src locales/ --dist src/jsLocales/
 
@@ -225,7 +233,7 @@ The entries can then be accessed via the singleton instance ``text.getText(key)`
 
     import { text } from '@elo/elo-base-lib';
     ...
-    logger.info(text.getText("APP.NAME");
+    logger.info(text.getText("APP.GREETINGS"));
 
 ### Starting the App
 
@@ -236,8 +244,8 @@ To start the app on a local development server, use the command:
 The server starts on the port specified in vite.config.ts (here 5173) and sets up a proxy to the ELO archive
 as specified in dev.json.
 
-A request to http://localhost:5173 starts the app, a request to http://localhost:5173/repository/* is
-forwarded to the ELO archive http://elo:9090/repository/*.
+A request to http://localhost:5173 starts the app, any request to http://localhost:5173/repository/ is
+forwarded to the ELO archive http://elo:9090/repository/.
 
 ### Build and Deployment
 
@@ -247,13 +255,13 @@ Build the app with the command:
 
 The built app is located in the *dist/* directory.
 
-To prepare the app for deployment, use the [build](build.md) command:
+To prepare the app for deployment, use the [build](#build) command:
 
     npx elo build
 
 This adjusts the index.html so that devData.js is no longer loaded and the data is loaded via relative ELOwf URLs.
 
-The app can now be packaged as a ZIP file and deployed in ELOwf. This is done via the [deploy](deploy.md)
+The app can now be packaged as a ZIP file and deployed in ELOwf. This is done via the [deploy](#deploy)
 command:
 
     npx elo deploy --repository dev
@@ -270,7 +278,7 @@ In the archive, the app can be found under Administration/ELOapps/Apps/<namespac
 To further develop the app, the steps Initialization, Localization, Build, and Deployment
 can be repeated as often as desired.
 
-With the [init](init.md) command, the installed app is removed and the manifest with the devRedirect is re-imported.
+With the [init](#init) command, the installed app is removed and the manifest with the devRedirect is re-imported.
 The app remains in the archive and is again in the 'In Development' state. It can then either be overwritten with a new
 version via elo-cli (deploy) or reset to the archived version (install) via AppManager.
 

package/dist/index.js

@@ -2138,7 +2138,10 @@ const initCommand = new Command("init").description("Init the project").option("
 ).option(
   "--indexHtmlPath <string>",
   "The relative path where the index.html file is located, for example in Vue2: public/ for Vue3 it is ."
-).option("--namespace <string>", "The app namespace, for example: my.example.namespace").option("--id <string>", "The app id, for example: exampleId").option("--default_lang <string>", "The default language, for example: de").option("--build_number <number>", "The build number of the app, for example: 0").option("--use_elo_session <y/n>", "Enable, to use elo session, for example: y").option(
+).option("--namespace <string>", "The app namespace, for example: my.example.namespace").option(
+  "--id <string>",
+  "The app id, for example: exampleId (allowed characters: a-z, A-Z, 0-9, _)"
+).option("--default_lang <string>", "The default language, for example: de").option("--build_number <number>", "The build number of the app, for example: 0").option("--use_elo_session <y/n>", "Enable, to use elo session, for example: y").option(
   "--dev_redirect <string>",
   "Dev url of the app, which the login site of the ELOwf will redirect after successfull login. Necessary if elo session is enabled, for example: http://localhost:4200/"
 ).action(async (options, path) => {
@@ -3684,7 +3687,7 @@ async function processConfigParameter(options, path) {
           dist: "dist",
           namespace: "",
           id: "",
-          defaultLanguage: "de"
+          defaultLanguage: "en"
         },
         ixLogin: {
           adminName: props.username,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "ELO Apps command line build system for Node.js.",
   "keywords": [
     "@elo/elo-cli",
@@ -47,7 +47,7 @@
     "create-vh": "npx elo-vh create --create-config ./elo-vh.env --no-release-date --no-release-version"
   },
   "dependencies": {
-    "@elo/ix-client-typescript": "master",
+    "@elo/ix-client-typescript": "latest",
     "archiver": "7.0.1",
     "axios": "1.13.6",
     "axios-cookiejar-support": "6.0.5",