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: Detect pseudo modules #60

Merged
merged 33 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
eb8a324
feat: Create definitions for pseudo modules
d3xter666 Apr 4, 2024
df88d40
fix: Eslint issues
d3xter666 Apr 4, 2024
e1ae412
refactor: Address Eslint issues
d3xter666 Apr 5, 2024
53bbe07
feat: Detect badly imported enums
d3xter666 Apr 5, 2024
64a6a96
fix: Define properly modules
d3xter666 Apr 5, 2024
e7e8b9d
feat: Adds generated files to the definitions
d3xter666 Apr 8, 2024
9635435
feat: Filter enums for only real pseudo ones
d3xter666 Apr 8, 2024
bebeeeb
refactor: Export imports from library.json
d3xter666 Apr 8, 2024
61f0b3f
feat: Add generated definitions
d3xter666 Apr 8, 2024
0e35bfd
refactor: Extract sapui5 version
d3xter666 Apr 8, 2024
b27a63d
fix: Refactor unzipping of JSON archive
d3xter666 Apr 9, 2024
0b8023e
refactor: Rewrite file downloader
d3xter666 Apr 9, 2024
e4678be
refactor: Add empty last line to autogenerate files
d3xter666 Apr 9, 2024
d63cdd4
refactor: Reorder modules
d3xter666 Apr 9, 2024
aacdcaf
fix: Merge conflicts
d3xter666 Apr 10, 2024
c774091
fix: Update imports
d3xter666 Apr 10, 2024
ccfe3f3
fix: Eslint
d3xter666 Apr 10, 2024
8a20b1a
feat: Cleanup temp files
d3xter666 Apr 10, 2024
935ae1b
feat: Cleanup after definitions import
d3xter666 Apr 10, 2024
4336707
feat: Add tests
d3xter666 Apr 10, 2024
5bf4018
fix: Merge conflicts
d3xter666 Apr 12, 2024
2f82780
refactor: Address GH comments
d3xter666 Apr 15, 2024
91821b6
refactor: Address GH comments
d3xter666 Apr 15, 2024
f74051a
refactor: Update texts
d3xter666 Apr 15, 2024
87177ea
fix: Merge conflicts
d3xter666 Apr 15, 2024
417bd2c
feat: Add section for the scripts in README
d3xter666 Apr 15, 2024
9fc911a
fix: Update test snapshots & eslint findings
d3xter666 Apr 15, 2024
1067794
test: Add fixtures for pseudo modules
matz3 Mar 26, 2024
b9ea00e
refactor: Extract scripts' common functionality into a helper module
d3xter666 Apr 16, 2024
09abf36
fix: Reposition metadata generation section in README
d3xter666 Apr 16, 2024
3d77501
fix: Typo
d3xter666 Apr 16, 2024
3c9c073
fix: Update metadata generation docs with the correct CLI commands
d3xter666 Apr 16, 2024
8604d81
test: Add DataType fixture (not covered yet)
matz3 Apr 16, 2024
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
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,25 @@ Choose the output format. Currently, `stylish` (default) and `json` are supporte
ui5lint --format json
```

## Metadata generation
d3xter666 marked this conversation as resolved.
Show resolved Hide resolved

**Note:** This section is intended to support UI5 Linter developers and is not meant for end users of the linter!

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 -- $DOMAIN_NAME/com/sap/ui5/dist/sapui5-sdk-dist/1.120.12/sapui5-sdk-dist-1.120.12-api-jsons.zip 1.120.12
```


## Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/ui5-linter/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
Expand Down
Loading