Skip to content

Commit

Permalink
feat: Add section for the scripts in README
Browse files Browse the repository at this point in the history
  • Loading branch information
d3xter666 committed Apr 15, 2024
1 parent 87177ea commit 417bd2c
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,22 @@ npm install --global @ui5/linter
npm install --save-dev @ui5/linter
```

## Preparation

The UI5 Linter requires metadata to accurately identify certain issues within the codebase. While the absence of this metadata does not hinder the linter's basic functionality, it may result in incomplete findings.

The extracted and generated metadata is stored within the repository under the `/resources` folder. This metadata plays a crucial role in enhancing the accuracy of the linter's analysis.

Regular updates to the metadata are necessary to ensure that the data is compatible with the corresponding UI5 type definitions.

```sh
npm run update-pseudo-modules-info -- $DOMAIN_NAME/com/sap/ui5/dist/sapui5-sdk-dist/1.120.12/sapui5-sdk-dist-1.120.12-api-jsons.zip 1.120.12
```

```sh
npm run update-semantic-model-info -- $URL 1.120.12
```

## Usage

Run the `ui5lint` command in your project root folder
Expand Down

0 comments on commit 417bd2c

Please sign in to comment.