Issue 565 complexity reduction

[Idrinth]

The Pull Request is ready

• fixes Refactor check-routes.ts issues#565
• all actions are passing
• only fixes a single issue

Overview

• split logic in check routes for easier reading

Framework

• the change breaks no interface
• default behaviour did not change
• any new text output is added to the translation files (at least the english one)
• tests have been added (if required)
• documentation has been adjusted (if required)
• shared code has been extracted in a different file

[coderabbitai]

Walkthrough

The changes involve reorganising imports, renaming functions, and introducing new validation files to improve code structure and readability. Additionally, the .gitignore and tsconfig.json files have been updated for better project management and compilation settings.

Changes

Files/Groups	Change Summary
.gitignore	Reordered entries; added /coverage.
src/cli/check-routes.ts	Updated imports for jobCreator and taskTypes.
src/no-duplicate-ids.ts	Introduced noDuplicateIds function to check for duplicate IDs in tasks.
src/routes/validate-tasks.ts	Reorganised imports; renamed noDuplicateIDs to noDuplicateIds.
src/routes/middleware-loader.ts	Modified instantiation of object in load function.
src/validation/check-middleware.ts	Validates middleware definitions for tasks.
src/validation/check-request.ts	Introduced request validation functions and property definitions.
src/validation/check-type.ts	Introduced checkType function for validating job tasks.
src/validation/error.ts	Introduced error function for logging error messages.
src/validation/no-duplicate-ids.ts	Introduced noDuplicateIds function in validation folder.
src/validation/warn.ts	Introduced warn function for logging warning messages.
tsconfig.json	Removed lib field from compilerOptions.

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Refactor check-routes.ts (#565)	✅

In code's embrace, we find our way,
With changes made to clear the fray.
Imports aligned, errors now tamed,
A cleaner path, our goal proclaimed.
Through lines of code, we boldly strive,
Efficiency and order, we derive.
🛠️✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 29

Out of diff range and nitpick comments (1)

src/cli/check-routes.ts (1)

Line range hint 33-33: Unexpected console statement.

- console.log(logSymbols.success + ' ' + language('no_errors_warnings',),);
+ console.log(logSymbols.success + ' ' + language('no_errors_warnings'));

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a39e6a2 and 32e4350.

Files selected for processing (9)

• .gitignore (1 hunks)
• src/cli/check-routes.ts (1 hunks)
• src/no-duplicate-ids.ts (1 hunks)
• src/routes/validate-tasks.ts (2 hunks)
• src/validation/check-middleware.ts (1 hunks)
• src/validation/check-request.ts (1 hunks)
• src/validation/check-type.ts (1 hunks)
• src/validation/error.ts (1 hunks)
• src/validation/warn.ts (1 hunks)

Additional Context Used

GitHub Check Runs (1)

lint failure (20)

src/cli/check-routes.ts: [warning] 2-2:
Expected a line break after this opening brace

---

src/cli/check-routes.ts: [warning] 2-2:
A space is required after '{'

---

src/cli/check-routes.ts: [warning] 2-2:
Expected a line break before this closing brace

---

src/cli/check-routes.ts: [warning] 2-2:
A space is required before '}'

---

src/cli/check-routes.ts: [warning] 10-10:
Strings must use singlequote

---

src/cli/check-routes.ts: [warning] 11-11:
Strings must use singlequote

---

src/cli/check-routes.ts: [warning] 12-12:
Strings must use singlequote

---

src/cli/check-routes.ts: [warning] 33-33:
Unexpected console statement

---

src/no-duplicate-ids.ts: [warning] 1-1:
Strings must use singlequote

Path-based Instructions (8)

src/validation/warn.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/validation/error.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/no-duplicate-ids.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/routes/validate-tasks.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/validation/check-middleware.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/cli/check-routes.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/validation/check-type.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/validation/check-request.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

Additional comments not posted (2)

.gitignore (2)

2-2: Correct placement of /node_modules entry.

---

4-4: Addition of /coverage entry is correct.

[coderabbitai]

Actionable comments posted: 5

Out of diff range and nitpick comments (2)

src/routes/middleware-loader.ts (1)

Line range hint 16-24: Remove unnecessary trailing commas.

- const resolve = (path: string,): string => {
+ const resolve = (path: string): string => {
- const shortened = path.substring(SECOND,);
+ const shortened = path.substring(SECOND);
- return path.endsWith(INCLUDE_EXTENSION,) ? path : path + INCLUDE_EXTENSION;
+ return path.endsWith(INCLUDE_EXTENSION) ? path : path + INCLUDE_EXTENSION;

src/cli/check-routes.ts (1)

Line range hint 35-35: Unexpected console statement.

Remove the console statement or replace it with a logging mechanism.

- console.log(logSymbols.success + ' ' + language('no_errors_warnings',),);
+ // Replace with appropriate logging mechanism
+ console.info(logSymbols.success + ' ' + language('no_errors_warnings'));

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 32e4350 and 48c6c88.

Files selected for processing (8)

• src/cli/check-routes.ts (1 hunks)
• src/routes/middleware-loader.ts (1 hunks)
• src/validation/check-middleware.ts (1 hunks)
• src/validation/check-request.ts (1 hunks)
• src/validation/check-type.ts (1 hunks)
• src/validation/error.ts (1 hunks)
• src/validation/no-duplicate-ids.ts (1 hunks)
• src/validation/warn.ts (1 hunks)

Files skipped from review as they are similar to previous changes (4)

• src/validation/check-middleware.ts
• src/validation/check-type.ts
• src/validation/error.ts
• src/validation/warn.ts

Additional Context Used

GitHub Check Runs (1)

lint failure (17)

src/cli/check-routes.ts: [warning] 35-35:
Unexpected console statement

---

src/validation/check-request.ts: [warning] 60-60:
This line has a length of 100. Maximum allowed is 80

Path-based Instructions (4)

src/validation/no-duplicate-ids.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/routes/middleware-loader.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/cli/check-routes.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

src/validation/check-request.ts (1)

Pattern **/*.ts: Review the code for conformity with the .eslintrc files in / and /*/.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 48c6c88 and 7dbaf99.

Files selected for processing (1)

• tsconfig.json (1 hunks)

Files skipped from review due to trivial changes (1)

• tsconfig.json

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7dbaf99 and 1d68f2b.

Files selected for processing (1)

• tsconfig.json (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• tsconfig.json