chore(eslint): Fix Lint Rules

[HarshPatel5940]

User description

[!CAUTION]
This PR is an WORK IN PROGRESS!

#45

Description

• I have updated the default eslint rules, so they behave as expected

"@typescript-eslint/no-unused-vars": "warn",
"@typescript-eslint/no-unused-expressions": "warn"

and after this i have updated @nx/eslint rules.

Mentions

@rajdip-b

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work
• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added relevant screenshots in my PR

---

Type

Enhancement

---

Description

This PR enhances the project's linting configuration:

• It updates the ESLint rules to include warnings for unused variables and expressions in TypeScript files.
• It adds dependency checks for package and project JSON files.
• It changes the linting executor to @nx/linter:eslint for several apps and packages.
• It updates the lint file patterns to include .ts, package.json, and project.json files for several apps and packages.

---

Changes walkthrough

Relevant files

Configuration changes

.eslintrc.json                                                                                            .eslintrc.json The ESLint configuration file was updated with new rules for TypeScript files and for {package,project}.json files. The new rules include warnings for unused variables and expressions in TypeScript, and dependency checks for package and project JSON files. +17/-1 project.json                                                                                                apps/api-e2e/project.json The linting executor was changed to @nx/linter:eslint and the lint file patterns were updated to include .ts, package.json, and project.json files in the api-e2e app. +9/-2 project.json                                                                                                apps/api/project.json The linting executor was changed to @nx/linter:eslint and the lint file patterns were updated to include .ts, package.json, and project.json files in the api app. +9/-2 project.json                                                                                                apps/cli/project.json The linting executor was changed to @nx/linter:eslint and the lint file patterns were updated to include .ts, package.json, and project.json files in the cli app. +9/-2 project.json                                                                                                apps/web/project.json The linting executor was changed to @nx/linter:eslint and the lint file patterns were updated to include .ts, package.json, and project.json files in the web app. +9/-2 project.json                                                                                                packages/sdk-node/project.json The linting executor was changed to @nx/linter:eslint and the lint file patterns were updated to include .ts, package.json, and project.json files in the sdk-node package. +9/-2

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

When commenting, to edit configurations related to the describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the describe usage page for a comprehensive guide on using this tool.

[HarshPatel5940]

thank you for fixing PR title!

[HarshPatel5940]

This is a known issue and i suggest that this is addressed in a new PR 😄

[codiumai-pr-agent-free]

PR Description updated to latest commit (9701783)

[codiumai-pr-agent-free]

PR Analysis

• 🎯 Main theme: Updating ESLint rules and configurations
• 📝 PR summary: This PR updates the ESLint rules to include warnings for unused variables and expressions in TypeScript files. It also adds dependency checks for package and project JSON files, changes the linting executor for several apps and packages, and updates the lint file patterns to include .ts, package.json, and project.json files.
• 📌 Type of PR: Enhancement
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the changes are straightforward and mostly involve configuration updates.
• 🔒 Security concerns: No security concerns found

PR Feedback

💡 General suggestions: The PR is well-structured and the changes are clear. It would be beneficial to include a brief explanation of why these specific linting rules were chosen and how they will improve the code quality. Also, it would be good to ensure that these changes do not conflict with any existing linting rules or project conventions.

🤖 Code feedback:

---

relevant file	.eslintrc.json
suggestion	Consider adding a comment explaining the purpose of each rule for better maintainability. [medium]
relevant line	"+ "@typescript-eslint/no-unused-vars": "warn","

---

relevant file	apps/api-e2e/project.json
suggestion	It's good to see that linting has been extended to JSON files. However, make sure that the linting rules for JSON files are not too strict, as it could make the development process cumbersome. [medium]
relevant line	"+ "files": ["{package,project}.json"],"

---

---

✨ Usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Examples for extra instructions: [pr_reviewer] # /review # extra_instructions=""" In the code feedback section, emphasize the following: - Does the code logic cover relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

How to enable\disable automation When you first install PR-Agent app, the default mode for the review tool is: pr_commands = ["/review", ...] meaning the review tool will run automatically on every PR, with the default configuration. Edit this field to enable/disable the tool, or to change the used configurations

About the 'Code feedback' section The review tool provides several type of feedbacks, one of them is code suggestions. If you are interested only in the code suggestions, it is recommended to use the improve feature instead, since it dedicated only to code suggestions, and usually gives better results. Use the review tool if you want to get a more comprehensive feedback, which includes code suggestions as well.

Auto-labels The review tool can auto-generate two specific types of labels for a PR: a possible security issue label, that detects possible security issues (enable_review_labels_security flag) a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)

Extra sub-tools The review tool provides a collection of possible feedbacks about a PR. It is recommended to review the possible options, and choose the ones relevant for your use case. Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_review, enable_review_labels_effort, and more.

More PR-Agent commands To invoke the PR-Agent, add a comment using one of the following commands: /review: Request a review of your Pull Request. /describe: Update the PR title and description based on the contents of the PR. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[rajdip-b]

@HarshPatel5940 There is a package.json under apps/cli that is causing the pipeline to fail. Can you remove that and try your tests once?

[rajdip-b]

This is a known issue and i suggest that this is addressed in a new PR 😄

I believe that nx is meant to be used with only one package.json staying at the root level. Introducing multiple versions of them is essentially antipattern.

Why was it added in the first place?

[HarshPatel5940]

This is a known issue and i suggest that this is addressed in a new PR 😄

I believe that nx is meant to be used with only one package.json staying at the root level. Introducing multiple versions of them is essentially antipattern.

Why was it added in the first place?

It was added by this commit 9d5c521 from you only

[HarshPatel5940]

@HarshPatel5940 There is a package.json under apps/cli that is causing the pipeline to fail. Can you remove that and try your tests once?

Removed it 👍

[rajdip-b]

It was added by this commit 9d5c521 from you only

Thats rather strange :/ No idea why I added this! Anyway, thanks for pointing out!

[rajdip-b]

🎉 This PR is included in version 1.0.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

[rajdip-b]

🎉 This PR is included in version 1.0.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀