Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Support projects with type "module" #430

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

matz3
Copy link
Member

@matz3 matz3 commented Nov 28, 2024

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
Copy link
Member Author

matz3 commented Nov 28, 2024

Open tasks

  • Tests
  • Update README

@matz3
Copy link
Member Author

matz3 commented Nov 28, 2024

Also see #148

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.

1 participant