Skip to content

Add description for js rules#1946

Merged
chgeo merged 4 commits into
mainfrom
feat/eslint-js-rules
Jul 4, 2025
Merged

Add description for js rules#1946
chgeo merged 4 commits into
mainfrom
feat/eslint-js-rules

Conversation

@daogrady

@daogrady daogrady commented Jul 2, 2025

Copy link
Copy Markdown
Contributor

We introduced a new set of lint rules targeting JS implementation files, instead of just .cds files.
This PR introduces automatic documentation extraction for these new rules, to be found in list form under /tools/cds-lint/rules/

Screenshot 2025-07-02 at 12 39 12

We do not yet introduce extended documentation per rule for these new rules, as I am not clear yet whether they are automatically generated or maintained manually.

@daogrady daogrady requested a review from chgeo July 2, 2025 10:42
@chgeo chgeo marked this pull request as ready for review July 4, 2025 11:37
@chgeo chgeo requested a review from renejeglinsky as a code owner July 4, 2025 11:37

@chgeo chgeo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

The detail pages are written manually, with teh good/bad examples taken from the rules' unit test. We can add them later, so that we can publish this with the June release today.

@chgeo

chgeo commented Jul 4, 2025

Copy link
Copy Markdown
Member

@renejeglinsky this should be merged for the June release.

@chgeo chgeo enabled auto-merge July 4, 2025 11:41
@chgeo chgeo disabled auto-merge July 4, 2025 13:25
@chgeo chgeo enabled auto-merge July 4, 2025 13:25
@chgeo chgeo added this pull request to the merge queue Jul 4, 2025
Merged via the queue into main with commit 5a8bcd7 Jul 4, 2025
4 of 5 checks passed
@chgeo chgeo deleted the feat/eslint-js-rules branch July 4, 2025 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants