Skip to content

feat: Support projects with type "module"#430

Draft
matz3 wants to merge 1 commit into
mainfrom
support-tooling-type-module
Draft

feat: Support projects with type "module"#430
matz3 wants to merge 1 commit into
mainfrom
support-tooling-type-module

Conversation

@matz3

@matz3 matz3 commented Nov 28, 2024

Copy link
Copy Markdown
Member

This allows linting projects that currently do not fit any other project
structure of UI5 Tooling.

To lint such projects, a ui5.yaml needs to be added to the root of the
project with the following content:

specVersion: "4.0"
type: module
metadata:
  name: <project-name>
resources:
  configuration:
    paths:
      /resources/<namespace>/: "<sources-folder>"

Placeholders <project-name>, <namespace> and <sources-folder> need
to be replaced with the actual values.

Example:
A project has its sources in a folder src and uses the namespace
my.project, so for example a source file named
src/my/project/util/Formatter.js would exist.
In this case the placeholders would be replaced as follows:

  • <project-name>: my.project
  • <namespace>: my/project
  • <sources-folder>: src

JIRA: CPOUI5FOUNDATION-972

This allows linting projects that currently do not fit any other project
structure of UI5 Tooling.

To lint such projects, a `ui5.yaml` needs to be added to the root of the
project with the following content:

```yaml
specVersion: "4.0"
type: module
metadata:
  name: <project-name>
resources:
  configuration:
    paths:
      /resources/<namespace>/: "<sources-folder>"
````

Placeholders `<project-name>`, `<namespace>` and `<sources-folder>` need
to be replaced with the actual values.

Example:
A project has its sources in a folder `src` and uses the namespace
`my.project`, so for example a source file named
`src/my/project/util/Formatter.js` would exist.
In this case the placeholders would be replaced as follows:
- `<project-name>`: `my.project`
- `<namespace>`: `my/project`
- `<sources-folder>`: `src`
@matz3

matz3 commented Nov 28, 2024

Copy link
Copy Markdown
Member Author

Open tasks

  • Tests
  • Update README

@matz3

matz3 commented Nov 28, 2024

Copy link
Copy Markdown
Member Author

Also see #148

@CLAassistant

CLAassistant commented Jun 23, 2025

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants