Skip to content

Details page for JS rules#2052

Merged
renejeglinsky merged 25 commits intomainfrom
js-rulez
Sep 2, 2025
Merged

Details page for JS rules#2052
renejeglinsky merged 25 commits intomainfrom
js-rulez

Conversation

@chgeo
Copy link
Contributor

@chgeo chgeo commented Aug 22, 2025

First attempt for a rules details page

Missing: details on when the rule does not work, like code structures it does not detect.

@chgeo chgeo requested a review from daogrady August 22, 2025 16:31
@chgeo
Copy link
Contributor Author

chgeo commented Aug 22, 2025

@daogrady maybe you can take it from here.

For local testing, make sure to install the plugin into capire:

npm i .../eslint-plugin-cds --no-save

Also use and check the playground link for the sample code.

@daogrady daogrady changed the title Details page for cql-select rule Details page for JS rules Aug 25, 2025
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Spelling Mistakes

  • tools/cds-lint/rules/no-shared-handler-variable.md:37:141 Unknown word "iteself"

Generally, for each spelling mistake there are 2 ways to fix it:

  1. Fix the spelling mistake and commit it.
  2. The word is incorrectly reported as misspelled → put the word on the project-words.txt list, located in the root project directory.

daogrady and others added 2 commits August 26, 2025 12:44
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@daogrady daogrady self-assigned this Aug 26, 2025
@daogrady daogrady marked this pull request as ready for review August 26, 2025 10:49
@daogrady
Copy link
Contributor

@smahati I think this should now be ready for review. I can no longer give a qualified review, as I have contributed content myself. Can you please give it a check for wording, formatting, and legibility? Thanks!

@renejeglinsky
Copy link
Contributor

The overview page doesn't reflect the JS rules yet:
image

@renejeglinsky
Copy link
Contributor

What are project-based rules? Do we have any mentioned here? This is not part of the tables and only found in the details note. BTW: Should this details note be in the general part of the overview page and not inside the Model rules section?

image

@daogrady
Copy link
Contributor

daogrady commented Sep 1, 2025

What are project-based rules? Do we have any mentioned here? This is not part of the tables and only found in the details note. BTW: Should this details note be in the general part of the overview page and not inside the Model rules section?

image

I believe project-based rules are the same as environment rules: checks, that do not target specific files (.cds or .js), but inspect the project's environment for integrity.

@renejeglinsky renejeglinsky merged commit ae8eb5b into main Sep 2, 2025
7 checks passed
@renejeglinsky renejeglinsky deleted the js-rulez branch September 2, 2025 12:35
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.

5 participants