Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## 🚨 Issues Have Been Transferred to UI5 Tooling Repository
## 🚨 Issues Have Been Transferred to UI5 CLI Repository

Please create new issues in the UI5 Tooling repository: https://github.com/SAP/ui5-tooling/issues/new/choose
Please create new issues in the UI5 CLI repository: https://github.com/UI5/cli/issues/new/choose
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Report UI5 Tooling Issues or Request a Feature
url: https://github.com/SAP/ui5-tooling/issues/new/choose
about: Please create new issues in the UI5 Tooling repository
- name: Report UI5 CLI Issues or Request a Feature
url: https://github.com/UI5/cli/issues/new/choose
about: Please create new issues in the UI5 CLI repository
8 changes: 4 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
To get it merged faster, kindly review the checklist below:

## Pull Request Checklist
- [ ] Reviewed the [Contributing Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md#-contributing-code)
+ Especially the [How to Contribute](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md#how-to-contribute) section
- [ ] [No merge commits](https://github.com/SAP/ui5-tooling/blob/v3/docs/Guidelines.md#no-merge-commits)
- [ ] [Correct commit message style](https://github.com/SAP/ui5-tooling/blob/v3/docs/Guidelines.md#commit-message-style)
- [ ] Reviewed the [Contributing Guidelines](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md#-contributing-code)
+ Especially the [How to Contribute](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md#how-to-contribute) section
- [ ] [No merge commits](https://github.com/UI5/cli/blob/v3/docs/Guidelines.md#no-merge-commits)
- [ ] [Correct commit message style](https://github.com/UI5/cli/blob/v3/docs/Guidelines.md#commit-message-style)
2 changes: 1 addition & 1 deletion .reuse/dep5
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ Disclaimer: The code in this project may include calls to APIs (“API Calls”)
parties the right to use of access any SAP External Product, through API Calls.

Files: *
Copyright: 2018-2024 SAP SE or an SAP affiliate company and UI5 Tooling contributors
Copyright: 2018-2024 SAP SE or an SAP affiliate company and UI5 CLI contributors
License: Apache-2.0
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Contributing to the UI5 Tooling
# Contributing to the UI5 CLI

See CONTRIBUTING.md in the [SAP/ui5-tooling](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md) repository.
See CONTRIBUTING.md in the [UI5/cli](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md) repository.
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2018-2024 SAP SE or an SAP affiliate company and UI5 Tooling contributors
Copyright 2018-2024 SAP SE or an SAP affiliate company and UI5 CLI contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
![UI5 icon](https://raw.githubusercontent.com/SAP/ui5-tooling/v3/docs/images/UI5_logo_wide.png)
![UI5 icon](https://raw.githubusercontent.com/UI5/cli/v3/docs/images/UI5_logo_wide.png)

# ui5-project
> Modules for building a projects dependency tree, including UI5 specific configuration.
> Part of the [UI5 Tooling](https://github.com/SAP/ui5-tooling)
> Part of the [UI5 CLI](https://github.com/UI5/cli)

[![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-project)](https://api.reuse.software/info/github.com/SAP/ui5-project)
[![Build Status](https://dev.azure.com/sap/opensource/_apis/build/status/SAP.ui5-project?branchName=v3)](https://dev.azure.com/sap/opensource/_build/latest?definitionId=35&branchName=v3)
[![npm Package Version](https://badge.fury.io/js/%40ui5%2Fproject.svg)](https://www.npmjs.com/package/@ui5/project)
[![Coverage Status](https://coveralls.io/repos/github/SAP/ui5-project/badge.svg)](https://coveralls.io/github/SAP/ui5-project)

## Documentation
UI5 Project documentation can be found here: [sap.github.io/ui5-tooling](https://sap.github.io/ui5-tooling/v3/pages/Project/)
UI5 Project documentation can be found here: [ui5.github.io/cli](https://ui5.github.io/cli/v3/pages/Project/)

The UI5 Project API Reference can be found here: [`@ui5/project`](https://sap.github.io/ui5-tooling/v3/api/)
The UI5 Project API Reference can be found here: [`@ui5/project`](https://ui5.github.io/cli/v3/api/)

## Contributing
Please check our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md).
Please check our [Contribution Guidelines](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md).

## Support
Please follow our [Contribution Guidelines](https://github.com/SAP/ui5-tooling/blob/v3/CONTRIBUTING.md#report-an-issue) on how to report an issue.
Please follow our [Contribution Guidelines](https://github.com/UI5/cli/blob/v3/CONTRIBUTING.md#report-an-issue) on how to report an issue.

Please report issues in the main [UI5 Tooling](https://github.com/SAP/ui5-tooling) repository.
Please report issues in the main [UI5 CLI](https://github.com/UI5/cli) repository.

## Release History
See [CHANGELOG.md](CHANGELOG.md).
2 changes: 1 addition & 1 deletion docs/BuildExtensibility.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# UI5 Build Extensibility
This documentation moved to a new place: [sap.github.io/ui5-tooling/pages/extensibility/CustomTasks/](https://sap.github.io/ui5-tooling/pages/extensibility/CustomTasks/)
This documentation moved to a new place: [ui5.github.io/cli/pages/extensibility/CustomTasks/](https://ui5.github.io/cli/pages/extensibility/CustomTasks/)
4 changes: 2 additions & 2 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuration
This documentation moved to a new place: [sap.github.io/ui5-tooling/pages/Configuration/](https://sap.github.io/ui5-tooling/pages/Configuration/).
This documentation moved to a new place: [ui5.github.io/cli/pages/Configuration/](https://ui5.github.io/cli/pages/Configuration/).

The **Specification Version Documentation** can be found here: [sap.github.io/ui5-tooling/pages/Configuration/#specification-versions](https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions)
The **Specification Version Documentation** can be found here: [ui5.github.io/cli/pages/Configuration/#specification-versions](https://ui5.github.io/cli/pages/Configuration/#specification-versions)
12 changes: 6 additions & 6 deletions jsdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@
}
},
"openGraph": {
"title": "UI5 Tooling - API Reference",
"title": "UI5 CLI - API Reference",
"type": "website",
"image": "https://sap.github.io/ui5-tooling/v3/images/UI5_logo_wide.png",
"site_name": "UI5 Tooling - API Reference",
"url": "https://sap.github.io/ui5-tooling/"
"image": "https://ui5.github.io/cli/v3/images/UI5_logo_wide.png",
"site_name": "UI5 CLI - API Reference",
"url": "https://ui5.github.io/cli/"
},
"docdash": {
"sectionOrder": [
Expand All @@ -43,8 +43,8 @@
"Interfaces"
],
"meta": {
"title": "UI5 Tooling - API Reference - UI5 Project",
"description": "UI5 Tooling - API Reference - UI5 Project",
"title": "UI5 CLI - API Reference - UI5 Project",
"description": "UI5 CLI - API Reference - UI5 Project",
"keyword": "openui5 sapui5 ui5 build development tool api reference"
},
"search": true,
Expand Down
4 changes: 2 additions & 2 deletions lib/build/TaskRunner.js
Original file line number Diff line number Diff line change
Expand Up @@ -361,8 +361,8 @@ class TaskRunner {
throw new Error(
`Standard task ${refTaskName}, referenced by custom task ${newTaskName} ` +
`in project ${project.getName()}, ` +
`has been removed in this version of UI5 Tooling and can't be referenced anymore. ` +
`Please see the migration guide at https://sap.github.io/ui5-tooling/updates/migrate-v3/`);
`has been removed in this version of UI5 CLI and can't be referenced anymore. ` +
`Please see the migration guide at https://ui5.github.io/cli/updates/migrate-v3/`);
}
throw new Error(`Could not find task ${refTaskName}, referenced by custom task ${newTaskName}, ` +
`to be scheduled for project ${project.getName()}`);
Expand Down
10 changes: 5 additions & 5 deletions lib/build/helpers/TaskUtil.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ import {
*/
class TaskUtil {
/**
* Standard Build Tags. See UI5 Tooling
* [RFC 0008]{@link https://github.com/SAP/ui5-tooling/blob/main/rfcs/0008-resource-tagging-during-build.md}
* Standard Build Tags. See UI5 CLI
* [RFC 0008]{@link https://github.com/UI5/cli/blob/main/rfcs/0008-resource-tagging-during-build.md}
* for details.
*
* @public
Expand Down Expand Up @@ -87,7 +87,7 @@ class TaskUtil {
setTag(resource, tag, value) {
if (typeof resource === "string") {
throw new Error("Deprecated parameter: " +
"Since UI5 Tooling 3.0, #setTag requires a resource instance. Strings are no longer accepted");
"Since UI5 CLI 3.0, #setTag requires a resource instance. Strings are no longer accepted");
}

const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
Expand All @@ -110,7 +110,7 @@ class TaskUtil {
getTag(resource, tag) {
if (typeof resource === "string") {
throw new Error("Deprecated parameter: " +
"Since UI5 Tooling 3.0, #getTag requires a resource instance. Strings are no longer accepted");
"Since UI5 CLI 3.0, #getTag requires a resource instance. Strings are no longer accepted");
}
const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
return collection.getTag(resource, tag);
Expand All @@ -131,7 +131,7 @@ class TaskUtil {
clearTag(resource, tag) {
if (typeof resource === "string") {
throw new Error("Deprecated parameter: " +
"Since UI5 Tooling 3.0, #clearTag requires a resource instance. Strings are no longer accepted");
"Since UI5 CLI 3.0, #clearTag requires a resource instance. Strings are no longer accepted");
}
const collection = this._projectBuildContext.getResourceTagCollection(resource, tag);
return collection.clearTag(resource, tag);
Expand Down
4 changes: 2 additions & 2 deletions lib/config/Configuration.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ class Configuration {
config = {};
} else {
throw new Error(
`Failed to read UI5 Tooling configuration from ${filePath}: ${err.message}`, {
`Failed to read UI5 CLI configuration from ${filePath}: ${err.message}`, {
cause: err
});
}
Expand Down Expand Up @@ -127,7 +127,7 @@ class Configuration {
return writeFile(filePath, JSON.stringify(config.toJson()));
} catch (err) {
throw new Error(
`Failed to write UI5 Tooling configuration to ${filePath}: ${err.message}`, {
`Failed to write UI5 CLI configuration to ${filePath}: ${err.message}`, {
cause: err
});
}
Expand Down
2 changes: 1 addition & 1 deletion lib/graph/Workspace.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const log = getLogger("graph:Workspace");

/**
* Workspace configuration. For details, refer to the
* [UI5 Workspaces documentation]{@link https://sap.github.io/ui5-tooling/v3/pages/Workspace/#configuration}
* [UI5 Workspaces documentation]{@link https://ui5.github.io/cli/v3/pages/Workspace/#configuration}
*
* @public
* @typedef {object} @ui5/project/graph/Workspace~Configuration
Expand Down
2 changes: 1 addition & 1 deletion lib/graph/graph.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export async function graphFromPackageDependencies({
* [@ui5/project/graph/providers/DependencyTree~TreeNode]{@link @ui5/project/graph/providers/DependencyTree~TreeNode}.
*
* Documentation:
* [Static Dependency Definition]{@link https://sap.github.io/ui5-tooling/stable/pages/Overview/#static-dependency-definition}
* [Static Dependency Definition]{@link https://ui5.github.io/cli/stable/pages/Overview/#static-dependency-definition}
*
* @public
* @static
Expand Down
6 changes: 3 additions & 3 deletions lib/graph/projectGraphBuilder.js
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ function validateNode(node) {
if (node.specVersion) {
throw new Error(
`Provided node with ID ${node.id} contains a top-level 'specVersion' property. ` +
`With UI5 Tooling 3.0, project configuration needs to be provided in a dedicated ` +
`With UI5 CLI 3.0, project configuration needs to be provided in a dedicated ` +
`'configuration' object`);
}
if (node.metadata) {
throw new Error(
`Provided node with ID ${node.id} contains a top-level 'metadata' property. ` +
`With UI5 Tooling 3.0, project configuration needs to be provided in a dedicated ` +
`With UI5 CLI 3.0, project configuration needs to be provided in a dedicated ` +
`'configuration' object`);
}
}
Expand Down Expand Up @@ -171,7 +171,7 @@ async function projectGraphBuilder(nodeProvider, workspace) {
// Invalidate cache if the cached module is visited through another parent project and did not
// resolve to a project or extension(s) before.
// The module being visited now might be a different version containing for example
// UI5 Tooling configuration, or one of the parent projects could have defined a
// UI5 CLI configuration, or one of the parent projects could have defined a
// relevant configuration shim meanwhile
log.silly(
`Cached module ${node.id} did not resolve to any projects or extensions. ` +
Expand Down
2 changes: 1 addition & 1 deletion lib/specifications/Project.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ class Project extends Specification {

/**
* Framework dependency entry of the project configuration.
* Also see [Framework Configuration: Dependencies]{@link https://sap.github.io/ui5-tooling/stable/pages/Configuration/#dependencies}
* Also see [Framework Configuration: Dependencies]{@link https://ui5.github.io/cli/stable/pages/Configuration/#dependencies}
*
* @public
* @typedef {object} @ui5/project/specifications/Project~FrameworkDependency
Expand Down
2 changes: 1 addition & 1 deletion lib/specifications/Specification.js
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ class Specification {
throw new Error(
`${config.kind} ${config.metadata.name} defines unsupported Specification Version ` +
`${originalSpecVersion}. Please manually upgrade to 3.0 or higher. ` +
`For details see https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions - ` +
`For details see https://ui5.github.io/cli/pages/Configuration/#specification-versions - ` +
`An attempted migration to a supported specification version failed, ` +
`likely due to unrecognized configuration. Check verbose log for details.`);
}
Expand Down
2 changes: 1 addition & 1 deletion lib/specifications/SpecificationVersion.js
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ class SpecificationVersion {

function getUnsupportedSpecVersionMessage(specVersion) {
return `Unsupported Specification Version ${specVersion} defined. Your UI5 CLI installation might be outdated. ` +
`For details, see https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions`;
`For details, see https://ui5.github.io/cli/pages/Configuration/#specification-versions`;
}

function getSemverCompatibleVersion(specVersion) {
Expand Down
2 changes: 1 addition & 1 deletion lib/specifications/types/Application.js
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ class Application extends ComponentProject {
`Could not find required manifest.json for project ` +
`${this.getName()}: ${manifestJsonError.message}\n\n` +
`If you are about to start a new project, please refer to:\n` +
`https://sap.github.io/ui5-tooling/v3/pages/GettingStarted/#starting-a-new-project`, {
`https://ui5.github.io/cli/v3/pages/GettingStarted/#starting-a-new-project`, {
cause: manifestJsonError
});
}
Expand Down
6 changes: 3 additions & 3 deletions lib/ui5Framework/AbstractResolver.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ class AbstractResolver {
}

// In some CI environments, the homedir might be set explicitly to a relative
// path (e.g. "./"), but tooling requires an absolute path
// path (e.g. "./"), but UI5 CLI requires an absolute path
this._ui5HomeDir = path.resolve(
ui5HomeDir || path.join(os.homedir(), ".ui5")
);
Expand Down Expand Up @@ -230,11 +230,11 @@ class AbstractResolver {
if (semver.valid(spec)) {
if (this.name === "Sapui5Resolver" && semver.lt(spec, "1.76.0")) {
throw new Error(`Could not resolve framework version ${version}. ` +
`Note that SAPUI5 framework libraries can only be consumed by the UI5 Tooling ` +
`Note that SAPUI5 framework libraries can only be consumed by the UI5 CLI ` +
`starting with SAPUI5 v1.76.0`);
} else if (this.name === "Openui5Resolver" && semver.lt(spec, "1.52.5")) {
throw new Error(`Could not resolve framework version ${version}. ` +
`Note that OpenUI5 framework libraries can only be consumed by the UI5 Tooling ` +
`Note that OpenUI5 framework libraries can only be consumed by the UI5 CLI ` +
`starting with OpenUI5 v1.52.5`);
}
}
Expand Down
6 changes: 3 additions & 3 deletions lib/ui5Framework/Sapui5MavenSnapshotResolver.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ class Sapui5MavenSnapshotResolver extends AbstractResolver {

/**
* Read the Maven repository snapshot endpoint URL from the central
* UI5 Tooling configuration, with a fallback to central Maven configuration (is existing)
* UI5 CLI configuration, with a fallback to central Maven configuration (is existing)
*
* @returns {Promise<string>} The resolved snapshotEndpointUrl
*/
Expand All @@ -183,12 +183,12 @@ class Sapui5MavenSnapshotResolver extends AbstractResolver {
const config = await Configuration.fromFile();
let url = config.getMavenSnapshotEndpointUrl();
if (url) {
log.verbose(`Using UI5 Tooling configuration for mavenSnapshotEndpointUrl: ${url}`);
log.verbose(`Using UI5 CLI configuration for mavenSnapshotEndpointUrl: ${url}`);
} else {
log.verbose(`No mavenSnapshotEndpointUrl configuration found`);
url = await Sapui5MavenSnapshotResolver._resolveSnapshotEndpointUrlFromMaven();
if (url) {
log.verbose(`Updating UI5 Tooling configuration with new mavenSnapshotEndpointUrl: ${url}`);
log.verbose(`Updating UI5 CLI configuration with new mavenSnapshotEndpointUrl: ${url}`);
const configJson = config.toJson();
configJson.mavenSnapshotEndpointUrl = url;
await Configuration.toFile(new Configuration(configJson));
Expand Down
2 changes: 1 addition & 1 deletion lib/ui5Framework/maven/Installer.js
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ class Installer extends AbstractInstaller {
}

// Do not create target dir itself to prevent EPERM error in following rename operation
// (https://github.com/SAP/ui5-tooling/issues/487)
// (https://github.com/UI5/cli/issues/487)
await mkdirp(path.dirname(targetDir));
log.verbose(`Promoting staging directory from ${stagingDir} to ${targetDir}...`);
await rename(stagingDir, targetDir);
Expand Down
2 changes: 1 addition & 1 deletion lib/ui5Framework/npm/Installer.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ class Installer extends AbstractInstaller {
await this.getRegistry().extractPackage(pkgName, version, stagingDir);

// Do not create target dir itself to prevent EPERM error in following rename operation
// (https://github.com/SAP/ui5-tooling/issues/487)
// (https://github.com/UI5/cli/issues/487)
await mkdirp(path.dirname(targetDir));
log.verbose(`Promoting staging directory from ${stagingDir} to ${targetDir}...`);
await rename(stagingDir, targetDir);
Expand Down
2 changes: 1 addition & 1 deletion lib/validation/schema/specVersion/kind/extension.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
"pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$",
"title": "Extension Name",
"description": "Unique identifier for the extension, for example: ui5-task-fearless-rock",
"errorMessage": "Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name"
"errorMessage": "Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://ui5.github.io/cli/stable/pages/Configuration/#name"
},
"copyright": {
"type": "string"
Expand Down
4 changes: 2 additions & 2 deletions lib/validation/schema/specVersion/kind/project.json
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
"pattern": "^(?:@[0-9a-z-_.]+\\/)?[a-z][0-9a-z-_.]*$",
"title": "Project Name",
"description": "Unique identifier for the project, for example: organization.product.project",
"errorMessage": "Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name"
"errorMessage": "Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://ui5.github.io/cli/stable/pages/Configuration/#name"
},
"copyright": {
"type": "string"
Expand All @@ -129,7 +129,7 @@
"enum": ["UTF-8", "ISO-8859-1"],
"default": "UTF-8",
"title": "Encoding of *.properties files",
"description": "By default, the UI5 Tooling expects *.properties files to be UTF-8 encoded."
"description": "By default, the UI5 CLI expects *.properties files to be UTF-8 encoded."
},
"builder-resources": {
"type": "object",
Expand Down
Loading