Fix minor text issues with the Setup Script

[ARYANSHAH1567]

The some of the setup script prompts need better clarification. So i fixed the setup script as per required.

Issue Number:
#2493

Summary by CodeRabbit

• New Features

  • Enhanced user prompts for generating access and refresh token secrets, emphasizing automation and providing clearer context for default and sample data.
  • Improved type safety in test helpers by changing type declarations from any to unknown.

• Bug Fixes

  • Adjusted test cases to ensure id properties are always assigned valid string values, preventing potential type mismatches.

• Chores

  • Updated ESLint configurations to allow mixed import styles and suppress warnings for unused variables across various files, improving code maintainability.

[coderabbitai]

Walkthrough

The changes involve updates to several TypeScript files, primarily focusing on modifying ESLint directives to disable specific rules related to import statements and unused variables. Additionally, there are enhancements to user prompts in the setup.ts file for clarity. Type declarations have been adjusted to improve type safety, and minor modifications to test cases ensure robustness against potential undefined values.

Changes

File(s)	Change Summary
scripts/githooks/update-toc.js, src/app.ts, src/middleware/isAuth.ts, src/resolvers/Mutation/forgotPassword.ts, src/setup/redisConfiguration.ts, src/setup/superAdmin.ts, tests/directives/directiveTransformer/authDirectiveTransformer.spec.ts, tests/directives/directiveTransformer/roleDirectiveTransformer.spec.ts	Added comments to disable ESLint rules regarding require imports and unused variables.
setup.ts	Enhanced user prompts for generating tokens and importing data, adding clarity and context.
tests/helpers/directChat.ts, tests/helpers/groupChat.ts	Modified type declarations to change Document<any, any, ...> to Document<unknown, unknown, ...>, improving type safety.
tests/resolvers/Query/directChatById.spec.ts, tests/resolvers/Query/groupChatById.spec.ts	Updated assignment of id in test cases to ensure it is always a string, preventing potential type issues.
tests/resolvers/Mutation/removeEvent.spec.ts, tests/resolvers/Mutation/removeMember.spec.ts, tests/resolvers/Mutation/updateEvent.spec.ts, tests/resolvers/Mutation/updatePluginStatus.spec.ts	Added comments to disable ESLint warnings related to unused expressions and variables in test cases.

Possibly related issues

• Upgrade package graphql from 16.8.1 to 16.9.0 #2382: The changes may facilitate the upgrade of the graphql package by improving the handling of imports and dependencies.
• Upgrade package react-i18next from 11.18.6 to 12.3.1 #2402: The adjustments in type declarations and user prompts could assist in the upgrade of react-i18next, ensuring compatibility with new syntax and functions.

Poem

🐰
In the garden where I play,
Changes bloom in bright array.
With prompts that guide and types so clear,
I hop along without a fear!
ESLint rules, now set just right,
Let’s celebrate this coding delight! 🌼

---

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

Early access features: disabled

We are currently testing the following features in early access:

• Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues on the discussion post.

[github-actions]

Our Pull Request Approval Process

We have these basic policies to make the approval process smoother for our volunteer team.

Testing Your Code

Please make sure your code passes all tests. Our test code coverage system will fail if these conditions occur:

1. The overall code coverage drops below the target threshold of the repository
2. Any file in the pull request has code coverage levels below the repository threshold
3. Merge conflicts

The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

1. comments in this PR or
2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

1. arbitrators of future discussions with other contributors about the validity of your changes
2. point of contact for evaluating the validity of your work
3. person who verifies matching issues by others that should be closed.
4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

1. PRs with issues not assigned to you will be closed by the reviewer
2. Fix the first comment in the PR so that each issue listed automatically closes

Other

1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
2. Read the CONTRIBUTING.md file make

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

tests/resolvers/Query/directChatById.spec.ts (1)

42-42: Use a valid ObjectId string as the fallback value.

The change is correctly using the nullish coalescing operator (??) to provide a fallback value when testDirectChat?._id is undefined. However, the fallback value of "defaultString" is not a valid ObjectId string.

Replace the fallback value with a valid ObjectId string:

-id: testDirectChat?._id.toString() ?? "defaultString",
+id: testDirectChat?._id.toString() ?? new Types.ObjectId().toString(),

tests/resolvers/Query/groupChatById.spec.ts (1)

45-45: LGTM with a minor suggestion!

The change is correctly using the nullish coalescing operator (??) to provide a default string value when testGroupChat?._id is undefined. It is also correctly converting the _id to a string using the toString() method.

Consider using a more meaningful default string value instead of "defaultString". For example, "testGroupChatId" or "mockGroupChatId" would be more descriptive and make the purpose of the default value clearer.

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 95597d7 and 835981c.

Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

Files selected for processing (18)

• scripts/githooks/update-toc.js (1 hunks)
• setup.ts (8 hunks)
• src/app.ts (1 hunks)
• src/middleware/isAuth.ts (1 hunks)
• src/resolvers/Mutation/forgotPassword.ts (1 hunks)
• src/setup/redisConfiguration.ts (1 hunks)
• src/setup/superAdmin.ts (1 hunks)
• src/utilities/imageAlreadyInDbCheck.ts (1 hunks)
• tests/directives/directiveTransformer/authDirectiveTransformer.spec.ts (1 hunks)
• tests/directives/directiveTransformer/roleDirectiveTransformer.spec.ts (1 hunks)
• tests/helpers/directChat.ts (1 hunks)
• tests/helpers/groupChat.ts (1 hunks)
• tests/resolvers/Mutation/removeEvent.spec.ts (2 hunks)
• tests/resolvers/Mutation/removeMember.spec.ts (1 hunks)
• tests/resolvers/Mutation/updateEvent.spec.ts (1 hunks)
• tests/resolvers/Mutation/updatePluginStatus.spec.ts (1 hunks)
• tests/resolvers/Query/directChatById.spec.ts (1 hunks)
• tests/resolvers/Query/groupChatById.spec.ts (1 hunks)

Files skipped from review due to trivial changes (14)

• scripts/githooks/update-toc.js
• setup.ts
• src/app.ts
• src/middleware/isAuth.ts
• src/resolvers/Mutation/forgotPassword.ts
• src/setup/redisConfiguration.ts
• src/setup/superAdmin.ts
• src/utilities/imageAlreadyInDbCheck.ts
• tests/directives/directiveTransformer/authDirectiveTransformer.spec.ts
• tests/directives/directiveTransformer/roleDirectiveTransformer.spec.ts
• tests/resolvers/Mutation/removeEvent.spec.ts
• tests/resolvers/Mutation/removeMember.spec.ts
• tests/resolvers/Mutation/updateEvent.spec.ts
• tests/resolvers/Mutation/updatePluginStatus.spec.ts

Additional comments not posted (2)

tests/helpers/groupChat.ts (1)

12-12: LGTM!

The change from any to unknown for the generic parameters of the Document type enhances type safety. This is a good practice in TypeScript.

tests/helpers/directChat.ts (1)

12-12: LGTM!

The change from any to unknown for the generic parameters of the Document type in TestDirectChatType enhances type safety. unknown is a more restrictive type than any and requires explicit type checking before usage. This change reflects a shift towards stricter type definitions, potentially improving the robustness of the code by enforcing better type constraints.