chore: willboosterify this repo#136
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the project's verification workflow by adding the @willbooster/wb dependency and introducing verify scripts, while refining documentation for testing and coding standards across several Markdown files. It also adds drizzle/mount/ to ignore files and includes markers in oxlint.config.ts. Feedback indicates that the check-for-ai, check-all-for-ai, and typecheck scripts in package.json are now redundant and should be removed to eliminate redundancy. Additionally, the updates to documentation and prompt rules in the Markdown files conflict with the repository's established style guide regarding comments, JSDoc, and template literal usage, and should be aligned accordingly.
| "typecheck": "tsgo --noEmit", | ||
| "verify": "wb verify", | ||
| "verify-full": "wb verify --full" |
There was a problem hiding this comment.
The addition of verify and verify-full scripts, combined with the updates to the documentation in .cursor/rules/general.mdc and other files, makes the existing check-for-ai and check-all-for-ai scripts (lines 37-38) redundant. Furthermore, the typecheck script (line 49) might also be redundant if wb verify already performs type checking. According to the Repository Style Guide (Rule 6), redundant code should be eliminated. Please consider removing the obsolete scripts.
References
- Rule 6: Simplify code as much as possible to eliminate redundancy. (link)
| - Write comments and JSDoc for complex or hard-to-understand code. | ||
| - Explain "why" in comments and "what" in JSDoc. |
There was a problem hiding this comment.
This change limits the requirement for comments and JSDoc to only 'complex or hard-to-understand code'. This is a discrepancy with the Repository Style Guide (Rule 13), which states 'Write comments that explain "why" and use JSDoc to explain "what"' without such a restriction. Please align the rule with the style guide.
- Write comments that explain "why" and use JSDoc to explain "what".
References
- Rule 13: Write comments that explain 'why' and use JSDoc to explain 'what'. (link)
| - Avoid stating what can be easily understood from the code itself. | ||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. |
There was a problem hiding this comment.
This change restricts the preference for template literals to only 'pre-computable array literals'. This is a discrepancy with the Repository Style Guide (Rule 16), which prefers template literals over join() with any 'array of strings'. Please align the rule with the style guide.
- Prefer using a single template literal for prompts instead of `join()` with an array of strings.
References
- Rule 16: Prefer using a single template literal for prompts instead of join() with an array of strings. (link)
| - Write comments and JSDoc for complex or hard-to-understand code. | ||
| - Explain "why" in comments and "what" in JSDoc. |
There was a problem hiding this comment.
This change limits the requirement for comments and JSDoc to only 'complex or hard-to-understand code'. This is a discrepancy with the Repository Style Guide (Rule 13), which states 'Write comments that explain "why" and use JSDoc to explain "what"' without such a restriction. Please align the rule with the style guide.
| - Write comments and JSDoc for complex or hard-to-understand code. | |
| - Explain "why" in comments and "what" in JSDoc. | |
| - Write comments that explain "why" and use JSDoc to explain "what". |
References
- Rule 13: Write comments that explain 'why' and use JSDoc to explain 'what'. (link)
| - Avoid stating what can be easily understood from the code itself. | ||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. |
There was a problem hiding this comment.
This change restricts the preference for template literals to only 'pre-computable array literals'. This is a discrepancy with the Repository Style Guide (Rule 16), which prefers template literals over join() with any 'array of strings'. Please align the rule with the style guide.
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. | |
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. |
References
- Rule 16: Prefer using a single template literal for prompts instead of join() with an array of strings. (link)
| - Write comments and JSDoc for complex or hard-to-understand code. | ||
| - Explain "why" in comments and "what" in JSDoc. |
There was a problem hiding this comment.
This change limits the requirement for comments and JSDoc to only 'complex or hard-to-understand code'. This is a discrepancy with the Repository Style Guide (Rule 13), which states 'Write comments that explain "why" and use JSDoc to explain "what"' without such a restriction. Please align the rule with the style guide.
| - Write comments and JSDoc for complex or hard-to-understand code. | |
| - Explain "why" in comments and "what" in JSDoc. | |
| - Write comments that explain "why" and use JSDoc to explain "what". |
References
- Rule 13: Write comments that explain 'why' and use JSDoc to explain 'what'. (link)
| - Avoid stating what can be easily understood from the code itself. | ||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. |
There was a problem hiding this comment.
This change restricts the preference for template literals to only 'pre-computable array literals'. This is a discrepancy with the Repository Style Guide (Rule 16), which prefers template literals over join() with any 'array of strings'. Please align the rule with the style guide.
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. | |
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. |
References
- Rule 16: Prefer using a single template literal for prompts instead of join() with an array of strings. (link)
| - Write comments and JSDoc for complex or hard-to-understand code. | ||
| - Explain "why" in comments and "what" in JSDoc. |
There was a problem hiding this comment.
This change limits the requirement for comments and JSDoc to only 'complex or hard-to-understand code'. This is a discrepancy with the Repository Style Guide (Rule 13), which states 'Write comments that explain "why" and use JSDoc to explain "what"' without such a restriction. Please align the rule with the style guide.
| - Write comments and JSDoc for complex or hard-to-understand code. | |
| - Explain "why" in comments and "what" in JSDoc. | |
| - Write comments that explain "why" and use JSDoc to explain "what". |
References
- Rule 13: Write comments that explain 'why' and use JSDoc to explain 'what'. (link)
| - Avoid stating what can be easily understood from the code itself. | ||
| - Prefer `undefined` over `null` unless explicitly required by APIs or libraries. | ||
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. | ||
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. |
There was a problem hiding this comment.
This change restricts the preference for template literals to only 'pre-computable array literals'. This is a discrepancy with the Repository Style Guide (Rule 16), which prefers template literals over join() with any 'array of strings'. Please align the rule with the style guide.
| - Prefer using a single template literal for prompts instead of `join()` with a pre-computable array literal of strings. | |
| - Prefer using a single template literal for prompts instead of `join()` with an array of strings. |
References
- Rule 16: Prefer using a single template literal for prompts instead of join() with an array of strings. (link)
1 participant
No description provided.