From e7088db233f71024a9e1371c60feff3fc624e27b Mon Sep 17 00:00:00 2001 From: Petar Skelin Date: Tue, 3 Feb 2026 11:36:20 +0200 Subject: [PATCH 1/2] chore: add docs for non-interactive usage of create-package --- docs/4-development/01-package.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/docs/4-development/01-package.md b/docs/4-development/01-package.md index bbea8deb2e1f..ed951b27542c 100644 --- a/docs/4-development/01-package.md +++ b/docs/4-development/01-package.md @@ -39,7 +39,7 @@ npm init @ui5/webcomponents-package myComponents will create a `myComponents` directory and initialize the project inside. -### 2. Follow the prompts +### 2A. Follow the prompts The initialization script will ask you to choose: - The **name** of your NPM package (if you did not already pass a name when running the command above); @@ -48,6 +48,36 @@ The initialization script will ask you to choose: **That's it! Your package is ready!** +### 2B. Non-Interactive Usage + +For CI/CD pipelines or scripted setups, you can skip the interactive prompts by using command-line options. + +Run `npm create @ui5/webcomponents-package -- --help` to see all available options: + +| Option | Type | Description | Default | +|------------------|---------|--------------------------------------------------------|--------------| +| `--name` | string | Package name (npm-compatible) | `my-package` | +| `--tag` | string | Component tag name (e.g., `my-button`) | auto-generated | +| `--testSetup` | string | Test setup: `cypress` or `manual` | `manual` | +| `--skip` | boolean | Skip interactive prompts and use defaults/provided values | `false` | +| `--skipSubfolder`| boolean | Create files in current directory instead of a subfolder | `false` | + +**Examples:** + +```sh +# Create package with default settings (non-interactive) +npm create @ui5/webcomponents-package -- --skip + +# Create package with custom name +npm create @ui5/webcomponents-package -- --name my-components --skip + +# Create scoped package with Cypress test setup +npm create @ui5/webcomponents-package -- --name @myorg/ui5-components --testSetup cypress --skip + +# Create package in current directory (no subfolder) +npm create @ui5/webcomponents-package -- --name my-components --skipSubfolder --skip +``` + ### 3. Run the project - `cd ` From c268f811c7439bdb7c011f43866436c6a33f9f2f Mon Sep 17 00:00:00 2001 From: Petar Skelin Date: Tue, 3 Feb 2026 12:04:45 +0200 Subject: [PATCH 2/2] chore: update usage of latest --- docs/4-development/01-package.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/4-development/01-package.md b/docs/4-development/01-package.md index ed951b27542c..1b3c9af81ceb 100644 --- a/docs/4-development/01-package.md +++ b/docs/4-development/01-package.md @@ -14,11 +14,11 @@ The following command will **create a new directory** and initialize your projec - With **npm**: - `npm init @ui5/webcomponents-package` - + `npm create @ui5/webcomponents-package@latest` + or - - `npm init @ui5/webcomponents-package ` + + `npm create @ui5/webcomponents-package@latest ` - With **yarn**: @@ -31,10 +31,12 @@ The following command will **create a new directory** and initialize your projec **Note:** The `` is the name of the directory/project to be created, but also the NPM package name, used in the `package.json`. +**Note:** Using `@latest` with npm ensures you always get the most recent version, bypassing any locally cached versions. + For example: ```sh -npm init @ui5/webcomponents-package myComponents +npm create @ui5/webcomponents-package@latest myComponents ``` will create a `myComponents` directory and initialize the project inside. @@ -52,7 +54,7 @@ The initialization script will ask you to choose: For CI/CD pipelines or scripted setups, you can skip the interactive prompts by using command-line options. -Run `npm create @ui5/webcomponents-package -- --help` to see all available options: +Run `npm create @ui5/webcomponents-package@latest -- --help` to see all available options: | Option | Type | Description | Default | |------------------|---------|--------------------------------------------------------|--------------| @@ -66,16 +68,16 @@ Run `npm create @ui5/webcomponents-package -- --help` to see all available optio ```sh # Create package with default settings (non-interactive) -npm create @ui5/webcomponents-package -- --skip +npm create @ui5/webcomponents-package@latest -- --skip # Create package with custom name -npm create @ui5/webcomponents-package -- --name my-components --skip +npm create @ui5/webcomponents-package@latest -- --name my-components --skip # Create scoped package with Cypress test setup -npm create @ui5/webcomponents-package -- --name @myorg/ui5-components --testSetup cypress --skip +npm create @ui5/webcomponents-package@latest -- --name @myorg/ui5-components --testSetup cypress --skip # Create package in current directory (no subfolder) -npm create @ui5/webcomponents-package -- --name my-components --skipSubfolder --skip +npm create @ui5/webcomponents-package@latest -- --name my-components --skipSubfolder --skip ``` ### 3. Run the project