Refactor test file from Jest to Vitest: askForTalawaApiUrl.spec.ts

[aryanrule]

what kind of changes does the PR introduce ?
refracting from jest to vitest for src/setup/askForTalawaApiUrl/askForTalawaApiUrl.test.ts

Issue Number
Fixes #2749

Did you add tests for your changes?
Yes, all test cases were updated and verified to work with Vitest.

snapshots/videos

Summary by CodeRabbit

I'll craft concise release notes based on the comprehensive summary of changes:

Release Notes for Talawa Admin v3.0.0

• New Features

  • Added comprehensive localization support for multiple languages (English, French, Spanish, Hindi, Chinese)
  • Enhanced GraphQL schema with robust authorization and role management
  • Implemented internationalization with dynamic language switching
  • Added new configuration and setup scripts for easier project initialization

• Configuration Updates

  • Updated project dependencies and build tools
  • Migrated from Create React App to Vite
  • Enhanced ESLint and Prettier configurations
  • Added comprehensive GitHub Actions workflows

• Development Improvements

  • Introduced new testing infrastructure
  • Added pre-commit and post-merge Git hooks
  • Implemented stricter code quality checks
  • Enhanced error handling and logging mechanisms

• Documentation

  • Updated installation, contribution, and issue reporting guidelines
  • Added comprehensive README and setup instructions
  • Introduced detailed code style and contribution documentation

• Localization

  • Added translation files for common UI elements and error messages
  • Supported languages: English, French, Spanish, Hindi, Chinese

[coderabbitai]

Walkthrough

This pull request introduces a comprehensive set of configuration files, workflow updates, and project restructuring for the Talawa Admin project. The changes span multiple aspects of the project, including environment configuration, testing setup, localization, GitHub workflows, and development tools. The modifications aim to enhance the project's development experience, code quality, and maintainability.

Changes

File/Directory	Change Summary
.coderabbit.yaml, .env.example, .eslintignore, .eslintrc.json	Configuration files updated with new settings for linting, language server, and environment variables
.github/workflows/	Multiple workflow files added for CI/CD, including issue management, pull request checks, code quality, and stale issue handling
public/locales/	Added localization files for English, French, Hindi, Spanish, and Chinese languages
scripts/	New utility scripts for testing, Git hooks, and development setup
config/, setup.ts	Added configuration files for Vite, Babel, and a new setup script
package.json	Updated dependencies, scripts, and project configuration

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Setup as Setup Script
    participant Env as .env File
    participant API as Talawa API
    participant Workflow as GitHub Workflows

    Dev->>Setup: Run setup.ts
    Setup->>Env: Check .env file
    alt .env does not exist
        Setup->>Env: Create from .env.example
        Setup->>Dev: Prompt for configuration
        Dev->>Setup: Provide API URL, reCAPTCHA settings
        Setup->>Env: Update with provided settings
    end
    Setup->>API: Validate API connection
    Setup->>Workflow: Trigger initial configuration checks

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Refactor src/setup/askForTalawaApiUrl/askForTalawaApiUrl.test.ts from Jest to Vitest [#2749]	❓	Partial implementation of Vitest migration, but specific file not directly addressed

Possibly related issues

• Refactor: src/screens/Requests from Jest to Vitest #2569: Refactoring src/screens/Requests from Jest to Vitest
• Refactor : src/components/CheckIn/CheckInWrapper.test.tsx from Jest to Vitest #2495: Refactoring src/components/CheckIn/CheckInWrapper.test.tsx from Jest to Vitest
• Refactor: src/components/AddOn/support/components/MainContent/MainContent.test.tsx from Jest to Vitest #2475: Refactoring src/components/AddOn/support/components/MainContent/MainContent.test.tsx from Jest to Vitest

Possibly related PRs

• Refactor: jest to vitest of itemDeleteModal : fixes #2557 #2713: Refactoring tests from Jest to Vitest
• Refactor : src/screens/OrgContribution component from Jest to Vitest #2729: Another Jest to Vitest test refactoring
• fixed:#2475 Refactor: src/components/AddOn/support/components/MainContent/MainContent.test.tsx from Jest to Vitest #2843: Jest to Vitest test refactoring
• Refactor src/components/SuperAdminScreen/SuperAdminScreen.test.tsx from Jest to Vitest #2820 #2874: Jest to Vitest test refactoring

Suggested reviewers

• @palisadoes

Poem

🐰 A Rabbit's Configuration Tale 🚀

In lines of YAML and workflows bright,
Our code now dances with testing might
Locales bloom in languages five
Configurations help our project thrive

Hop, hop, hooray! The setup's complete 🌈

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[github-actions]

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

1. We don't merge PRs with poor code quality.
   1. Follow coding best practices such that CodeRabbit.ai approves your PR.
2. We don't merge PRs with failed tests.
   1. When tests fail, click on the Details link to learn more.
   2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
   3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

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

[github-actions]

Congratulations on making your first PR! 🎊 If you haven't already, check out our Contributing Guidelines and PR Reporting Guidelines to ensure that you are following our guidelines for contributing and creating PR.

[coderabbitai]

Actionable comments posted: 28

🧹 Nitpick comments (51)

.github/workflows/stale.yml (1)

12-21: Remove trailing spaces

There are trailing spaces on lines 20 and 21 that should be removed for consistency.

  issues: write
- pull-requests: write  
  
+ pull-requests: write
+

🧰 Tools

🪛 yamllint (1.35.1)

[error] 20-20: trailing spaces

(trailing-spaces)

---

[error] 21-21: trailing spaces

(trailing-spaces)

scripts/__mocks__/@pdfme/generator.ts (2)

10-13: Enforce more descriptive error handling and logging.
Throwing a generic Error is fine, but it might be beneficial to provide more context or details, especially if this function is used in a complex flow. Consider logging or returning an error code to help diagnose issues.

- throw new Error('Template or inputs cannot be empty.');
+ throw new Error('[pdfme/generator]: Template or inputs cannot be empty.');

---

14-22: Efficient mock PDF generation.
The overall approach is good for test mocking purposes. Generating random content and returning Uint8Array ensures a successful mock for PDF-related logic. Consider using await instead of directly returning Promise.resolve for consistency and clarity in async code.

- return Promise.resolve(new Uint8Array([...pdfHeader, ...mockContent]));
+ return new Uint8Array([...pdfHeader, ...mockContent]);

.github/workflows/push.yml (4)

14-18: Consider optimizing branch patterns for workflow triggers

The current pattern '**' will trigger the workflow for all branches. Consider limiting this to specific branches (e.g., main/develop) or excluding certain patterns (e.g., documentation-only branches) to optimize CI resources.

 on:
   push:
     branches:
-      - '**'   
+      - 'main'
+      - 'develop'
+      - 'feature/**'
+      - 'bugfix/**'

🧰 Tools

🪛 yamllint (1.35.1)

[error] 17-17: trailing spaces

(trailing-spaces)

---

[error] 18-18: trailing spaces

(trailing-spaces)

---

19-20: Fix indentation in env section

The environment variable section has incorrect indentation.

 env:
-    CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}
+  CODECOV_UNIQUE_NAME: CODECOV_UNIQUE_NAME-${{ github.run_id }}-${{ github.run_number }}

🧰 Tools

🪛 yamllint (1.35.1)

[warning] 20-20: wrong indentation: expected 2 but found 4

(indentation)

---

54-54: Add timeout for test execution

Consider adding a timeout to prevent hanging test runs.

-      - run: npm run test -- --watchAll=false --coverage
+      - run: npm run test -- --watchAll=false --coverage --testTimeout=10000

---

56-61: Consider enabling fail_ci_if_error for Codecov

Setting fail_ci_if_error: false might hide coverage upload issues. Consider enabling it to ensure coverage data is always properly uploaded.

       uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         verbose: true
-        fail_ci_if_error: false
+        fail_ci_if_error: true
         name: '${{env.CODECOV_UNIQUE_NAME}}'

.husky/post-merge (1)

1-4: Consider using npm ci for reproducible installs.

Using npm install can introduce discrepancies in the installed dependency versions if local lockfiles are not in sync. To ensure reproducible builds and installations, consider switching to npm ci if your CI/CD workflow relies on clean installs and an up-to-date lockfile.

.husky/pre-commit (1)

1-10: Validate staged files instead of re-adding all files.

Running git add . might unintentionally stage new changes that haven't been formatted or linted. As a best practice, consider selectively adding only the files that have passed checks to avoid inadvertently committing unverified changes.

scripts/githooks/update-toc.js (1)

1-14: Remove extra line to comply with Prettier.

A Prettier rule flags the blank line after line 11. You can remove it for consistent formatting:

8 markdownFiles.forEach((file) => {
9   const command = `markdown-toc -i "${file}" --bullets "-"`;
10   execSync(command, { stdio: 'inherit' });
11- 
12 });
13
14 console.log('Table of contents updated successfully.');

🧰 Tools

🪛 eslint

[error] 11-12: Delete ··⏎

(prettier/prettier)

scripts/custom-test-env.js (2)

4-7: Add a TSDoc definition or remove the unrecognized tag.

The static analysis tool flags the @pdfme reference as undefined. If you intend to keep this reference, configure a custom TSDoc tag, or remove it to avoid warnings.

🧰 Tools

🪛 eslint

[error] 5-5: tsdoc-undefined-tag: The TSDoc tag "@pdfme" is not defined in this configuration

(tsdoc/syntax)

---

9-15: Clarify the return type or ignore the lint rule for JavaScript files.

ESLint’s @typescript-eslint/explicit-function-return-type might be triggering here because you’re defining an async method in a .js file. You can safely ignore it for JavaScript files, or switch to a .ts file if you want to specify return types with TypeScript.

🧰 Tools

🪛 eslint

[error] 9-9: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

---

[error] 9-9: Missing return type on function.

(@typescript-eslint/explicit-module-boundary-types)

config/vite.config.ts (1)

27-28: Update the comment to match the configured port.

The code sets the port to 4321, but the inline comment still references port 3000. This might confuse readers.

-    // this sets a default port to 3000
+    // this sets a default port to 4321

.github/workflows/check-tsdoc.js (1)

37-47: Ensure coverage of further TSDoc checks if needed.

The containsTsDocComment function currently looks for any TSDoc-style comment, but doesn’t verify completeness or correctness. If more in-depth TSDoc validation is desired, consider integrating advanced parsing or specialized TSDoc tooling.

jest.config.js (2)

33-33: Remove unintended whitespace to satisfy Prettier.

As suggested by the static analysis, removing extra spaces ensures consistent formatting.

-    '\\.svg\\?react$': '<rootDir>/scripts/__mocks__/fileMock.js', 
+    '\\.svg\\?react$': '<rootDir>/scripts/__mocks__/fileMock.js',

🧰 Tools

🪛 eslint

[error] 33-33: Delete ·

(prettier/prettier)

---

34-34: Add missing comma after the path if required by your style rules.

Prettier might expect a comma or a line break in multi-line statements. If this is a single-line config array, ensure the expression follows your style guidelines.

-    '^@pdfme/generator$': '<rootDir>/scripts/__mocks__/@pdfme/generator.ts'
+    '^@pdfme/generator$': '<rootDir>/scripts/__mocks__/@pdfme/generator.ts',

🧰 Tools

🪛 eslint

[error] 34-34: Insert ,

(prettier/prettier)

scripts/githooks/check-localstorage-usage.js (1)

89-92: Optional: Add trailing commas to satisfy Prettier.
Prettier suggests inserting trailing commas for multi-line calls. If your team enforces trailing commas, consider adding them to maintain consistent formatting. Otherwise, this can be ignored.

Example of how to add trailing commas

-  '\nInfo: Consider using custom hook functions.'
+  '\nInfo: Consider using custom hook functions.',
...
-  'Please use the getItem, setItem, and removeItem functions provided by the custom hook useLocalStorage.\n'
+  'Please use the getItem, setItem, and removeItem functions provided by the custom hook useLocalStorage.\n',

🧰 Tools

🪛 eslint

[error] 89-89: Insert ,

(prettier/prettier)

---

[error] 92-92: Insert ,

(prettier/prettier)

.github/workflows/eslint_disable_check.py (1)

61-61: Rename the unused variable so it’s clear it’s not used.
You can rename dirs to _dirs (a common Python convention) or remove it to avoid confusion.

-for root, dirs, files in os.walk(os.path.join(directory, 'src')):
+for root, _dirs, files in os.walk(os.path.join(directory, 'src')):

🧰 Tools

🪛 Ruff (0.8.2)

61-61: Loop control variable dirs not used within loop body

Rename unused dirs to _dirs

(B007)

.github/workflows/compare_translations.py (4)

64-73: Consider using type hints for better clarity.
Adding type hints to function parameters and return types helps increase readability and maintainability.

-def compare_translations(default_translation,
-    other_translation, default_file, other_file):
+def compare_translations(
+    default_translation: dict,
+    other_translation: dict,
+    default_file: str,
+    other_file: str
+) -> list:

---

135-135: Use exception chaining to preserve original traceback.
Raising with from e retains the underlying exception context, improving debuggability.

 except json.JSONDecodeError as e:
-    raise ValueError(f"Error decoding JSON from file {filepath}: {e}")
+    raise ValueError(f"Error decoding JSON from file {filepath}: {e}") from e

🧰 Tools

🪛 Ruff (0.8.2)

135-135: Within an except clause, raise exceptions with raise ... from err or raise ... from None to distinguish them from errors in exception handling

(B904)

---

174-176: Refine error messages for user clarity.
Consider grouping or summarizing missing keys instead of printing them individually to simplify the output for large translation files.

---

185-209: Provide an option to handle partial checks.
Sometimes, teams prefer ignoring certain subfolders or partial translations. You could add an argument to allow skipping specific files or directories.

.coderabbit.yaml (1)

11-16: Consider environment-based auto-review toggles.
If you want to disable auto-review selectively in certain branches, you could introduce environment checks or additional conditions under auto_review.

.github/ISSUE_TEMPLATE/bug-report.md (1)

33-36: Fix markdown formatting issues

The markdown structure can be improved:

- **Potential internship candidates**
+ ### Potential internship candidates
 
 Please read this if you are planning to apply for a Palisadoes Foundation internship 
- https://github.com/PalisadoesFoundation/talawa/issues/359
+ [Internship Information](https://github.com/PalisadoesFoundation/talawa/issues/359)

🧰 Tools

🪛 Markdownlint (0.37.0)

36-36: null
Bare URL used

(MD034, no-bare-urls)

---

33-33: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

.github/ISSUE_TEMPLATE/feature-request.md (1)

25-28: Fix markdown formatting issues.

1. Use proper heading syntax for "Potential internship candidates"
2. Convert bare URL to proper markdown link format

Apply these changes:

-**Potential internship candidates**
+## Potential internship candidates
 
 Please read this if you are planning to apply for a Palisadoes Foundation internship 
-https://github.com/PalisadoesFoundation/talawa/issues/359
+[Internship Application Information](https://github.com/PalisadoesFoundation/talawa/issues/359)

🧰 Tools

🪛 Markdownlint (0.37.0)

28-28: null
Bare URL used

(MD034, no-bare-urls)

---

25-25: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

.github/workflows/codeql-codescan.yml (1)

17-17: Fix formatting issues.

There are several formatting issues in the workflow file:

• Remove trailing spaces
• Fix indentation levels

Also applies to: 20-20, 31-31, 37-37

🧰 Tools

🪛 yamllint (1.35.1)

[error] 17-17: trailing spaces

(trailing-spaces)

DOCUMENTATION.md (1)

25-25: Fix grammar in local development instructions

The sentence has a grammatical error.

-    - A local version of `docs.talawa.io` should automatically launched in your browser at http://localhost:3000/
+    - A local version of `docs.talawa.io` should automatically launch in your browser at http://localhost:3000/

🧰 Tools

🪛 Markdownlint (0.37.0)

25-25: null
Bare URL used

(MD034, no-bare-urls)

🪛 LanguageTool

[grammar] ~25-~25: The modal verb ‘should’ requires the verb’s base form.
Context: ...f docs.talawa.io should automatically launched in your browser at http://localhost:300...

(MD_BASEFORM)

.github/workflows/README.md (2)

24-24: Fix duplicate word in workflow guidelines

There's a duplicate word "to" in the sentence.

-      1. Place all actions related to to this in the `pull-request-target.yml` file.
+      1. Place all actions related to this in the `pull-request-target.yml` file.

🧰 Tools

🪛 LanguageTool

[duplication] ~24-~24: Possible typo: you repeated a word
Context: ...ors: 1. Place all actions related to to this in the pull-request-target.yml f...

(ENGLISH_WORD_REPEAT_RULE)

---

35-35: Fix abbreviation format

The abbreviation format should be "e.g." instead of "eg."

-1. Jobs only work correctly if they have a dedicated file (eg. `CodeQL`)
+1. Jobs only work correctly if they have a dedicated file (e.g., `CodeQL`)

🧰 Tools

🪛 LanguageTool

[uncategorized] ~35-~35: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...orrectly if they have a dedicated file (eg. CodeQL) ## Scripts Follow these gui...

(E_G)

public/locales/zh/common.json (1)

7-7: Remove trailing space in translation string

There's an unnecessary trailing space in the Chinese translation.

-  "noResultsFoundFor": "没有找到结果 ",
+  "noResultsFoundFor": "没有找到结果",

.github/workflows/issue.yml (3)

6-6: Remove trailing spaces

There are trailing spaces at the end of this line.

-# Please read the README.md file in this directory that defines what should 
+# Please read the README.md file in this directory that defines what should

🧰 Tools

🪛 yamllint (1.35.1)

[error] 6-6: trailing spaces

(trailing-spaces)

---

42-48: Simplify label conditions using array methods

The current implementation uses reduce for simple array inclusion checks. Consider using some() for better readability.

-            if(labels.data.reduce((a, c)=>a||["dependencies"].includes(c.name), false))
+            if(labels.data.some(label => ["dependencies"].includes(label.name)))
               await github.rest.issues.addLabels({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 issue_number: context.issue.number,
                 labels: ["good first issue", "security"]
               });
-            else if(labels.data.reduce((a, c)=>a||["security", "ui/ux"].includes(c.name), false))
+            else if(labels.data.some(label => ["security", "ui/ux"].includes(label.name)))
               await github.rest.issues.addLabels({
                 owner: context.repo.owner,
                 repo: context.repo.repo,
                 issue_number: context.issue.number,
                 labels: ["good first issue"]
               });

Also applies to: 49-55

---

66-66: Remove extra blank lines at end of file

Remove the extra blank line at the end of the file to maintain consistency.

🧰 Tools

🪛 yamllint (1.35.1)

[warning] 66-66: too many blank lines

(1 > 0) (empty-lines)

public/locales/en/common.json (1)

79-79: Standardize interpolation variable naming

The interpolation variables use inconsistent naming: {{text}} vs {{item}}. Consider standardizing the variable names across translations.

-  "searchResultsFor": "Search results for {{text}}",
+  "searchResultsFor": "Search results for {{query}}",
   ...
-  "searchBy": "Search by {{item}}"
+  "searchBy": "Search by {{field}}"

Also applies to: 97-97

ISSUE_GUIDELINES.md (1)

44-44: Capitalize "Slack" in channel references

"Slack" is a proper noun and should be capitalized.

-Ask our contributors to assign it to you in `#talawa` slack channel.
+Ask our contributors to assign it to you in `#talawa` Slack channel.
-Join our `#talawa-github` slack channel for automatic issue and pull request updates.
+Join our `#talawa-github` Slack channel for automatic issue and pull request updates.
-Discuss issues in our various slack channels when necessary
+Discuss issues in our various Slack channels when necessary

Also applies to: 53-53, 57-57

🧰 Tools

🪛 LanguageTool

[grammar] ~44-~44: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...butors to assign it to you in #talawa slack channel. Working on these types of exi...

(ON_SKYPE)

README.md (1)

53-53: Fix heading formatting

Remove extra spaces after the hash symbol.

-#  Videos
+# Videos

🧰 Tools

🪛 Markdownlint (0.37.0)

53-53: null
Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

.github/workflows/pull-request-target.yml (1)

6-6: Fix YAML formatting: Remove trailing spaces

Multiple lines contain trailing spaces which should be removed according to YAML best practices.

-    # be placed in this file 
+    # be placed in this file
-on: 
+on:
-  pull_request_target:
+  pull_request_target:
# ... (similar changes for other lines)

Also applies to: 13-13, 15-15, 27-27, 28-28, 29-29, 31-31, 33-33, 34-34, 36-36, 41-41, 46-46, 71-71

🧰 Tools

🪛 yamllint (1.35.1)

[error] 6-6: trailing spaces

(trailing-spaces)

PR_GUIDELINES.md (2)

31-34: Add language specifiers to code blocks

The code blocks should specify the shell language for better syntax highlighting.

-```
+```shell
npm run lint:fix
npm run format:fix

Also applies to: 39-42

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint (0.37.0)</summary>

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

---

`56-56`: **Improve sentence structure in review policy**

Consider revising for clarity and formality:

```diff
-The quality of our code is very important to us. Therefore we make experienced maintainers of our code base review your code.
+The quality of our code is crucial. Therefore, we ensure experienced maintainers review your code.

🧰 Tools

🪛 LanguageTool

[style] ~56-~56: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...o be closed. The quality of our code is very important to us. Therefore we make experienced ma...

(EN_WEAK_ADJECTIVE)

---

[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...ty of our code is very important to us. Therefore we make experienced maintainers of our ...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

package.json (1)

8-70: Consider using exact versions for dependencies

Using caret (^) for dependency versions could lead to unexpected breaking changes. Consider using exact versions or a more restrictive range for better stability.

Example:

-    "@apollo/client": "^3.11.8",
+    "@apollo/client": "3.11.8",

CODE_STYLE.md (1)

127-137: Fix markdown list indentation

The file structure section has inconsistent list indentation which affects readability.

Apply consistent 2-space indentation for nested lists:

 `assets` - This houses all of the static assets used in the project
-  - `css` - This houses all of the css files used in the project
-  - `images` - This houses all of the images used in the project
-  - `scss` - This houses all of the scss files used in the project
-    - `components -` All Sass files for components
+- `css` - This houses all of the css files used in the project
+- `images` - This houses all of the images used in the project
+- `scss` - This houses all of the scss files used in the project
+  - `components -` All Sass files for components

🧰 Tools

🪛 Markdownlint (0.37.0)

128-128: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

129-129: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

130-130: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

131-131: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

132-132: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

133-133: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

134-134: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

135-135: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

136-136: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

137-137: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

🪛 LanguageTool

[style] ~127-~127: Consider removing “of” to be more concise
Context: ...tories of src assets - This houses all of the static assets used in the project - `...

(ALL_OF_THE)

---

[style] ~128-~128: Consider removing “of” to be more concise
Context: ... in the project - css - This houses all of the css files used in the project - `imag...

(ALL_OF_THE)

---

[style] ~129-~129: Consider removing “of” to be more concise
Context: ... the project - images - This houses all of the images used in the project - scss -...

(ALL_OF_THE)

---

[style] ~130-~130: Consider removing “of” to be more concise
Context: ...in the project - scss - This houses all of the scss files used in the project - `c...

(ALL_OF_THE)

---

[grammar] ~134-~134: The singular proper name ‘Sass’ must be used with a third-person or a past tense verb.
Context: ...rms - _talawa.scss - Partial Sass file for Talawa - _utilities.scss - Pa...

(HE_VERB_AGR)

---

[grammar] ~135-~135: The singular proper name ‘Sass’ must be used with a third-person or a past tense verb.
Context: ... - _utilities.scss - Partial Sass file for utilities - _variables.scss -...

(HE_VERB_AGR)

---

[grammar] ~136-~136: The singular proper name ‘Sass’ must be used with a third-person or a past tense verb.
Context: ... - _variables.scss - Partial Sass file for variables - app.scss - Main S...

(HE_VERB_AGR)

CONTRIBUTING.md (4)

104-104: Add language specifiers to code blocks.

Code blocks should specify the language for proper syntax highlighting. Add appropriate language identifiers like bash, shell, etc.

For example:

-```
+```bash
npm install

Also applies to: 142-142, 154-154, 164-164, 188-188, 194-194, 200-200, 208-208, 214-214, 220-220, 240-240, 256-256, 264-264, 270-270, 292-292, 300-300, 313-313

🧰 Tools

🪛 Markdownlint (0.37.0)

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

Line range hint 327-327: Use fenced code blocks consistently.

Replace indented code blocks with fenced code blocks for consistency.

-        git commit -m "commit message" --no-verify
+```bash
+git commit -m "commit message" --no-verify
+```

-        git pull --no-verify
+```bash
+git pull --no-verify
+```

Also applies to: 335-335

🧰 Tools

🪛 LanguageTool

[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ibuting to open source, please read the Open Source Guides on [How to Contribute to Open So...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[style] ~27-~27: This expression usually appears with a “please” in front of it.
Context: ...DUCT.md) to understand what this means. Let us know immediately if you have unacceptable ex...

(INSERT_PLEASE)

---

[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...)" videos are extremely helpful for new open source contributors. ## Ways to Contribute I...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[grammar] ~62-~62: A determiner may be missing.
Context: ...l Request guidelines](PR_GUIDELINES.md) is best resource to follow to start working on ...

(THE_SUPERLATIVE)

---

[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ushed to the main branch: - develop: For unstable code and bug fixing - `mai...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~69-~69: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...d bug fixing - main: Where the stable production ready code lies. This is our default branch. ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[typographical] ~73-~73: Consider adding a comma.
Context: ...ultiple developers are working on issues there is bound to be a conflict of interest (...

(IF_THERE_COMMA)

---

[typographical] ~73-~73: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...licts) among issues, PRs or even ideas. Usually these conflicts are resolved in a **Fir...

(RB_LY_COMMA)

---

[grammar] ~73-~73: Did you mean “served” (as in the idiom ‘first come, first served’)?
Context: ...ts are resolved in a First Come First Serve basis however there are certain excep...

(FIRST_SERVED)

---

[grammar] ~75-~75: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...tant to ask the author of the PR in the slack channel or in their PRs or issues thems...

(ON_SKYPE)

---

[style] ~77-~77: ‘Last but not the least’ might be wordy. Consider a shorter alternative.
Context: ...y and test that function when needed. - Last but not the least, communication is important make sure t...

(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_THE_LEAST)

---

[grammar] ~77-~77: It seems that “to” is missing before the verb.
Context: ...t the least, communication is important make sure to talk to other contributors, in ...

(MISSING_TO_BETWEEN_BE_AND_VB)

---

[grammar] ~77-~77: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ... other contributors, in these cases, in slack channel or in a issue/PR thread. - As a...

(ON_SKYPE)

---

[misspelling] ~77-~77: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... in these cases, in slack channel or in a issue/PR thread. - As a last resort the...

(EN_A_VS_AN)

---

[typographical] ~78-~78: It appears that a comma is missing.
Context: ...el or in a issue/PR thread. - As a last resort the Admins would be responsible for dec...

(DURING_THAT_TIME_COMMA)

---

178-178: Fix invalid link fragments.

The following link fragments are invalid due to case sensitivity:

• #setting-up-REACT_APP_TALAWA_URL-in-env-file
• #setting-up-REACT_APP_RECAPTCHA_SITE_KEY-in-env-file

Use lowercase in the link fragments to match the actual heading IDs:

-[Setting up REACT_APP_TALAWA_URL in .env file](#setting-up-REACT_APP_TALAWA_URL-in-env-file)
+[Setting up REACT_APP_TALAWA_URL in .env file](#setting-up-react_app_talawa_url-in-env-file)

-[Setting up REACT_APP_RECAPTCHA_SITE_KEY in .env file](#setting-up-REACT_APP_RECAPTCHA_SITE_KEY-in-env-file)
+[Setting up REACT_APP_RECAPTCHA_SITE_KEY in .env file](#setting-up-react_app_recaptcha_site_key-in-env-file)

🧰 Tools

🪛 LanguageTool

[grammar] ~178-~178: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...dation/talawa) for the link to join our slack channel. 1. We also have a technical em...

(ON_SKYPE)

---

Line range hint 321-321: Fix heading levels.

The heading levels should only increment by one level at a time. The current structure jumps from h2 to h4.

-#### pre-commit hook
+### pre-commit hook

-#### post-merge hook
+### post-merge hook

Also applies to: 329-329

🧰 Tools

🪛 LanguageTool

[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ibuting to open source, please read the Open Source Guides on [How to Contribute to Open So...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[style] ~27-~27: This expression usually appears with a “please” in front of it.
Context: ...DUCT.md) to understand what this means. Let us know immediately if you have unacceptable ex...

(INSERT_PLEASE)

---

[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...)" videos are extremely helpful for new open source contributors. ## Ways to Contribute I...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[grammar] ~62-~62: A determiner may be missing.
Context: ...l Request guidelines](PR_GUIDELINES.md) is best resource to follow to start working on ...

(THE_SUPERLATIVE)

---

[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ushed to the main branch: - develop: For unstable code and bug fixing - `mai...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~69-~69: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...d bug fixing - main: Where the stable production ready code lies. This is our default branch. ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[typographical] ~73-~73: Consider adding a comma.
Context: ...ultiple developers are working on issues there is bound to be a conflict of interest (...

(IF_THERE_COMMA)

---

[typographical] ~73-~73: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...licts) among issues, PRs or even ideas. Usually these conflicts are resolved in a **Fir...

(RB_LY_COMMA)

---

[grammar] ~73-~73: Did you mean “served” (as in the idiom ‘first come, first served’)?
Context: ...ts are resolved in a First Come First Serve basis however there are certain excep...

(FIRST_SERVED)

---

[grammar] ~75-~75: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...tant to ask the author of the PR in the slack channel or in their PRs or issues thems...

(ON_SKYPE)

---

[style] ~77-~77: ‘Last but not the least’ might be wordy. Consider a shorter alternative.
Context: ...y and test that function when needed. - Last but not the least, communication is important make sure t...

(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_THE_LEAST)

---

[grammar] ~77-~77: It seems that “to” is missing before the verb.
Context: ...t the least, communication is important make sure to talk to other contributors, in ...

(MISSING_TO_BETWEEN_BE_AND_VB)

---

[grammar] ~77-~77: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ... other contributors, in these cases, in slack channel or in a issue/PR thread. - As a...

(ON_SKYPE)

---

[misspelling] ~77-~77: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... in these cases, in slack channel or in a issue/PR thread. - As a last resort the...

(EN_A_VS_AN)

---

[typographical] ~78-~78: It appears that a comma is missing.
Context: ...el or in a issue/PR thread. - As a last resort the Admins would be responsible for dec...

(DURING_THAT_TIME_COMMA)

INSTALLATION.md (2)

105-105: Format bare URLs.

Use proper markdown link syntax for URLs.

-first install `node.js` from their website at https://nodejs.org
+first install `node.js` from their website at [nodejs.org](https://nodejs.org)

🧰 Tools

🪛 Markdownlint (0.37.0)

105-105: null
Bare URL used

(MD034, no-bare-urls)

---

142-142: Add language specifiers to code blocks.

Code blocks should specify the language for proper syntax highlighting. Add appropriate language identifiers like bash, shell, etc.

For example:

-```
+```bash
npm install

Also applies to: 154-154, 164-164, 188-188, 194-194, 200-200, 208-208, 214-214, 220-220, 240-240, 256-256, 264-264, 270-270, 292-292, 300-300, 313-313

🧰 Tools

🪛 Markdownlint (0.37.0)

142-142: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

.github/workflows/countline.py (3)

35-56: Clarify the logic for _valid_filename to avoid confusion
Currently, this function returns False if the file name includes any of the substrings [".test.", ".spec."], effectively excluding them from analysis even though the function name _valid_filename suggests otherwise. If your intention is to ignore test files, consider renaming the function to _exclude_test_filenames for clarity. If this is not the intended behavior, you might want to refine or remove these checks.

---

58-79: Consider renaming _valid_extension to reflect its actual logic
This function currently checks only for invalid file extensions. Returning False if it discovers a disallowed extension may lead to confusion, since the function name suggests it performs validation for correctness. Using a more explicit name like _has_allowed_extension would better reflect its behavior.

---

197-294: Refine comment filtering to handle multiline or block comments
In the current logic, lines starting with # or / are excluded from the line count. This straightforward check might inadvertently include lines containing inline comments, or incorrectly exclude code lines that happen to start with /. If your goal is to skip true comment lines in multiple languages, consider adjusting the logic to account for multiline (/* ... */) or JavaScript (// ...) style comments, or explicitly parse file types.

.github/workflows/pull-request.yml (1)

182-227: Optimize test job dependencies

The Test-Application job could be optimized by running in parallel with other non-dependent jobs.

Consider updating the needs array to only include jobs that are truly required as prerequisites:

needs: [Code-Quality-Checks, Check-ESlint-Disable]
+ needs: [Code-Quality-Checks]

The ESLint check is already part of Code-Quality-Checks, so including it separately is redundant.

🧰 Tools

🪛 yamllint (1.35.1)

[error] 197-197: trailing spaces

(trailing-spaces)

---

[error] 201-201: trailing spaces

(trailing-spaces)

---

[error] 204-204: trailing spaces

(trailing-spaces)

---

[error] 205-205: trailing spaces

(trailing-spaces)

---

[error] 213-213: trailing spaces

(trailing-spaces)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c5a3000 and c3072a9.

⛔ Files ignored due to path filters (75)

• package-lock.json is excluded by !**/package-lock.json
• public/favicon.ico is excluded by !**/*.ico
• public/favicon_palisadoes.ico is excluded by !**/*.ico
• public/images/logo512.png is excluded by !**/*.png
• public/images/svg/angleDown.svg is excluded by !**/*.svg
• public/images/svg/arrow-left.svg is excluded by !**/*.svg
• public/images/svg/arrow-right.svg is excluded by !**/*.svg
• public/images/svg/attendees.svg is excluded by !**/*.svg
• public/images/svg/feedback.svg is excluded by !**/*.svg
• public/images/svg/profiledefault.svg is excluded by !**/*.svg
• public/images/svg/up-down.svg is excluded by !**/*.svg
• public/logo192.png is excluded by !**/*.png
• public/markdown/images/install1.png is excluded by !**/*.png
• public/markdown/images/install2.png is excluded by !**/*.png
• src/assets/css/app.css.map is excluded by !**/*.map
• src/assets/images/blank.png is excluded by !**/*.png
• src/assets/images/bronze.png is excluded by !**/*.png
• src/assets/images/defaultImg.png is excluded by !**/*.png
• src/assets/images/gold.png is excluded by !**/*.png
• src/assets/images/palisadoes_logo.png is excluded by !**/*.png
• src/assets/images/silver.png is excluded by !**/*.png
• src/assets/images/talawa-logo-600x600.png is excluded by !**/*.png
• src/assets/images/talawa-logo-dark-200x200.png is excluded by !**/*.png
• src/assets/images/talawa-logo-lite-200x200.png is excluded by !**/*.png
• src/assets/svgs/Attendance.svg is excluded by !**/*.svg
• src/assets/svgs/actionItem.svg is excluded by !**/*.svg
• src/assets/svgs/admin.svg is excluded by !**/*.svg
• src/assets/svgs/agenda-category-icon.svg is excluded by !**/*.svg
• src/assets/svgs/agenda-items.svg is excluded by !**/*.svg
• src/assets/svgs/angleRight.svg is excluded by !**/*.svg
• src/assets/svgs/article.svg is excluded by !**/*.svg
• src/assets/svgs/blockUser.svg is excluded by !**/*.svg
• src/assets/svgs/blockedUser.svg is excluded by !**/*.svg
• src/assets/svgs/cardItemDate.svg is excluded by !**/*.svg
• src/assets/svgs/cardItemEvent.svg is excluded by !**/*.svg
• src/assets/svgs/cardItemLocation.svg is excluded by !**/*.svg
• src/assets/svgs/chat.svg is excluded by !**/*.svg
• src/assets/svgs/checkInRegistrants.svg is excluded by !**/*.svg
• src/assets/svgs/dashboard.svg is excluded by !**/*.svg
• src/assets/svgs/date.svg is excluded by !**/*.svg
• src/assets/svgs/event.svg is excluded by !**/*.svg
• src/assets/svgs/events.svg is excluded by !**/*.svg
• src/assets/svgs/flask.svg is excluded by !**/*.svg
• src/assets/svgs/funds.svg is excluded by !**/*.svg
• src/assets/svgs/key.svg is excluded by !**/*.svg
• src/assets/svgs/listEventRegistrants.svg is excluded by !**/*.svg
• src/assets/svgs/location.svg is excluded by !**/*.svg
• src/assets/svgs/logout.svg is excluded by !**/*.svg
• src/assets/svgs/media.svg is excluded by !**/*.svg
• src/assets/svgs/newChat.svg is excluded by !**/*.svg
• src/assets/svgs/organizations.svg is excluded by !**/*.svg
• src/assets/svgs/palisadoes.svg is excluded by !**/*.svg
• src/assets/svgs/people.svg is excluded by !**/*.svg
• src/assets/svgs/plugins.svg is excluded by !**/*.svg
• src/assets/svgs/post.svg is excluded by !**/*.svg
• src/assets/svgs/posts.svg is excluded by !**/*.svg
• src/assets/svgs/requests.svg is excluded by !**/*.svg
• src/assets/svgs/roles.svg is excluded by !**/*.svg
• src/assets/svgs/settings.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Facebook-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Github-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Instagram-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Linkedin-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Reddit-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Slack-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/X-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/social-icons/Youtube-Logo.svg is excluded by !**/*.svg
• src/assets/svgs/tag.svg is excluded by !**/*.svg
• src/assets/svgs/tags.svg is excluded by !**/*.svg
• src/assets/svgs/talawa.svg is excluded by !**/*.svg
• src/assets/svgs/user.svg is excluded by !**/*.svg
• src/assets/svgs/userEvent.svg is excluded by !**/*.svg
• src/assets/svgs/users.svg is excluded by !**/*.svg
• src/assets/svgs/venues.svg is excluded by !**/*.svg
• src/assets/talawa-logo-lite-200x200.png is excluded by !**/*.png

📒 Files selected for processing (82)

• .coderabbit.yaml (1 hunks)
• .env.example (1 hunks)
• .eslintignore (1 hunks)
• .eslintrc.json (4 hunks)
• .github/ISSUE_TEMPLATE/bug-report.md (2 hunks)
• .github/ISSUE_TEMPLATE/feature-request.md (2 hunks)
• .github/dependabot.yaml (1 hunks)
• .github/pull_request_template.md (2 hunks)
• .github/workflows/README.md (1 hunks)
• .github/workflows/auto-label.json5 (1 hunks)
• .github/workflows/check-tsdoc.js (1 hunks)
• .github/workflows/ci.yml (0 hunks)
• .github/workflows/codeql-analysis.yml (0 hunks)
• .github/workflows/codeql-codescan.yml (1 hunks)
• .github/workflows/compare_translations.py (1 hunks)
• .github/workflows/countline.py (1 hunks)
• .github/workflows/eslint_disable_check.py (1 hunks)
• .github/workflows/issue.yml (1 hunks)
• .github/workflows/linter.yml (0 hunks)
• .github/workflows/npm-publish.yml (0 hunks)
• .github/workflows/pull-request-target.yml (1 hunks)
• .github/workflows/pull-request.yml (1 hunks)
• .github/workflows/push.yml (1 hunks)
• .github/workflows/stale.yml (1 hunks)
• .github/workflows/talawa_admin_md_mdx_format_adjuster.py (1 hunks)
• .gitignore (2 hunks)
• .husky/post-merge (1 hunks)
• .husky/pre-commit (1 hunks)
• .lintstagedrc.json (1 hunks)
• .node-version (1 hunks)
• .prettierignore (1 hunks)
• .prettierrc (1 hunks)
• CODEOWNERS (1 hunks)
• CODE_OF_CONDUCT.md (1 hunks)
• CODE_STYLE.md (1 hunks)
• CONTRIBUTING.md (2 hunks)
• DOCUMENTATION.md (1 hunks)
• Docker_Container/.dockerignore (0 hunks)
• Docker_Container/README.md (0 hunks)
• Docker_Container/docker-compose.yml (0 hunks)
• Docker_Container/dockerfile (0 hunks)
• INSTALLATION.md (1 hunks)
• ISSUE_GUIDELINES.md (1 hunks)
• ISSUE_TEMPLATE.md (0 hunks)
• PR-guidelines.md (0 hunks)
• PR_GUIDELINES.md (1 hunks)
• PULL_REQUEST_TEMPLATE.md (0 hunks)
• README.md (3 hunks)
• config/babel.config.cjs (1 hunks)
• config/vite.config.ts (1 hunks)
• index.html (1 hunks)
• issue-guidelines.md (0 hunks)
• jest-preview.config.ts (1 hunks)
• jest.config.js (1 hunks)
• package.json (2 hunks)
• public/index.html (0 hunks)
• public/locales/en/common.json (1 hunks)
• public/locales/en/errors.json (1 hunks)
• public/locales/en/translation.json (1 hunks)
• public/locales/fr/common.json (1 hunks)
• public/locales/fr/errors.json (1 hunks)
• public/locales/fr/translation.json (1 hunks)
• public/locales/hi/common.json (1 hunks)
• public/locales/hi/errors.json (1 hunks)
• public/locales/hi/translation.json (1 hunks)
• public/locales/sp/common.json (1 hunks)
• public/locales/sp/errors.json (1 hunks)
• public/locales/sp/translation.json (1 hunks)
• public/locales/zh/common.json (1 hunks)
• public/locales/zh/errors.json (1 hunks)
• public/locales/zh/translation.json (1 hunks)
• public/manifest.json (1 hunks)
• schema.graphql (1 hunks)
• scripts/__mocks__/@dicebear/collection.ts (1 hunks)
• scripts/__mocks__/@dicebear/core.ts (1 hunks)
• scripts/__mocks__/@pdfme/generator.test.ts (1 hunks)
• scripts/__mocks__/@pdfme/generator.ts (1 hunks)
• scripts/__mocks__/fileMock.js (1 hunks)
• scripts/custom-test-env.js (1 hunks)
• scripts/githooks/check-localstorage-usage.js (1 hunks)
• scripts/githooks/update-toc.js (1 hunks)
• setup.ts (1 hunks)

⛔ Files not processed due to max files limit (28)

• src/App.test.tsx
• src/App.tsx
• src/Constant/constant.spec.ts
• src/Constant/constant.ts
• src/GraphQl/Mutations/ActionItemCategoryMutations.ts
• src/GraphQl/Mutations/ActionItemMutations.ts
• src/GraphQl/Mutations/AgendaCategoryMutations.ts
• src/GraphQl/Mutations/AgendaItemMutations.ts
• src/GraphQl/Mutations/CampaignMutation.ts
• src/GraphQl/Mutations/CommentMutations.ts
• src/GraphQl/Mutations/EventAttendeeMutations.ts
• src/GraphQl/Mutations/EventVolunteerMutation.ts
• src/GraphQl/Mutations/FundMutation.ts
• src/GraphQl/Mutations/OrganizationMutations.ts
• src/GraphQl/Mutations/PledgeMutation.ts
• src/GraphQl/Mutations/TagMutations.ts
• src/GraphQl/Mutations/VenueMutations.ts
• src/GraphQl/Mutations/mutations.ts
• src/GraphQl/Queries/ActionItemCategoryQueries.ts
• src/GraphQl/Queries/ActionItemQueries.ts
• src/GraphQl/Queries/AgendaCategoryQueries.ts
• src/GraphQl/Queries/AgendaItemQueries.ts
• src/GraphQl/Queries/EventVolunteerQueries.ts
• src/GraphQl/Queries/OrganizationQueries.ts
• src/GraphQl/Queries/PlugInQueries.ts
• src/GraphQl/Queries/Queries.ts
• src/GraphQl/Queries/fundQueries.ts
• src/GraphQl/Queries/userTagQueries.ts

💤 Files with no reviewable changes (13)

• ISSUE_TEMPLATE.md
• issue-guidelines.md
• public/index.html
• Docker_Container/.dockerignore
• Docker_Container/docker-compose.yml
• .github/workflows/ci.yml
• PULL_REQUEST_TEMPLATE.md
• PR-guidelines.md
• .github/workflows/linter.yml
• .github/workflows/codeql-analysis.yml
• Docker_Container/README.md
• Docker_Container/dockerfile
• .github/workflows/npm-publish.yml

✅ Files skipped from review due to trivial changes (21)

• scripts/mocks/@dicebear/collection.ts
• .node-version
• CODEOWNERS
• scripts/mocks/fileMock.js
• .eslintignore
• .github/workflows/auto-label.json5
• public/locales/fr/errors.json
• .prettierrc
• public/locales/fr/common.json
• .prettierignore
• .lintstagedrc.json
• .github/dependabot.yaml
• config/babel.config.cjs
• scripts/mocks/@dicebear/core.ts
• public/locales/hi/errors.json
• public/locales/en/translation.json
• public/locales/zh/errors.json
• public/locales/zh/translation.json
• public/locales/sp/translation.json
• .env.example
• index.html

🧰 Additional context used

📓 Learnings (1)

scripts/githooks/check-localstorage-usage.js (1)

Learnt from: MayankJha014
PR: PalisadoesFoundation/talawa-admin#2612
File: scripts/githooks/check-localstorage-usage.js:10-18
Timestamp: 2024-12-07T14:25:09.928Z
Learning: TypeScript type annotations should not be added to JavaScript (`.js`) files in this project. Type annotations can only be used in TypeScript (`.ts` or `.tsx`) files.

🪛 Markdownlint (0.37.0)

README.md

53-53: null
Multiple spaces after hash on atx style heading

(MD019, no-multiple-space-atx)

DOCUMENTATION.md

25-25: null
Bare URL used

(MD034, no-bare-urls)

CODE_STYLE.md

128-128: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

129-129: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

130-130: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

131-131: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

132-132: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

133-133: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

134-134: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

135-135: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

136-136: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

137-137: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

164-164: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

165-165: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

166-166: Expected: 0; Actual: 2
Unordered list indentation

(MD007, ul-indent)

---

57-57: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

73-73: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

75-75: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

92-92: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

190-190: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

230-230: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

58-58: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

65-65: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

78-78: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

95-95: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

158-158: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

173-173: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

181-181: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

239-239: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

245-245: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

251-251: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

.github/ISSUE_TEMPLATE/feature-request.md

28-28: null
Bare URL used

(MD034, no-bare-urls)

---

25-25: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

CONTRIBUTING.md

104-104: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

113-113: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

128-128: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

139-139: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

143-143: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

158-158: null
No empty links

(MD042, no-empty-links)

---

159-159: null
No empty links

(MD042, no-empty-links)

---

161-161: null
No empty links

(MD042, no-empty-links)

.github/ISSUE_TEMPLATE/bug-report.md

36-36: null
Bare URL used

(MD034, no-bare-urls)

---

33-33: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

PR_GUIDELINES.md

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

39-39: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

INSTALLATION.md

321-321: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time

(MD001, heading-increment)

---

33-33: Expected: 4; Actual: 6
Unordered list indentation

(MD007, ul-indent)

---

34-34: Expected: 4; Actual: 6
Unordered list indentation

(MD007, ul-indent)

---

95-95: null
Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

105-105: null
Bare URL used

(MD034, no-bare-urls)

---

142-142: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

154-154: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

164-164: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

188-188: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

194-194: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

200-200: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

208-208: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

214-214: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

220-220: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

240-240: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

256-256: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

264-264: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

270-270: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

292-292: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

300-300: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

313-313: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

327-327: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

---

335-335: Expected: fenced; Actual: indented
Code block style

(MD046, code-block-style)

---

178-178: Expected: #setting-up-react_app_talawa_url-in-env-file; Actual: #setting-up-REACT_APP_TALAWA_URL-in-env-file
Link fragments should be valid

(MD051, link-fragments)

---

178-178: Expected: #setting-up-react_app_recaptcha_site_key-in-env-file; Actual: #setting-up-REACT_APP_RECAPTCHA_SITE_KEY-in-env-file
Link fragments should be valid

(MD051, link-fragments)

🪛 LanguageTool

README.md

[uncategorized] ~56-~56: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...)" videos are extremely helpful for new open source contributors.

(EN_COMPOUND_ADJECTIVE_INTERNAL)

DOCUMENTATION.md

[grammar] ~25-~25: The modal verb ‘should’ requires the verb’s base form.
Context: ...f docs.talawa.io should automatically launched in your browser at http://localhost:300...

(MD_BASEFORM)

---

[grammar] ~26-~26: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...ttp://localhost:3000/ 1. Add/modify the markdown documents to the docs/ directory of t...

(MARKDOWN_NNP)

---

[uncategorized] ~32-~32: The preposition “to” seems more likely in this position.
Context: ... PLEASE do not add markdown files in this repository. Add them to `talawa-do...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

CODE_STYLE.md

[style] ~127-~127: Consider removing “of” to be more concise
Context: ...tories of src assets - This houses all of the static assets used in the project - `...

(ALL_OF_THE)

---

[style] ~128-~128: Consider removing “of” to be more concise
Context: ... in the project - css - This houses all of the css files used in the project - `imag...

(ALL_OF_THE)

---

[style] ~129-~129: Consider removing “of” to be more concise
Context: ... the project - images - This houses all of the images used in the project - scss -...

(ALL_OF_THE)

---

[style] ~130-~130: Consider removing “of” to be more concise
Context: ...in the project - scss - This houses all of the scss files used in the project - `c...

(ALL_OF_THE)

---

[grammar] ~134-~134: The singular proper name ‘Sass’ must be used with a third-person or a past tense verb.
Context: ...rms - _talawa.scss - Partial Sass file for Talawa - _utilities.scss - Pa...

(HE_VERB_AGR)

---

[grammar] ~135-~135: The singular proper name ‘Sass’ must be used with a third-person or a past tense verb.
Context: ... - _utilities.scss - Partial Sass file for utilities - _variables.scss -...

(HE_VERB_AGR)

---

[grammar] ~136-~136: The singular proper name ‘Sass’ must be used with a third-person or a past tense verb.
Context: ... - _variables.scss - Partial Sass file for variables - app.scss - Main S...

(HE_VERB_AGR)

---

[style] ~141-~141: Consider removing “of” to be more concise
Context: ...views/screens Constant - This houses all of the constants used in the project `GraphQl...

(ALL_OF_THE)

---

[style] ~143-~143: Consider removing “of” to be more concise
Context: ...in the project GraphQl - This houses all of the GraphQL queries and mutations used in t...

(ALL_OF_THE)

---

[style] ~145-~145: Consider removing “of” to be more concise
Context: ...in the project screens - This houses all of the views/screens to be navigated through i...

(ALL_OF_THE)

---

[style] ~147-~147: Consider removing “of” to be more concise
Context: ... in Talawa-Admin state - This houses all of the state management code for the project ...

(ALL_OF_THE)

---

[uncategorized] ~165-~165: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...following order: - React imports - Third party imports - Local imports If there is...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

ISSUE_GUIDELINES.md

[uncategorized] ~2-~2: Loose punctuation mark.
Context: # Issue Report Guidelines 👍🎉 First off, thanks for taking t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[style] ~4-~4: Consider a shorter alternative to avoid wordiness.
Context: ...ing the time to contribute! 🎉👍 In order to give everyone a chance to submit a issu...

(IN_ORDER_TO_PREMIUM)

---

[misspelling] ~5-~5: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...der to give everyone a chance to submit a issues reports and contribute to the Ta...

(EN_A_VS_AN)

---

[typographical] ~24-~24: Consider adding a comma here.
Context: ...> ___ ## Issue Management In all cases please use the [GitHub open issue search](http...

(PLEASE_COMMA)

---

[uncategorized] ~27-~27: A comma might be missing here.
Context: ...reported. ### New Issues To create new issues follow these steps: 1. Your issue may ...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

---

[style] ~30-~30: Consider using a different verb for a more formal wording.
Context: .... 1. Verify whether the issue has been fixed by trying to reproduce it using the lat...

(FIX_RESOLVE)

---

[style] ~35-~35: The wording of this phrase can be improved.
Context: ...lcome contributors who find new ways to make the code better. ### Existing Issues You can also be ...

(MAKE_STYLE_BETTER)

---

[grammar] ~44-~44: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...butors to assign it to you in #talawa slack channel. Working on these types of exi...

(ON_SKYPE)

---

[grammar] ~53-~53: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...ew Issues 1. Join our #talawa-github slack channel for automatic issue and pull re...

(ON_SKYPE)

---

[grammar] ~57-~57: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...lines 1. Discuss issues in our various slack channels when necessary 2. Please do no...

(ON_SKYPE)

---

[typographical] ~57-~57: Consider adding a comma here.
Context: ...ur various slack channels when necessary 2. Please do not derail or troll issues. 3. Keep...

(PLEASE_COMMA)

.github/workflows/README.md

[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ding on the type of workflow. Whenever possible you must ensure that: 1. The file roles...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[duplication] ~24-~24: Possible typo: you repeated a word
Context: ...ors: 1. Place all actions related to to this in the pull-request-target.yml f...

(ENGLISH_WORD_REPEAT_RULE)

---

[uncategorized] ~35-~35: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...orrectly if they have a dedicated file (eg. CodeQL) ## Scripts Follow these gui...

(E_G)

CONTRIBUTING.md

[style] ~27-~27: This expression usually appears with a “please” in front of it.
Context: ...DUCT.md) to understand what this means. Let us know immediately if you have unacceptable ex...

(INSERT_PLEASE)

---

[uncategorized] ~34-~34: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...)" videos are extremely helpful for new open source contributors. ## Ways to Contribute I...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[grammar] ~62-~62: A determiner may be missing.
Context: ...l Request guidelines](PR_GUIDELINES.md) is best resource to follow to start working on ...

(THE_SUPERLATIVE)

---

[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ushed to the main branch: - develop: For unstable code and bug fixing - `mai...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~69-~69: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...d bug fixing - main: Where the stable production ready code lies. This is our default branch. ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[typographical] ~73-~73: Consider adding a comma.
Context: ...ultiple developers are working on issues there is bound to be a conflict of interest (...

(IF_THERE_COMMA)

---

[typographical] ~73-~73: Consider adding a comma after ‘Usually’ for more clarity.
Context: ...licts) among issues, PRs or even ideas. Usually these conflicts are resolved in a **Fir...

(RB_LY_COMMA)

---

[grammar] ~73-~73: Did you mean “served” (as in the idiom ‘first come, first served’)?
Context: ...ts are resolved in a First Come First Serve basis however there are certain excep...

(FIRST_SERVED)

---

[grammar] ~75-~75: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...tant to ask the author of the PR in the slack channel or in their PRs or issues thems...

(ON_SKYPE)

---

[style] ~77-~77: ‘Last but not the least’ might be wordy. Consider a shorter alternative.
Context: ...y and test that function when needed. - Last but not the least, communication is important make sure t...

(EN_WORDINESS_PREMIUM_LAST_BUT_NOT_THE_LEAST)

---

[grammar] ~77-~77: It seems that “to” is missing before the verb.
Context: ...t the least, communication is important make sure to talk to other contributors, in ...

(MISSING_TO_BETWEEN_BE_AND_VB)

---

[grammar] ~77-~77: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ... other contributors, in these cases, in slack channel or in a issue/PR thread. - As a...

(ON_SKYPE)

---

[misspelling] ~77-~77: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... in these cases, in slack channel or in a issue/PR thread. - As a last resort the...

(EN_A_VS_AN)

---

[typographical] ~78-~78: It appears that a comma is missing.
Context: ...el or in a issue/PR thread. - As a last resort the Admins would be responsible for dec...

(DURING_THAT_TIME_COMMA)

---

[grammar] ~135-~135: The operating system from Apple is written “macOS”.
Context: ...r packages can be found for Windows and MacOS. 6. The currently acceptable c...

(MAC_OS)

---

[grammar] ~165-~165: The past participle is required after “must be”.
Context: ...branch_name>`.(Here branch name must be name of the branch you want to push the chan...

(BE_VBP_IN)

---

[grammar] ~178-~178: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...dation/talawa) for the link to join our slack channel. 1. We also have a technical em...

(ON_SKYPE)

PR_GUIDELINES.md

[uncategorized] ~2-~2: Loose punctuation mark.
Context: # Pull Request Guidelines 👍🎉 First off, thanks for taking t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[style] ~4-~4: Consider a shorter alternative to avoid wordiness.
Context: ...ing the time to contribute! 🎉👍 In order to give everyone a chance to submit a pull...

(IN_ORDER_TO_PREMIUM)

---

[style] ~46-~46: Style-wise, it’s not ideal to insert an adverb (‘manually’) in the middle of an infinitive construction (‘to test’). Try moving the adverb to avoid split infinitives.
Context: ..., you'll need to tell us what steps you followed to manually test your changes. 1. Please read our [CONTRIBUTING.md](C...

(SPLIT_INFINITIVE)

---

[style] ~56-~56: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...o be closed. The quality of our code is very important to us. Therefore we make experienced ma...

(EN_WEAK_ADJECTIVE)

---

[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...ty of our code is very important to us. Therefore we make experienced maintainers of our ...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

---

[style] ~59-~59: Consider using a different verb for a more formal wording.
Context: ...check if all tests are passing; if not, fix the issues and then create a pull reque...

(FIX_RESOLVE)

---

[style] ~64-~64: This expression is wordy and overused. Consider replacing it with a more concise and formal alternative.
Context: ...wer your questions, but we'll get to it sooner or later. @mentioning someone just adds to the p...

(SOONER_OR_LATER)

---

[uncategorized] ~64-~64: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...adds to the pile of notifications we get and it won't make us look at your issue fas...

(COMMA_COMPOUND_SENTENCE)

---

[style] ~65-~65: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ue faster. 1. Do not force push. If you make changes to your pull request, please simply add a ...

(MAKE_CHANGES)

INSTALLATION.md

[duplication] ~25-~25: Possible typo: you repeated a word
Context: ...](#running-talawa-admin) - Accessing Talawa-Admin - [Talawa-Admin Registration](#talawa-admin-registratio...

(ENGLISH_WORD_REPEAT_RULE)

---

[typographical] ~55-~55: It appears that a comma is missing.
Context: ... that follow. # Prerequisites In this section we'll explain how to set up all the pre...

(DURING_THAT_TIME_COMMA)

---

[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... Basic git knowledge is required for open source contribution so make sure you're comfor...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[grammar] ~67-~67: The word “setup” is a noun. The verb is spelled with a space.
Context: ...avigate to the folder where you want to setup the repository. 2. Open a cmd (Window...

(NOUN_VERB_CONFUSION)

---

[grammar] ~68-~68: The operating system from Apple is written “macOS”.
Context: ...cmd (Windows) or terminal (Linux or MacOS) session in this folder. 1. An easy ...

(MAC_OS)

---

[uncategorized] ~70-~70: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e option based on your OS. 3. For Our Open Source Contributor Software Developers: ...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[grammar] ~102-~102: The operating system from Apple is written “macOS”.
Context: ...node.jspackages in Windows, Linux and MacOS. 1. For Windows: 1. first install...

(MAC_OS)

---

[duplication] ~116-~116: Possible typo: you repeated a word
Context: ... 5. Save the document. 6. Exit notepad 7. Exit PowerShell 8. This will ensure...

(ENGLISH_WORD_REPEAT_RULE)

---

[grammar] ~119-~119: The operating system from Apple is written “macOS”.
Context: ...t version of node.js 2. For Linux and MacOS, use the terminal window. 1. install...

(MAC_OS)

---

[grammar] ~123-~123: The word “setup” is a noun. The verb is spelled with a white space.
Context: ... the respective recommended commands to setup your node environment 3. This wil...

(NOUN_VERB_CONFUSION)

---

[uncategorized] ~162-~162: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...at runtime. It is not a part of the repo and you will have to create it. For a sampl...

(COMMA_COMPOUND_SENTENCE)

---

[grammar] ~228-~228: The word “setup” is a noun. The verb is spelled with a space.
Context: ...E_KEY in .env file You may not want to setup reCAPTCHA since the project will still ...

(NOUN_VERB_CONFUSION)

---

[grammar] ~232-~232: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ad the following steps. If you want to setup Google reCAPTCHA now, you may refer to ...

(NOUN_VERB_CONFUSION)

---

[typographical] ~246-~246: Except for inverted sentences, ‘need them’ requires a question mark at the end of the sentence.
Context: ...t need them or want to keep the console clean # Post Configuration Steps It's now t...

(MD_PRP_QUESTION_MARK)

---

[uncategorized] ~261-~261: Did you mean: “By default,”?
Context: ...n serve ``` ## Accessing Talawa-Admin By default talawa-admin runs on port `4321` on y...

(BY_DEFAULT_COMMA)

---

[grammar] ~311-~311: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...w.webp) ## Linting code files You can lint your code files using this command: ``...

(PRP_MD_NN)

CODE_OF_CONDUCT.md

[duplication] ~11-~11: Possible typo: you repeated a word
Context: ...-responsibilities) - Scope - Enforcement - Enforcement Guidelines ...

(ENGLISH_WORD_REPEAT_RULE)

🪛 eslint

scripts/custom-test-env.js

[error] 5-5: tsdoc-undefined-tag: The TSDoc tag "@pdfme" is not defined in this configuration

(tsdoc/syntax)

---

[error] 9-9: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

---

[error] 9-9: Missing return type on function.

(@typescript-eslint/explicit-module-boundary-types)

scripts/githooks/update-toc.js

[error] 11-12: Delete ··⏎

(prettier/prettier)

jest.config.js

[error] 33-33: Delete ·

(prettier/prettier)

---

[error] 34-34: Insert ,

(prettier/prettier)

scripts/githooks/check-localstorage-usage.js

[error] 10-10: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

---

[error] 20-20: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

---

[error] 43-43: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

---

[error] 89-89: Insert ,

(prettier/prettier)

---

[error] 92-92: Insert ,

(prettier/prettier)

🪛 yamllint (1.35.1)

.github/workflows/pull-request-target.yml

[error] 6-6: trailing spaces

(trailing-spaces)

---

[error] 13-13: trailing spaces

(trailing-spaces)

---

[error] 15-15: trailing spaces

(trailing-spaces)

---

[error] 27-27: trailing spaces

(trailing-spaces)

---

[error] 28-28: trailing spaces

(trailing-spaces)

---

[error] 29-29: trailing spaces

(trailing-spaces)

---

[error] 31-31: trailing spaces

(trailing-spaces)

---

[error] 33-33: trailing spaces

(trailing-spaces)

---

[error] 34-34: trailing spaces

(trailing-spaces)

---

[error] 36-36: trailing spaces

(trailing-spaces)

---

[error] 41-41: trailing spaces

(trailing-spaces)

---

[error] 46-46: trailing spaces

(trailing-spaces)

---

[error] 71-71: trailing spaces

(trailing-spaces)

.github/workflows/push.yml

[error] 6-6: trailing spaces

(trailing-spaces)

---

[error] 17-17: trailing spaces

(trailing-spaces)

---

[error] 18-18: trailing spaces

(trailing-spaces)

---

[warning] 20-20: wrong indentation: expected 2 but found 4

(indentation)

---

[error] 21-21: trailing spaces

(trailing-spaces)

---

[error] 50-50: trailing spaces

(trailing-spaces)

---

[warning] 62-62: too many blank lines

(1 > 0) (empty-lines)

.github/workflows/codeql-codescan.yml

[error] 6-6: trailing spaces

(trailing-spaces)

---

[error] 17-17: trailing spaces

(trailing-spaces)

---

[error] 20-20: trailing spaces

(trailing-spaces)

---

[warning] 31-31: wrong indentation: expected 6 but found 7

(indentation)

---

[warning] 37-37: wrong indentation: expected 11 but found 10

(indentation)

.github/workflows/stale.yml

[error] 6-6: trailing spaces

(trailing-spaces)

---

[error] 20-20: trailing spaces

(trailing-spaces)

---

[error] 21-21: trailing spaces

(trailing-spaces)

.github/workflows/issue.yml

[error] 6-6: trailing spaces

(trailing-spaces)

---

[warning] 15-15: wrong indentation: expected 4 but found 6

(indentation)

---

[warning] 66-66: too many blank lines

(1 > 0) (empty-lines)

.github/workflows/pull-request.yml

[error] 49-49: trailing spaces

(trailing-spaces)

---

[error] 60-60: trailing spaces

(trailing-spaces)

---

[error] 63-63: trailing spaces

(trailing-spaces)

---

[error] 92-92: trailing spaces

(trailing-spaces)

---

[error] 126-126: trailing spaces

(trailing-spaces)

---

[error] 129-129: trailing spaces

(trailing-spaces)

---

[error] 150-150: trailing spaces

(trailing-spaces)

---

[error] 157-157: trailing spaces

(trailing-spaces)

---

[error] 197-197: trailing spaces

(trailing-spaces)

---

[error] 201-201: trailing spaces

(trailing-spaces)

---

[error] 204-204: trailing spaces

(trailing-spaces)

---

[error] 205-205: trailing spaces

(trailing-spaces)

---

[error] 213-213: trailing spaces

(trailing-spaces)

---

[error] 243-243: trailing spaces

(trailing-spaces)

---

[error] 249-249: trailing spaces

(trailing-spaces)

---

[error] 251-251: trailing spaces

(trailing-spaces)

🪛 actionlint (1.7.4)

.github/workflows/codeql-codescan.yml

35-35: the runner of "github/codeql-action/init@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

41-41: the runner of "github/codeql-action/autobuild@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

44-44: the runner of "github/codeql-action/analyze@v2" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

.github/workflows/stale.yml

28-28: the runner of "actions/stale@v8" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

.github/workflows/issue.yml

29-29: the runner of "actions/github-script@v6" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

.github/workflows/pull-request.yml

61-61: property "changed_files" is not defined in object type {changed-files: {conclusion: string; outcome: string; outputs: {string => string}}}

(expression)

---

62-62: shellcheck reported issue in this script: SC2086:info:1:12: Double quote to prevent globbing and word splitting

(shellcheck)

---

79-79: "github.event.pull_request.head.ref" is potentially untrusted. avoid using it directly in inline scripts. instead, pass it through an environment variable. see https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions for more details

(expression)

🪛 Ruff (0.8.2)

.github/workflows/compare_translations.py

135-135: Within an except clause, raise exceptions with raise ... from err or raise ... from None to distinguish them from errors in exception handling

(B904)

.github/workflows/eslint_disable_check.py

61-61: Loop control variable dirs not used within loop body

Rename unused dirs to _dirs

(B007)

🔇 Additional comments (36)

scripts/__mocks__/@pdfme/generator.ts (2)

1-2: Consider using explicit type imports for clarity.
Importing specific types from @pdfme/common is fine. Ensure that Template is the only type needed. If you need more types in the future, consider grouping them in a single import statement.

---

3-9: Descriptive function signature.
The parameter destructuring is clear, and the return type is well-specified as Promise<Uint8Array>. This helps maintain readability and clarity for future maintainers.

scripts/__mocks__/@pdfme/generator.test.ts (6)

1-3: Mock function import is properly structured.
Both the generate function and its Template type are clearly imported, ensuring straightforward references in the test suite.

---

4-11: Validate test for Promise return type.
This test correctly verifies that generate returns a Promise. This is a solid basic check, ensuring that the generate function adheres to its async/promise contract.

---

13-19: Validate resolution type.
This test ensures the returned promise resolves to a Uint8Array. The expectation is accurate and confirms the function’s intended return type.

---

21-28: Confirm error is thrown on empty template.
The test scenario is comprehensive, validating that the function rejects when presented with an empty template.

---

30-37: Check error handling for empty inputs.
Ensuring the function rejects if inputs is empty is a good edge-case test.

---

39-47: Capture error for both template and inputs empty.
This final test scenario solidifies coverage, confirming that a combined empty template and inputs prompt the same error.

.github/workflows/push.yml (1)

36-49: Cache configuration looks good!

The caching strategy is well-implemented with:

• Appropriate cache paths
• Good cache key strategy using package-lock.json hash
• Proper fallback restore-keys

jest-preview.config.ts (1)

1-5: Configuration looks good for resolving MUI imports.

This file correctly sets up a moduleNameMapper for @mui/ paths. Ensure that any further Material-UI modules introduced in the future follow the same mapping convention.

scripts/githooks/check-localstorage-usage.js (1)

10-18: Ignore the "missing return type" error for this JS function.
Static analysis flags a missing return type here, but this is a .js file, and per the project's guidelines, TypeScript type annotations should not be added to JavaScript files. Therefore, you can safely ignore this warning.

🧰 Tools

🪛 eslint

[error] 10-10: Missing return type on function.

(@typescript-eslint/explicit-function-return-type)

.github/workflows/talawa_admin_md_mdx_format_adjuster.py (1)

66-95: Overall, the script is well-structured and sufficiently documented.
It correctly applies MDX escaping in a concise manner and writes changes back only if necessary. The approach is efficient, and the docstrings follow a consistent format.

setup.ts (1)

1-183: Setup script logic appears solid overall.
The approach of prompting the user for values and updating .env accordingly aligns well with user-driven setup. The usage of dotenv.parse and replacements is straightforward and easy to maintain.

.github/workflows/compare_translations.py (1)

91-116: Great approach to flatten nested JSON.
This recursive solution is concise and performant. Good job!

.coderabbit.yaml (1)

1-1: Schema reference is correct.
This aligns well with the recommended schema for CodeRabbit’s YAML integration.

public/manifest.json (2)

13-13: Verify the 16x16 icon is intended.
A 16x16 PNG might look pixelated, especially on devices expecting 192px. Confirm this smaller size meets branding requirements.

---

16-16: Good practice to place icons in a dedicated folder.
This change improves clarity and maintainability for image assets.

.gitignore (4)

3-5: Good call ignoring additional lock files.
This helps avoid confusion when multiple package managers exist.

---

13-14: Ensure coverage artifacts are handled properly.
If you need coverage reports in CI, confirm that ignoring coverage/ and codecov directories won’t hamper uploading coverage data.

---

21-21: Sensibly ignoring environment files.
Prevents accidental commits of sensitive credentials.

---

35-37: Smart to ignore IDE-specific files and swap files.
Reduces noise in version control.

.github/ISSUE_TEMPLATE/feature-request.md (1)

2-6: LGTM! Metadata updates improve consistency.

The capitalization and label changes enhance template consistency and clarity.

.github/pull_request_template.md (1)

Line range hint 1-53: LGTM! Comprehensive improvements to the PR template.

The changes effectively:

• Document the branching strategy
• Emphasize the correct target branch
• Add structured sections for issue tracking and documentation

🧰 Tools

🪛 Markdownlint (0.37.0)

38-38: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

DOCUMENTATION.md (1)

1-32: Documentation structure and content look good

The documentation is well-structured with clear sections and helpful information about documentation locations and Docusaurus usage.

🧰 Tools

🪛 Markdownlint (0.37.0)

25-25: null
Bare URL used

(MD034, no-bare-urls)

🪛 LanguageTool

[grammar] ~25-~25: The modal verb ‘should’ requires the verb’s base form.
Context: ...f docs.talawa.io should automatically launched in your browser at http://localhost:300...

(MD_BASEFORM)

---

[grammar] ~26-~26: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...ttp://localhost:3000/ 1. Add/modify the markdown documents to the docs/ directory of t...

(MARKDOWN_NNP)

---

[uncategorized] ~32-~32: The preposition “to” seems more likely in this position.
Context: ... PLEASE do not add markdown files in this repository. Add them to `talawa-do...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)

.github/workflows/README.md (1)

1-47: Workflow guidelines structure and content look good

The workflow guidelines are well-organized with clear sections covering different types of workflows and script requirements.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~13-~13: Possible missing comma found.
Context: ...ding on the type of workflow. Whenever possible you must ensure that: 1. The file roles...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[duplication] ~24-~24: Possible typo: you repeated a word
Context: ...ors: 1. Place all actions related to to this in the pull-request-target.yml f...

(ENGLISH_WORD_REPEAT_RULE)

---

[uncategorized] ~35-~35: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...orrectly if they have a dedicated file (eg. CodeQL) ## Scripts Follow these gui...

(E_G)

public/locales/zh/common.json (1)

1-98: JSON structure looks good

The localization file follows proper JSON structure with consistent formatting.

public/locales/sp/common.json (1)

1-98: Verify translations with a native Spanish speaker

While most translations appear correct, it would be beneficial to have a native Spanish speaker review the translations to ensure they are contextually accurate and natural.

public/locales/hi/common.json (1)

1-98: LGTM! Well-structured localization file

The Hindi translations are well-organized and properly formatted. The use of placeholders (e.g., {{text}}, {{item}}) is consistent throughout the file.

.github/workflows/pull-request-target.yml (1)

14-14: Verify security implications of pull_request_target

The workflow uses pull_request_target which runs with repository secrets. This is safe as implemented since it doesn't checkout or execute PR code, but we should verify no future modifications compromise this.

✅ Verification successful

Workflow is secure - no risky operations with pull_request_target

The workflow is safely implemented as it:

• Only uses trusted actions (thollander/actions-comment-pull-request and actions/first-interaction)
• Does not checkout PR code or execute any untrusted content
• Only performs read-only operations using repository token
• Uses pull_request_target appropriately for its intended purpose of PR automation

The current implementation follows security best practices for pull_request_target events.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for potential security issues in workflow
# Look for dangerous actions or commands that might execute PR code
rg -l 'uses: actions/checkout@|run: .*\${{ github.event' .github/workflows/pull-request-target.yml

Length of output: 265

---

Script:

#!/bin/bash
# Check for potential security issues in workflow
# Look for dangerous actions or commands that might execute PR code
# Fixed regex by escaping special characters
rg 'uses: actions/checkout@|run:.*\$\{\{ github\.event' .github/workflows/pull-request-target.yml

# Also display the full workflow content to verify all actions
cat .github/workflows/pull-request-target.yml

Length of output: 3741

.eslintrc.json (2)

42-76: Comprehensive TypeScript configuration looks good!

The TypeScript-specific ESLint rules are well-configured and provide strong type safety guarantees. The explicit function return types and naming conventions will help maintain code quality.

---

133-134: Review Jest configuration for Vitest compatibility

Since we're migrating to Vitest, we should verify if the Jest ESLint plugin is still needed or should be replaced with a Vitest equivalent.

PR_GUIDELINES.md (1)

1-69: Well-structured PR guidelines document!

The guidelines are comprehensive, clear, and provide valuable information for contributors. The table of contents and section organization make it easy to navigate.

🧰 Tools

🪛 Markdownlint (0.37.0)

31-31: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

39-39: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🪛 LanguageTool

[uncategorized] ~2-~2: Loose punctuation mark.
Context: # Pull Request Guidelines 👍🎉 First off, thanks for taking t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[style] ~4-~4: Consider a shorter alternative to avoid wordiness.
Context: ...ing the time to contribute! 🎉👍 In order to give everyone a chance to submit a pull...

(IN_ORDER_TO_PREMIUM)

---

[style] ~46-~46: Style-wise, it’s not ideal to insert an adverb (‘manually’) in the middle of an infinitive construction (‘to test’). Try moving the adverb to avoid split infinitives.
Context: ..., you'll need to tell us what steps you followed to manually test your changes. 1. Please read our [CONTRIBUTING.md](C...

(SPLIT_INFINITIVE)

---

[style] ~56-~56: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...o be closed. The quality of our code is very important to us. Therefore we make experienced ma...

(EN_WEAK_ADJECTIVE)

---

[uncategorized] ~56-~56: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...ty of our code is very important to us. Therefore we make experienced maintainers of our ...

(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)

---

[style] ~59-~59: Consider using a different verb for a more formal wording.
Context: ...check if all tests are passing; if not, fix the issues and then create a pull reque...

(FIX_RESOLVE)

---

[style] ~64-~64: This expression is wordy and overused. Consider replacing it with a more concise and formal alternative.
Context: ...wer your questions, but we'll get to it sooner or later. @mentioning someone just adds to the p...

(SOONER_OR_LATER)

---

[uncategorized] ~64-~64: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...adds to the pile of notifications we get and it won't make us look at your issue fas...

(COMMA_COMPOUND_SENTENCE)

---

[style] ~65-~65: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ue faster. 1. Do not force push. If you make changes to your pull request, please simply add a ...

(MAKE_CHANGES)

public/locales/hi/translation.json (1)

1-1483: LGTM! Hindi translations are well-structured and complete.

The translations are comprehensive and follow proper JSON formatting.

public/locales/fr/translation.json (2)

1-1483: LGTM! French translations are well-structured and complete.

The translations are comprehensive and follow proper JSON formatting.

---

1-1: Verify PR description accuracy

The PR description mentions refactoring tests from Jest to Vitest, but the actual changes show:

1. Addition of a new GitHub Actions workflow
2. Addition of Hindi translations
3. Addition of French translations

Please update the PR description to accurately reflect these changes.

CODE_OF_CONDUCT.md (1)

3-20: Well-structured Table of Contents implementation!

The TOC follows markdown best practices and improves document navigation with proper hierarchy and linking.

🧰 Tools

🪛 LanguageTool

[duplication] ~11-~11: Possible typo: you repeated a word
Context: ...-responsibilities) - Scope - Enforcement - Enforcement Guidelines ...

(ENGLISH_WORD_REPEAT_RULE)

[coderabbitai]

💡 Codebase verification

Update actions/stale from v8 to v9 for latest features and security updates

The repository is using actions/stale@v8 while v9.0.0 is now available. Version 8 runs on Node.js 16 which has reached end-of-life. Upgrading to v9 is recommended for:

• Latest security updates
• Performance improvements
• Node.js runtime updates

Update the following line:

• .github/workflows/stale.yml: Change uses: actions/stale@v8 to uses: actions/stale@v9

🔗 Analysis chain

Well-structured stale issue management configuration

The configuration is comprehensive and well-balanced:

• Reasonable timeframes (10 days for stale, 180 days for closing)
• Clear communication messages
• Proper exemptions for WIP and milestones
• Sensible rate limiting (30 operations per run)

However, let's verify the compatibility of the actions/stale@v8 version.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the latest version of actions/stale action
gh api repos/actions/stale/releases/latest --jq .tag_name

# Check the runner versions supported by v8
curl -s https://raw.githubusercontent.com/actions/stale/v8/action.yml | grep -A 5 "runs:"

Length of output: 204

🧰 Tools

🪛 actionlint (1.7.4)

28-28: the runner of "actions/stale@v8" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

[coderabbitai]

💡 Codebase verification

The stale.yml workflow file should be reviewed against the guidelines

The README.md exists and contains clear guidelines for workflow files. According to these guidelines:

• The stale workflow falls under the "File Role Exceptions" category as it requires a unique cron schedule
• This makes it valid to have a dedicated file for the stale workflow

However, I noticed a trailing space in line 7 of stale.yml:

# Please read the README.md file in this directory that defines what should 

🔗 Analysis chain

Verify the referenced README.md file exists

The header comments reference a README.md file that should define the guidelines for this file. Let's verify its existence and content.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the referenced README.md exists in the workflows directory
fd -t f "README.md" .github/workflows/

Length of output: 66

---

Script:

#!/bin/bash
# Let's check the content of the README.md to verify if it contains guidelines
cat .github/workflows/README.md

Length of output: 2105

🧰 Tools

🪛 yamllint (1.35.1)

[error] 6-6: trailing spaces

(trailing-spaces)

[coderabbitai]

🛠️ Refactor suggestion

Consider using LTS version of Node.js

Node.js 22.x is a very recent version and might not be stable enough for production use. Consider using an LTS version like 20.x for better stability.

     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [20.x]

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	matrix:
	node-version: [22.x]
	matrix:
	node-version: [20.x]

[coderabbitai]

💡 Codebase verification

Error handling missing in multiple fs.readFile callbacks

The codebase shows multiple instances where fs.readFile is used with callbacks but without error handling. These instances are found in setup.ts:

• Lines 45-47: Port configuration update
• Lines 174-177: Recaptcha site key update
• Lines 111-117: Recaptcha usage flag update
• Lines near the end: Log errors configuration

All these instances follow the same pattern where the error parameter is ignored, which could lead to runtime errors if file operations fail. The suggested error handling should be applied to all these locations.

🔗 Analysis chain

Include error handling for file read callbacks.
When calling fs.readFile with a callback, handle the err parameter. If err is truthy, accessing or modifying data may cause exceptions. Consider adding conditional checks or try/catch blocks to prevent runtime errors.

 fs.readFile('.env', 'utf8', (err, data) => {
+  if (err) {
+    console.error('Failed to read .env file:', err);
+    return;
+  }
   const result = data.replace(`PORT=${port}`, `PORT=${customPort}`);
   fs.writeFileSync('.env', result, 'utf8');
 });

Also applies to: 111-117, 174-177

---

Let me verify the error handling in the codebase by searching for similar patterns.

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts found

---

Script:

#!/bin/bash
# Search for fs.readFile usage patterns
ast-grep --pattern 'fs.readFile($$$, ($err, $data) => { $$$ })'

# Also search for any other fs.readFile usages that might have different callback patterns
rg "fs\.readFile" -A 5

Length of output: 2939

[coderabbitai]

🛠️ Refactor suggestion

Fix text consistency issues in error messages

There are several consistency and spelling issues in the error messages:

-  "talawaApiUnavailable": "Talawa-API service is unavailable!. Is it running? Check your network connectivity too.",
+  "talawaApiUnavailable": "Talawa-API service is unavailable! Is it running? Check your network connectivity too.",
-  "notAuthorised": "Sorry! you are not Authorised!",
+  "notAuthorised": "Sorry! You are not authorized!",
-  "errorLoading": "Error occured while loading {{entity}} data"
+  "errorLoading": "Error occurred while loading {{entity}} data"

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	{
	"talawaApiUnavailable": "Talawa-API service is unavailable!. Is it running? Check your network connectivity too.",
	"notFound": "Not found",
	"unknownError": "An unknown error occurred. Please try again later. {{msg}}",
	"notAuthorised": "Sorry! you are not Authorised!",
	"errorSendingMail": "Error sending mail",
	"emailNotRegistered": "Email not registered",
	"notFoundMsg": "Oops! The Page you requested was not found!",
	"errorOccurredCouldntCreate": "An error occurred. Couldn't create {{entity}}",
	"errorLoading": "Error occured while loading {{entity}} data"
	}
	{
	"talawaApiUnavailable": "Talawa-API service is unavailable! Is it running? Check your network connectivity too.",
	"notFound": "Not found",
	"unknownError": "An unknown error occurred. Please try again later. {{msg}}",
	"notAuthorised": "Sorry! You are not authorized!",
	"errorSendingMail": "Error sending mail",
	"emailNotRegistered": "Email not registered",
	"notFoundMsg": "Oops! The Page you requested was not found!",
	"errorOccurredCouldntCreate": "An error occurred. Couldn't create {{entity}}",
	"errorLoading": "Error occurred while loading {{entity}} data"
	}

[coderabbitai]

⚠️ Potential issue

Remove duplicate type definition.

The type UserPhone is defined twice with identical fields.

Remove one of the duplicate definitions:

type UserPhone {
  home: PhoneNumber
  mobile: PhoneNumber
  work: PhoneNumber
}

-type UserPhone {
-  home: PhoneNumber
-  mobile: PhoneNumber
-  work: PhoneNumber
-}

Also applies to: 1407-1411

[coderabbitai]

🛠️ Refactor suggestion

Expose or simplify the logic for file path exclusions
The _valid_exclusions function composes a list of file paths to exclude, but it only processes relative paths. Directly ignoring absolute paths might hide potential scenarios where users have a fully specified path. Consider at least warning the user if an absolute path is encountered, or allow the user to explicitly opt in to ignoring absolute paths.

[coderabbitai]

💡 Codebase verification

Based on the analysis of the code and search results, I can now provide a final response:

The _filepaths_in_directories function should include filters for hidden directories

The current implementation of _filepaths_in_directories recursively walks through all directories without any filtering, which means it will include hidden directories like .git, .venv, etc. This could lead to:

• Processing unnecessary files
• Increased execution time
• Potentially inaccurate line counts from build artifacts or version control files

You should add filtering logic to skip hidden directories. Here's how to modify the function:

def _filepaths_in_directories(directories):
    result = []
    for directory in directories:
        for root, dirs, files in os.walk(directory, topdown=True):
            # Skip hidden directories
            dirs[:] = [d for d in dirs if not d.startswith('.')]
            for name in files:
                if not name.startswith('.'):  # Skip hidden files
                    result.append(os.path.join(root, name))
    return result

🔗 Analysis chain

Ensure the _filepaths_in_directories handles multi-level directory structures as intended
Your code recursively captures files in all subdirectories. This is expected, but confirm that you really want to include hidden or nested directories, such as those starting with a dot (e.g., .venv, .git). If not, consider adding filters to skip them.

---

Let me generate additional scripts to check if there are any filters for hidden directories in the codebase.

---

Let me generate one more script to check if there are any existing directory exclusions in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Searching for existing usage or references to hidden directories in the code.
rg -A 2 '\.\w+' 

Length of output: 70657

---

Script:

#!/bin/bash
# Search for any filters or exclusions of hidden directories in the codebase
rg -A 2 "os\.walk.*skip|exclude|ignore|filter.*\.\w+" 

# Search for any configuration files that might contain directory exclusion patterns
fd -t f ".*ignore$|.*config$|.*rc$"

Length of output: 66732

---

Script:

#!/bin/bash
# Search for any directory exclusions in the codebase
rg -A 2 "os\.walk.*exclude|skip|ignore.*directory|\.git|\.venv|node_modules"

# Check if there are any gitignore patterns for hidden directories
cat .gitignore 2>/dev/null || echo "No .gitignore file found"

Length of output: 69426

[coderabbitai]

⚠️ Potential issue

Update Node.js version to latest LTS

The specified Node.js version 22.x is not yet released. Use the latest LTS version (20.x) instead.

- node-version: '22.x'
+ node-version: '20.x'

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	uses: actions/setup-node@v4
	with:
	node-version: '22.x'
	uses: actions/setup-node@v4
	with:
	node-version: '20.x'

[coderabbitai]

⚠️ Potential issue

Fix potential command injection vulnerability

The script is vulnerable to command injection as it uses unquoted variables in shell commands.

- env: 
-   CHANGED_FILES: ${{ steps.changed_files.outputs.all_changed_files }}
- run: npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
+ run: |
+   if [ -n "${{ steps.changed_files.outputs.all_changed_files }}" ]; then
+     npx eslint "${{ steps.changed_files.outputs.all_changed_files }}"
+   fi
+   python .github/workflows/eslint_disable_check.py

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	CHANGED_FILES: ${{ steps.changed_files.outputs.all_changed_files }}
	run: npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
	run: |
	if [ -n "${{ steps.changed_files.outputs.all_changed_files }}" ]; then
	npx eslint "${{ steps.changed_files.outputs.all_changed_files }}"
	fi
	python .github/workflows/eslint_disable_check.py

🧰 Tools

🪛 actionlint (1.7.4)

61-61: property "changed_files" is not defined in object type {changed-files: {conclusion: string; outcome: string; outputs: {string => string}}}

(expression)

---

62-62: shellcheck reported issue in this script: SC2086:info:1:12: Double quote to prevent globbing and word splitting

(shellcheck)