Format fix

[prathmesh703]

What kind of change does this PR introduce?

bug fix

Issue Number:

Fixes #2630

Summary

• changed the run command for Run formatting if check fails

Does this PR introduce a breaking change?

NO

Have you read the contributing guide?

YES

Summary by CodeRabbit

Release Notes

• New Features

  • Introduced a new configuration file for YAML language server settings.
  • Added a template for environment variable configuration.
  • Implemented a script to validate TypeScript files for TSDoc comments.
  • Added multiple localization files for English, French, Hindi, Spanish, and Chinese.
  • Introduced a new GraphQL schema with enhanced types and directives for better API management.
  • Added a setup script for configuring the development environment interactively.

• Bug Fixes

  • Updated error handling and messaging for various scenarios across the application.

• Documentation

  • Enhanced documentation with new files for installation, contribution guidelines, and code style.
  • Updated README to improve clarity and accessibility of project information.

• Chores

  • Updated various configuration files for linting, testing, and dependency management.
  • Removed obsolete files to streamline the project structure.

[coderabbitai]

Walkthrough

The pull request introduces various configuration files and scripts to enhance the Talawa Admin project. Key changes include the addition of .coderabbit.yaml for YAML language server settings, a .env.example for environment variable configuration, and multiple workflow files for GitHub Actions to automate tasks such as linting, testing, and managing pull requests. Additionally, several localization JSON files are added for multiple languages, and various scripts are introduced to facilitate code quality checks and setup processes.

Changes

File Path	Change Summary
.coderabbit.yaml	New configuration file for YAML language server settings and review processes.
.env.example	New template for environment variable configuration, including variables like PORT and API URLs.
.eslintignore	Added entry to exclude src/components/CheckIn/tagTemplate.ts from linting.
.eslintrc.json	Updated to enhance linting rules, added TypeScript-specific rules, and modified existing rules.
.github/ISSUE_TEMPLATE/bug-report.md	Updated metadata fields and added a section for potential internship candidates.
.github/ISSUE_TEMPLATE/feature-request.md	Updated metadata fields and added a section for potential internship candidates.
.github/dependabot.yaml	New configuration for automated dependency updates using Dependabot.
.github/pull_request_template.md	Modified to clarify branching strategy and include additional fields for contributors.
.github/workflows/README.md	New README file outlining guidelines for GitHub workflows.
.github/workflows/auto-label.json5	New configuration for automatic labeling in GitHub workflows.
.github/workflows/check-tsdoc.js	New script to validate TypeScript files for TSDoc comments.
.github/workflows/ci.yml	Deleted CI workflow file.
.github/workflows/codeql-analysis.yml	Deleted CodeQL analysis workflow file.
.github/workflows/codeql-codescan.yml	New workflow for automated CodeQL analysis on pull requests and pushes.
.github/workflows/compare_translations.py	New utility script to compare translation files for missing translations.
.github/workflows/countline.py	New script to count lines of code in specified directories.
.github/workflows/eslint_disable_check.py	New script to check for eslint-disable statements in TypeScript files.
.github/workflows/issue.yml	Modified workflow for issue labeling and greeting users upon issue creation.
.github/workflows/pull-request-target.yml	New workflow for handling pull request interactions.
.github/workflows/pull-request.yml	New workflow for handling pull requests with various checks.
.github/workflows/push.yml	New workflow for testing and code coverage upon code pushes.
.github/workflows/stale.yml	New workflow for managing stale issues and pull requests.
.github/workflows/talawa_admin_md_mdx_format_adjuster.py	New script to adjust Markdown files for MDX compatibility.
.gitignore	Updated to ignore additional files and directories related to package management and environment configs.
.husky/post-merge	New script to check for changes in package.json and run npm install if changes are found.
.husky/pre-commit	New script to format code and run linters on staged files before committing.
.lintstagedrc.json	New configuration for linting and formatting tasks on staged files.
.node-version	New specification for Node.js version 22.7.0.
.prettierignore	Updated to include additional entries for files to ignore during formatting.
.prettierrc	Modified to add "endOfLine": "auto" property.
CODEOWNERS	New file designating @palisadoes as the code owner for the repository.
CODE_OF_CONDUCT.md	Enhanced with a Table of Contents and expanded enforcement guidelines.
CODE_STYLE.md	New document outlining coding standards for the project.
CONTRIBUTING.md	Updated with a Table of Contents and improved structure for clarity.
DOCUMENTATION.md	New document guiding users on the documentation process for the Talawa project.
INSTALLATION.md	New comprehensive installation guide for the Talawa Admin application.
ISSUE_GUIDELINES.md	New document standardizing issue report submissions.
PR_GUIDELINES.md	New document providing guidelines for submitting pull requests.
README.md	Modified to improve organization and accessibility of information.
config/babel.config.cjs	New Babel configuration file for transforming JavaScript, TypeScript, and JSX.
config/vite.config.ts	New Vite configuration file for building the React application.
index.html	New HTML file defining the document structure for the web application.
schema.graphql	Comprehensive updates to the GraphQL schema, adding new types, inputs, and directives.
scripts/__mocks__/@dicebear/collection.ts	New mock function added for testing purposes.
scripts/__mocks__/@dicebear/core.ts	New mock function for simulating avatar creation.
scripts/__mocks__/@pdfme/generator.test.ts	New test suite for the generate function in the @pdfme/generator package.
scripts/__mocks__/@pdfme/generator.ts	New mock function simulating PDF generation.
scripts/__mocks__/fileMock.js	New mock file for file imports during testing.
scripts/custom-test-env.js	New custom testing environment for Jest to set up global variables.
scripts/githooks/check-localstorage-usage.js	New script to check for localStorage usage in JavaScript/TypeScript files.
scripts/githooks/update-toc.js	New script to automatically update the table of contents in Markdown files.
setup.ts	New setup script for configuring the Talawa Admin application.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SetupScript
    participant EnvFile
    participant API

    User->>SetupScript: Run setup
    SetupScript->>EnvFile: Check for .env file
    alt .env file exists
        SetupScript->>EnvFile: Validate contents
    else .env file does not exist
        SetupScript->>EnvFile: Create from .env.example
    end
    SetupScript->>User: Prompt for custom port
    SetupScript->>API: Confirm API endpoint
    SetupScript->>User: Prompt for reCAPTCHA setup
    SetupScript->>User: Prompt for error logging
    SetupScript->>User: Setup complete

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Restore functionality for npm run format (2630)	✅
Verify new command for formatting in workflows (2630)	✅

Possibly related PRs

• coderabbit yaml file #1991: Introduces a new .coderabbit.yaml configuration file for YAML language server settings.
• develop branch - coderabbit yaml file #1997: Adds another .coderabbit.yaml file with similar configuration settings.
• Fixes: Translations Are Not Correctly Tested in Our PR Workflow  #2263: Modifies compare_translations.py script related to review settings in the main PR.
• feat: Workflow changes which will label issues automatically as per #2256 #2390: Introduces automatic labeling based on keywords, relevant to review settings in the main PR.
• Updated pr template with checklist #2454: Updates the pull request template to include a checklist for CodeRabbit AI review.
• Updated pr template for develop-postgress branch #2458: Updates the pull request template for the develop-postgres branch, connecting to review settings.
• fix failing workflow of TS compilation #2472: Addresses workflow issues related to TypeScript compilation, indirectly connecting to review processes.
• reverting workflow changes #2498: Reverts workflow changes related to checks for application startup, relevant to review settings.

Suggested reviewers

• palisadoes
• varshith257
• pranshugupta54
• AVtheking
• gautam-divyanshu

🐰 In the land of code, where changes bloom,
A new .coderabbit.yaml dispels the gloom.
With settings so bright, and scripts that delight,
The Talawa Admin shines, ready for flight!
🐇✨

---

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. (Experiment)
• @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: 54

🧹 Outside diff range and nitpick comments (56)

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

14-20: Consider optimizing workflow triggers

The current configuration runs on all branches which might consume unnecessary GitHub Actions minutes. Consider limiting the workflow to run only on:

• PRs targeting main/develop branches
• Direct pushes to main/develop branches

 on:
   pull_request:
     branches:
-      - '**'  
+      - 'main'
+      - 'develop'
   push:
     branches:
-      - '**'   
+      - 'main'
+      - 'develop'

🧰 Tools

🪛 yamllint (1.35.1)

[error] 17-17: trailing spaces

(trailing-spaces)

---

[error] 20-20: trailing spaces

(trailing-spaces)

config/vite.config.ts (1)

27-28: Fix incorrect comment about default port

The comment states "this sets a default port to 3000" but the actual configuration sets it to 4321.

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

scripts/__mocks__/@dicebear/core.ts (1)

1-5: Consider adding TypeScript types for better type safety

The mock implementation is clean and follows Jest patterns. However, consider adding proper TypeScript types to match the actual @dicebear/core interface for better type safety.

+import type { AvatarOptions } from '@dicebear/core';
+
-export const createAvatar = jest.fn(() => {
+export const createAvatar = jest.fn((options?: AvatarOptions) => {
   return {
     toDataUri: jest.fn(() => 'mocked-data-uri'),
   };
 });

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

4-7: Fix JSDoc tag and improve documentation

The @pdfme tag in the JSDoc comment is undefined. Consider improving the documentation.

 /**
- * A custom environment to set the TextEncoder and TextDecoder variables, that is required by @pdfme during testing.
- * Providing a polyfill to the environment for the same
+ * A custom environment to set the TextEncoder and TextDecoder variables.
+ * These polyfills are required for PDF generation functionality during testing.
+ * @see https://www.npmjs.com/package/@pdfme/generator
  */

🧰 Tools

🪛 eslint

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

(tsdoc/syntax)

---

8-16: Consider converting to TypeScript for better type safety

The file could benefit from TypeScript conversion to ensure type safety and better IDE support. Also, the setup method should explicitly declare its return type.

+import type { JestEnvironmentConfig, EnvironmentContext } from '@jest/environment';
+
-export default class CustomTestEnvironment extends Environment {
+export default class CustomTestEnvironment extends Environment {
+  constructor(config: JestEnvironmentConfig, context: EnvironmentContext) {
+    super(config, context);
+  }
+
-  async setup() {
+  async setup(): Promise<void> {
     await super.setup();
     if (typeof this.global.TextEncoder === 'undefined') {
       this.global.TextEncoder = TextEncoder;
       this.global.TextDecoder = TextDecoder;
     }
   }
 }

🧰 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)

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

10-13: Remove commented console.log statement

Remove the commented debug statement to maintain clean code.

   if (template.schemas.length === 0 || inputs.length === 0) {
-    // console.log('pdf error: length : ', template, inputs, inputs.length);
     throw new Error('Template or inputs cannot be empty.');
   }

---

14-21: Consider enhancing mock PDF structure

While the current implementation is functional, consider adding more realistic PDF structure elements for better testing fidelity.

   // Generate mock PDF-like header bytes
-  const pdfHeader = [0x25, 0x50, 0x44, 0x46]; // %PDF
+  const pdfHeader = [
+    0x25, 0x50, 0x44, 0x46, 0x2D, 0x31, 0x2E, 0x34, // %PDF-1.4
+    0x0A, // EOL
+  ];
+  
+  // Add PDF EOF marker
+  const pdfEOF = [0x0A, 0x25, 0x25, 0x45, 0x4F, 0x46, 0x0A]; // \n%%EOF\n
   
   // Add some random content based on input size
   const contentSize = Math.min(template.schemas.length, inputs.length) * 10;
   const mockContent = Array.from({ length: contentSize }, () =>
     Math.floor(Math.random() * 256),
   );
-  return Promise.resolve(new Uint8Array([...pdfHeader, ...mockContent]));
+  return Promise.resolve(new Uint8Array([...pdfHeader, ...mockContent, ...pdfEOF]));

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

4-4: Consider a more descriptive test suite name.

The current description could be more specific about what aspects of the generate util are being tested (e.g., "Testing PDF generator mock: error handling and return types").

---

5-46: Consider enhancing test coverage and consistency.

1. Test descriptions mix 'should' and 'it should' styles. Consider standardizing the style.
2. Add positive test cases with valid template and inputs.
3. Consider adding more specific test data to better represent real-world scenarios.

Here's a suggested additional test case:

it('should successfully generate PDF with valid template and inputs', async () => {
  const validTemplate = {
    schemas: [
      { name: 'fullName', type: 'text', position: { x: 0, y: 0 } },
      { name: 'email', type: 'text', position: { x: 0, y: 20 } }
    ]
  } as Template;
  const validInputs = [
    { fullName: 'John Doe', email: '[email protected]' }
  ];

  const result = await generate({ template: validTemplate, inputs: validInputs });
  expect(result).toBeInstanceOf(Uint8Array);
  expect(result.length).toBeGreaterThan(0);
});

public/locales/en/errors.json (3)

2-2: Fix punctuation in error message

The error message contains inconsistent punctuation ("!."). Consider using a single punctuation mark.

-  "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.",

---

5-5: Fix capitalization and spelling

"Authorised" should be "Authorized" in American English, and the capitalization is inconsistent.

-  "notAuthorised": "Sorry! you are not Authorised!",
+  "notAuthorised": "Sorry! You are not authorized!",

---

10-10: Fix typo in error message

"occured" should be spelled "occurred".

-  "errorLoading": "Error occured while loading {{entity}} data"
+  "errorLoading": "Error occurred while loading {{entity}} data"

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

164-164: Fix typo in translation string.

There's a typo in the word "enable".

-    "manageFeaturesInfo": "Creation Successful ! Please select features that you want to enale for this organization from the plugin store.",
+    "manageFeaturesInfo": "Creation Successful! Please select features that you want to enable for this organization from the plugin store.",

---

18-18: Validation messages should be externalized.

These validation messages contain specific rules that might need to change. Consider moving these to a configuration file.

Consider creating a separate validation configuration file that can be imported and used to generate these messages dynamically. This would make it easier to maintain and update validation rules across the application.

Also applies to: 19-19, 20-20, 21-21, 22-22, 23-23

.github/workflows/compare_translations.py (1)

1-49: Simplify and standardize the module docstring

The module-level docstring is verbose and contains redundant information. It's recommended to simplify it and follow PEP 257 style conventions.

Consider rewriting the docstring as follows:

 """
-Script to encourage more efficient coding practices.
-Methodology:
-
-    Utility for comparing translations between default and other languages.
-
-    This module defines a function to compare two translations
-    and print any missing keys in the other language's translation.
-Attributes:
-
-    FileTranslation : Named tuple to represent a combination
-                        of file and missing translations.
-
-        Fields:
-            - file (str): The file name.
-            - missing_translations (list): List of missing translations.
-
-Functions:
-    compare_translations(default_translation, other_translation):
-        Compare two translations and print missing keys.
-
-     load_translation(filepath):
-        Load translation from a file.
-
-    check_translations():
-        Load the default translation and compare it with other translations.
-
-     main():
-        The main function to run the script.
-        Parses command-line arguments, checks for the
-        existence of the specified directory, and then
-        calls check_translations with the provided or default directory.
-
-
-Usage:
-    This script can be executed to check and print missing
-    translations in other languages based on the default English translation.
-
-Example:
-    python compare_translations.py
-NOTE:
-    This script complies with our python3 coding and documentation standards
-    and should be used as a reference guide. It complies with:
-
-        1) Pylint
-        2) Pydocstyle
-        3) Pycodestyle
-        4) Flake8
-
+"""
+Utility script for comparing translations between the default language and other languages.
+
+This script identifies missing or extra translation keys by comparing the default English translations
+with translations of other languages.
+
+Functions:
+    - compare_translations(default_translation, other_translation, default_file, other_file)
+    - flatten_json(nested_json, parent_key="")
+    - load_translation(filepath)
+    - check_translations(directory)
+    - main()
+
+Usage:
+    python compare_translations.py
+
+Note:
+    This script adheres to Python 3 coding standards and passes checks from code quality tools
+    like Pylint, Pydocstyle, Pycodestyle, and Flake8.
 """

schema.graphql (1)

759-759: Ensure image field uses correct type

The image field in the Organization type is of type String, but considering it's likely a URL, it might be better to use the URL scalar type for consistency.

Apply this diff to update the field type:

   image: String
+  # Consider changing to:
-  image: String
+  image: URL

.husky/post-merge (1)

4-4: Consider adding error handling for npm install

The script should handle potential npm install failures to prevent leaving the repository in an inconsistent state.

-git diff HEAD^ HEAD --exit-code -- ./package.json || npm install
+git diff HEAD^ HEAD --exit-code -- ./package.json || (npm install || echo "Warning: npm install failed. Please run manually.")

.husky/pre-commit (1)

5-5: Clarify the commented lint:fix command

There's a commented out npm run lint:fix command. Please either remove it or document why it's kept as a comment.

.github/pull_request_template.md (2)

51-51: Update contributing guide link to point to develop branch

Since the PR template emphasizes using the develop branch, the contributing guide link should be consistent.

-**Have you read the [contributing guide](https://github.com/PalisadoesFoundation/talawa-admin/blob/master/CONTRIBUTING.md)?**
+**Have you read the [contributing guide](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/CONTRIBUTING.md)?**

---

28-29: Enhance documentation prompts with specific requirements

The prompts for tests and documentation could be more specific to guide contributors better.

-<!--Yes or No. Note: Add unit tests or automation tests for your code.-->
+<!--
+Yes or No. Please note:
+- All new features must include unit tests
+- Bug fixes should include tests that reproduce the fixed issue
+- Include the test file path and a brief description of the test cases
+-->

-<!--Add link to Talawa-Docs.-->
+<!--
+Yes or No. If yes:
+1. Add the link to the updated documentation
+2. Describe what documentation was updated
+3. If no documentation update was needed, explain why
+-->

Also applies to: 36-37

.github/workflows/stale.yml (2)

6-6: Fix YAML formatting issues

Remove trailing spaces to maintain consistent formatting.

Also applies to: 20-21

🧰 Tools

🪛 yamllint (1.35.1)

[error] 6-6: trailing spaces

(trailing-spaces)

---

31-34: Consider more concise stale messages

The current messages are quite verbose. Consider making them more concise while maintaining clarity.

-        stale-issue-message: 'This issue did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please check if the develop branch has fixed it and report again or close the issue.'
+        stale-issue-message: 'Inactive for 10 days. Will close in 180 days without updates. Please verify if develop branch resolves this.'
-        stale-pr-message: 'This pull request did not get any activity in the past 10 days and will be closed in 180 days if no update occurs. Please verify it has no conflicts with the develop branch and rebase if needed. Mention it now if you need help or give permission to other people to finish your work.'
+        stale-pr-message: 'Inactive for 10 days. Will close in 180 days without updates. Please check for conflicts with develop branch and rebase if needed.'

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

54-58: Optimize file processing

Consider using Promise.all for parallel processing of files to improve performance.

-  for (const file of files) {
-    if (!await containsTsDocComment(file)) {
-      filesWithoutTsDoc.push(file);
-    }
-  }
+  const results = await Promise.all(
+    files.map(async file => ({
+      file,
+      hasTsDoc: await containsTsDocComment(file)
+    }))
+  );
+  filesWithoutTsDoc = results
+    .filter(result => !result.hasTsDoc)
+    .map(result => result.file);

.github/workflows/push.yml (2)

17-17: Fix YAML formatting issues

Remove trailing spaces and extra blank lines to maintain consistent formatting.

Also applies to: 50-50, 62-62

🧰 Tools

🪛 yamllint (1.35.1)

[error] 17-17: trailing spaces

(trailing-spaces)

---

54-54: Consider separating test and coverage commands

Running tests with coverage in a single command might slow down the CI process. Consider splitting them for better control and performance.

-      - run: npm run test -- --watchAll=false --coverage
+      - name: Run tests
+        run: npm run test -- --watchAll=false
+      - name: Generate coverage
+        run: npm run test:coverage

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

3-5: Consider using more specific imports

Instead of importing the entire path module, consider importing only the required basename function for better tree-shaking.

-import path from 'path';
+import { basename } from 'path';

---

43-78: Reduce code duplication in error handling

The error handling pattern is repeated across functions. Consider extracting it into a utility function.

+const handleFileError = (file, error, operation = 'processing') => {
+  console.error(`Error ${operation} file ${file}:`, error.message);
+};

 const checkLocalStorageUsage = (file) => {
   // ... existing code ...
   } catch (error) {
-    console.error(`Error reading file ${file}:`, error.message);
+    handleFileError(file, error, 'reading');
   }
 };

🧰 Tools

🪛 eslint

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

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

---

82-96: Improve error reporting format

The error message could be more structured and provide clearer guidance.

 if (filesWithLocalStorage.length > 0) {
-  console.error('\x1b[31m%s\x1b[0m', '\nError: Found usage of localStorage');
-  console.error('\nFiles with localStorage usage:');
+  console.error('\n❌ Error: Found direct localStorage usage');
+  console.error('\n🔍 Affected files:');
   filesWithLocalStorage.forEach((file) => console.error(file));

   console.info(
     '\x1b[34m%s\x1b[0m',
-    '\nInfo: Consider using custom hook functions.'
+    '\nℹ️ Resolution:'
   );
   console.info(
-    'Please use the getItem, setItem, and removeItem functions provided by the custom hook useLocalStorage.\n'
+    '  - Use getItem, setItem, and removeItem from useLocalStorage hook\n' +
+    '  - See: src/hooks/useLocalStorage.ts for implementation details\n'
   );

🧰 Tools

🪛 eslint

[error] 89-89: Insert ,

(prettier/prettier)

---

[error] 92-92: Insert ,

(prettier/prettier)

.github/workflows/issue.yml (3)

42-48: Simplify label condition check

The current label checking logic using reduce is harder to read. Consider using some for better clarity.

-            if(labels.data.reduce((a, c)=>a||["dependencies"].includes(c.name), false))
+            if(labels.data.some(label => ["dependencies"].includes(label.name)))

---

29-56: Consider potential race conditions in label operations

The current implementation checks labels and then adds new ones in separate operations. This could lead to race conditions if labels are modified between these operations.

Consider using GitHub's GraphQL API to perform these operations atomically, or implement retry logic for better reliability.

🧰 Tools

🪛 actionlint (1.7.4)

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)

---

62-65: Enhance first-time contributor message

The greeting message could be more engaging and provide additional resources.

-          issue-message: "Congratulations on making your first Issue! :confetti_ball: If you haven't already, check out our [Contributing Guidelines](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/CONTRIBUTING.md) and [Issue Reporting Guidelines](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/ISSUE_GUIDELINES.md) to ensure that you are following our guidelines for contributing and making issues."
+          issue-message: |
+            👋 Welcome to the Talawa Admin community! 🎉
+
+            Thank you for creating your first issue! Here are some helpful resources:
+            
+            📘 [Contributing Guidelines](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/CONTRIBUTING.md)
+            📝 [Issue Reporting Guidelines](https://github.com/PalisadoesFoundation/talawa-admin/blob/develop/ISSUE_GUIDELINES.md)
+            
+            Our maintainers will review your issue soon. In the meantime, feel free to explore our documentation and join our community discussions!

.github/workflows/talawa_admin_md_mdx_format_adjuster.py (2)

31-42: Consider performance optimization for large files

The current implementation loads the entire file into memory. For large files, this could be memory-intensive.

Consider processing the file in chunks for better memory efficiency, especially for large files:

def process_file_in_chunks(filepath, chunk_size=8192):
    """Process file in chunks to handle large files efficiently."""
    with open(filepath, 'r', encoding='utf-8') as infile:
        with open(filepath + '.tmp', 'w', encoding='utf-8') as outfile:
            modified = False
            while chunk := infile.read(chunk_size):
                new_chunk = escape_mdx_characters(chunk)
                if new_chunk != chunk:
                    modified = True
                outfile.write(new_chunk)
    if modified:
        os.replace(filepath + '.tmp', filepath)
    else:
        os.remove(filepath + '.tmp')

---

90-93: Add progress reporting for better user experience

For directories with many files, it would be helpful to show progress.

+    total_files = sum(1 for _, _, files in os.walk(args.directory)
+                      for file in files if file.lower().endswith(".md"))
+    processed = 0
     for root, _, files in os.walk(args.directory):
         for file in files:
             if file.lower().endswith(".md"):
+                processed += 1
+                print(f"Processing {processed}/{total_files}: {file}", end='\r')
                 process_file(os.path.join(root, file))
+    print("\nDone!")

.github/workflows/eslint_disable_check.py (2)

29-47: Consider moving the regex pattern to module level

The regex pattern is reused in every function call. Moving it to module level would improve performance.

+# Compile regex pattern once at module level
+ESLINT_DISABLE_PATTERN = re.compile(r'//\s*eslint-disable(?:-next-line|-line)?', re.IGNORECASE)
+
 def has_eslint_disable(file_path):
     """
     Check if a TypeScript file contains eslint-disable statements.
@@ -39,7 +42,6 @@
         bool: True if eslint-disable statement is found, False otherwise.
     """
-    eslint_disable_pattern = re.compile(r'//\s*eslint-disable(?:-next-line|-line)?', re.IGNORECASE)
     
     try:
         with open(file_path, 'r', encoding='utf-8') as file:
             content = file.read()
-            return bool(eslint_disable_pattern.search(content))
+            return bool(ESLINT_DISABLE_PATTERN.search(content))

---

49-75: Fix unused loop variable

The dirs variable in the os.walk loop is unused. Replace it with an underscore to follow Python conventions.

-    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)

PR_GUIDELINES.md (2)

31-34: Add language specifiers to code blocks

Code blocks should specify the language for proper syntax highlighting.

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

- +bash
npm run lint:check
npm run format:check

Also applies to: 39-42

🧰 Tools

🪛 Markdownlint (0.37.0)

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

(MD040, fenced-code-language)

---

56-56: Improve sentence structure

Consider revising the sentence for better clarity:

-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 to us. Therefore, we require experienced maintainers of our code base to 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)

.github/workflows/countline.py (3)

256-264: Optimize file line counting logic.

The current implementation reads the entire file into memory. For large files, this could be memory intensive.

Consider using a more memory-efficient approach:

-            line_count = sum(
-                1
-                for line in code
-                if line.strip()
-                and not (
-                    line.strip().startswith("#")
-                    or line.strip().startswith("/")
-                )
-            )
+            line_count = 0
+            for line in code:
+                stripped = line.strip()
+                if stripped and not (stripped.startswith(("#", "/"))):
+                    line_count += 1

---

69-69: Extract file extension list as a configuration constant.

Move the hardcoded list of invalid extensions to a module-level constant for better maintainability.

+INVALID_FILE_EXTENSIONS = [".css", ".jpg", ".png", ".jpeg"]
+
 def _valid_extension(filepath):
-    invalid_extensions = [".css", ".jpg", ".png", ".jpeg"]
+    invalid_extensions = INVALID_FILE_EXTENSIONS

---

161-161: Consider making the line limit configurable via environment variable.

The default line limit of 300 is hardcoded. Consider allowing it to be configured via environment variable for flexibility.

+DEFAULT_LINE_LIMIT = int(os.getenv("MAX_LINE_COUNT", "300"))
+
 parser.add_argument(
     "--lines",
     type=int,
     required=False,
-    default=300,
+    default=DEFAULT_LINE_LIMIT,
     help="The maximum number of lines of code to accept.",
 )

CODE_STYLE.md (3)

47-70: Consider adding CSS module naming examples.

While the section clearly explains component naming conventions and provides good examples for class usage, it would be helpful to include specific examples of CSS module file naming conventions.

Consider adding examples like:

+Example CSS module naming:
+MyComponent.module.css  ✅
+mycomponent.css        ❌
+my-component.css       ❌

🧰 Tools

🪛 Markdownlint (0.37.0)

57-57: 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)

---

71-115: Consider adding TypeScript types to the React-Bootstrap example.

The example effectively demonstrates React-Bootstrap usage, but adding TypeScript types would better align with the project's tech stack.

Consider updating the example:

 import Dropdown from 'react-bootstrap/Dropdown';
+
+interface BasicExampleProps {
+  // Add any props here
+}
 
-function BasicExample() {
+const BasicExample: React.FC<BasicExampleProps> = () => {
   return (
     <Dropdown>

🧰 Tools

🪛 Markdownlint (0.37.0)

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)

---

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)

---

123-138: Consider adding more common directory descriptions.

The folder structure is well-organized, but consider adding descriptions for other common directories:

• hooks/ - For custom React hooks
• types/ - For TypeScript type definitions
• contexts/ - For React context providers

🧰 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)

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

214-227: Consider enhancing Codecov configuration.

While the basic Codecov setup is good, consider adding:

• Coverage targets per flag
• Informational status checks

Add a codecov.yml file:

coverage:
  status:
    project:
      default:
        target: 95%
        informational: true
    patch:
      default:
        target: 95%
        informational: true

CONTRIBUTING.md (3)

62-62: Fix grammar in Pull Requests section.

The sentence is missing an article.

-Pull Request guidelines](PR_GUIDELINES.md) is best resource to follow
+Pull Request guidelines](PR_GUIDELINES.md) is the best resource to follow

🧰 Tools

🪛 LanguageTool

[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)

---

73-78: Improve clarity in Conflict Resolution section.

The section has several grammatical issues and unclear phrasing.

-Usually these conflicts are resolved in a **First Come First Serve** basis
+Usually, these conflicts are resolved on a **First Come, First Served** basis

-Last but not the least, communication is important make sure
+Most importantly, communication is crucial - make sure

🧰 Tools

🪛 LanguageTool

[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)

---

[uncategorized] ~75-~75: Possible missing comma found.
Context: ... an extension or in conflict with other PRs it is important to ask the author of th...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[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-179: Capitalize "Slack" and fix article usage.

Proper nouns should be capitalized, and articles should be used correctly.

-slack channel
+Slack channel

-in a issue/PR thread
+in an issue/PR thread

🧰 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)

INSTALLATION.md (4)

321-321: Fix heading levels and list indentation

There are some structural inconsistencies in the document:

1. The heading "pre-commit hook" and "post-merge hook" should be h3 (###) instead of h4 (####)
2. The list indentation under the table of contents should be 4 spaces instead of 6 spaces

-      - [pre-commit hook](#pre-commit-hook)
-      - [post-merge hook](#post-merge-hook)
+    - [pre-commit hook](#pre-commit-hook)
+    - [post-merge hook](#post-merge-hook)

Also applies to: 33-34

🧰 Tools

🪛 Markdownlint (0.37.0)

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

(MD001, heading-increment)

---

142-144: Add language specifiers to code blocks

Several code blocks are missing language specifiers, which affects syntax highlighting. Add appropriate language specifiers like bash for shell commands and plaintext for URLs/endpoints.

Example:

-```
+```bash
npm install

Also applies to: 154-156, 164-166, 188-190, 194-196, 200-202, 208-210, 214-216, 220-222, 240-242, 256-258, 264-266, 270-272, 292-294, 300-302, 313-315

🧰 Tools

🪛 Markdownlint (0.37.0)

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

(MD040, fenced-code-language)

---

68-68: Fix technical terminology and grammar

Several technical and grammatical issues need attention:

1. "MacOS" should be "macOS" (Apple's official spelling)
2. "setup" (noun) vs "set up" (verb) usage needs correction in several places

-Open a `cmd` (Windows) or `terminal` (Linux or MacOS) session
+Open a `cmd` (Windows) or `terminal` (Linux or macOS) session

-where you want to setup the repository
+where you want to set up the repository

-commands to setup your node environment
+commands to set up your node environment

Also applies to: 102-102, 119-119, 67-67, 123-123, 228-228, 232-232

🧰 Tools

🪛 LanguageTool

[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)

---

189-190: Standardize URL format in examples

The URL examples should follow a consistent format. Consider using placeholder values consistently.

-REACT_APP_TALAWA_URL="http://API-IP-ADRESS:4000/graphql/"
+REACT_APP_TALAWA_URL="http://<API-IP-ADDRESS>:4000/graphql/"

-REACT_APP_TALAWA_URL="http://localhost:4000/graphql/"
+REACT_APP_TALAWA_URL="http://localhost:4000/graphql/"  # For local development

-REACT_APP_TALAWA_URL="http://YOUR-REMOTE-ADDRESS:4000/graphql/"
+REACT_APP_TALAWA_URL="http://<YOUR-REMOTE-ADDRESS>:4000/graphql/"

Also applies to: 195-196, 201-202

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

35-36: Format URL as proper markdown link

Convert the bare URL to a proper markdown link for better readability and accessibility.

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

🧰 Tools

🪛 Markdownlint (0.37.0)

36-36: null
Bare URL used

(MD034, no-bare-urls)

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

27-28: Format URL as proper markdown link

Convert the bare URL to a proper markdown link for consistency with the bug report template.

-Please read this if you are planning to apply for a Palisadoes Foundation internship 
-- https://github.com/PalisadoesFoundation/talawa/issues/359
+Please read this if you are planning to apply for a Palisadoes Foundation internship:
+[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)

DOCUMENTATION.md (1)

26-27: Consider adding more details about file locations

The instructions could be more specific about where to add documentation files and how to structure them.

Consider adding:

1. The specific path structure within the docs/ directory
2. An example of how to modify sidebars.js
3. Links to example documentation files

🧰 Tools

🪛 LanguageTool

[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)

.github/workflows/README.md (2)

41-47: Enhance the Python coding standards section

The Python coding standards section could be more detailed and helpful.

Consider adding:

1. Minimum version requirements for Python 3
2. Links to each tool's documentation
3. Example commands for running these tools
4. Configuration file requirements (e.g., setup.cfg, .pylintrc)

---

13-13: Add missing comma for better readability

Add a comma after "Whenever possible" for better sentence structure.

-Whenever possible you must ensure that:
+Whenever possible, you must ensure that:

🧰 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)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0630cff and aaab8a2.

⛔ 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
• Docker_Container/.dockerignore
• issue-guidelines.md
• .github/workflows/ci.yml
• Docker_Container/README.md
• Docker_Container/dockerfile
• .github/workflows/linter.yml
• .github/workflows/codeql-analysis.yml
• public/index.html
• PULL_REQUEST_TEMPLATE.md
• .github/workflows/npm-publish.yml
• PR-guidelines.md
• Docker_Container/docker-compose.yml

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

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

🧰 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.

🪛 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/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)

.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)

🪛 LanguageTool

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)

---

[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)

---

[uncategorized] ~32-~32: Possible missing preposition found.
Context: ...lawa-admin/issues/new/choose) button 1. Use the templates to create a standardized ...

(AI_HYDRA_LEO_MISSING_TO)

---

[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)

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)

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)

---

[uncategorized] ~75-~75: Possible missing comma found.
Context: ... an extension or in conflict with other PRs it is important to ask the author of th...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[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)

---

[uncategorized] ~163-~163: Possible missing comma found.
Context: ...odecov/results.jpg)]() 1. After making changes you can add them to git locally using `...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[uncategorized] ~164-~164: Possible missing comma found.
Context: ...o add all changes). 1. After adding the changes you need to commit them using `git comm...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[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)

---

[uncategorized] ~167-~167: Possible missing comma found.
Context: ...test suite passes, either locally or on CI once a PR has been created. 1. Review a...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[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)

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)

---

[uncategorized] ~61-~61: Possible missing comma found.
Context: ...` knowledge is required for open source contribution so make sure you're comfortable with it...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[uncategorized] ~64-~64: Possible missing comma found.
Context: ...ithub. ## Setting up this repository First you need a local copy of talawa-admin`...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[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] ~130-~130: Possible missing comma found.
Context: ...stall TypeScript, you can use the npm command which comes with node.js: ```bash np...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[uncategorized] ~158-~158: Possible missing comma found.
Context: ...ions in "setup" can be done manually as well and here's how to do it. - [Creating .e...

(AI_HYDRA_LEO_MISSING_COMMA)

---

[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)

---

[uncategorized] ~224-~224: Possible missing preposition found.
Context: ... For additional details, please refer theHow to Access the Talawa-API URL` sect...

(AI_HYDRA_LEO_MISSING_TO)

---

[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)

---

[uncategorized] ~278-~278: Possible missing comma found.
Context: ... navigate to the running talawa-admin's website you'll land at talawa-admin registratio...

(AI_HYDRA_LEO_MISSING_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_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)

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)

CODE_OF_CONDUCT.md

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

(ENGLISH_WORD_REPEAT_RULE)

.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)

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)

🪛 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/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)

.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)

🪛 Markdownlint (0.37.0)

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)

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)

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)

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)

README.md

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

(MD019, no-multiple-space-atx)

.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)

.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)

DOCUMENTATION.md

25-25: null
Bare URL used

(MD034, no-bare-urls)

🪛 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 (13)

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

21-30: LGTM! Well-configured job setup

The job configuration is well structured with:

• Appropriate Dependabot exclusion
• Fail-fast disabled for independent language analysis
• Clear matrix strategy for JavaScript

config/vite.config.ts (1)

1-5: Verify dependency versions for compatibility

The imports look correct, but we should ensure that all these Vite plugins are using compatible versions.

✅ Verification successful

All Vite plugin dependencies are compatible with the current setup

The dependency versions are all compatible with Vite 5.x:

• vite: ^5.4.8
• @vitejs/plugin-react: ^4.3.2 (supports Vite 5)
• vite-tsconfig-paths: ^5.1.2 (major version aligned with Vite)
• vite-plugin-svgr: ^4.2.0 (supports Vite 5)
• vite-plugin-environment: ^1.1.3 (compatible with Vite 5)

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check package.json for dependency versions and compatibility

# Find and display package.json content
fd -t f "package.json" -x cat {} \; | jq '.dependencies + .devDependencies | with_entries(select(.key | test("vite|@vitejs")))'

Length of output: 295

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

1-3: LGTM! Clean and well-structured imports.

The imports are properly organized, with clear separation between local mock and external type imports.

---

1-47: Verify mock implementation exists and matches test expectations.

Ensure that the corresponding mock implementation in ./generator.ts properly implements all the tested behaviors.

✅ Verification successful

Mock implementation matches test expectations

The mock implementation in scripts/__mocks__/@pdfme/generator.ts correctly implements all the tested behaviors:

• Returns a Promise (implicit in async function)
• Returns Uint8Array type (function signature)
• Throws 'Template or inputs cannot be empty.' error when template schemas or inputs are empty

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the mock implementation exists and contains expected functionality
echo "Checking for mock implementation..."
rg -l "export.*generate.*=.*function" scripts/__mocks__/@pdfme/generator.ts || echo "Mock implementation not found"

# Verify the implementation matches test expectations
echo "Checking implementation details..."
rg -A 10 "export.*generate" scripts/__mocks__/@pdfme/generator.ts

Length of output: 724

.husky/post-merge (1)

1-4: LGTM: Script setup looks correct

The shebang and husky source setup follow best practices.

.lintstagedrc.json (1)

2-4: Verify the existence and functionality of the custom script

The configuration references a custom script for checking localStorage usage.

✅ Verification successful

Let me verify the content of the script to ensure it's properly implemented.

---

Custom localStorage check script is properly implemented and functional

The script exists, is executable, and implements a thorough check for direct localStorage usage. It:

• Scans TypeScript/TSX files for direct localStorage API calls
• Provides skip mechanisms via comments
• Suggests using a custom hook alternative
• Has proper error handling and reporting

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the custom script exists and is executable
if [ -f "scripts/githooks/check-localstorage-usage.js" ]; then
    echo "Script exists"
    # Check if script is executable
    if [ -x "scripts/githooks/check-localstorage-usage.js" ]; then
        echo "Script is executable"
    else
        echo "Warning: Script is not executable"
    fi
else
    echo "Warning: Script not found"
fi

Length of output: 203

---

Script:

#!/bin/bash
# Check the content of the script
cat scripts/githooks/check-localstorage-usage.js

Length of output: 2515

.husky/pre-commit (1)

4-9: Verify the existence of all npm scripts

The pre-commit hook relies on several npm scripts. Let's verify they are properly defined.

✅ Verification successful

All required npm scripts are properly defined in package.json

All the npm scripts referenced in the pre-commit hook (format:fix, lint-staged, typecheck, and update:toc) are found in the package.json file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if all required npm scripts are defined in package.json
scripts=("format:fix" "lint-staged" "typecheck" "update:toc")

for script in "${scripts[@]}"; do
    if grep -q "\"$script\":" package.json; then
        echo "Found script: $script"
    else
        echo "Warning: Missing script: $script"
    fi
done

Length of output: 583

.github/workflows/eslint_disable_check.py (2)

1-28: LGTM! Well-documented script header

The script header is well-structured with clear documentation of methodology and compliance standards.

---

76-122: LGTM! Well-structured main function

The argument parsing and main function implementation are well-structured with proper error handling.

.eslintrc.json (1)

133-134: Consider the implications of disabling jest/expect-expect

Disabling jest/expect-expect might lead to test files that don't actually assert anything. Consider keeping this rule enabled with allowances for specific cases.

CODE_OF_CONDUCT.md (1)

3-19: LGTM! Table of Contents enhances document navigation.

The addition of a well-structured table of contents with anchor links improves the document's accessibility and navigation.

🧰 Tools

🪛 LanguageTool

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

(ENGLISH_WORD_REPEAT_RULE)

package.json (1)

73-89: LGTM! Enhanced development workflow scripts.

The new scripts improve the development workflow by adding:

• Type checking
• Linting
• Formatting
• Documentation checks

CODE_STYLE.md (1)

1-38: LGTM! Clear and well-structured introduction and tech stack sections.

The introduction effectively explains the purpose of the document and the tech stack section clearly lists all key technologies used in the project.

[Cioppolo14]

@prathmesh703 Something doesn't seem right, there are 1000 changed files. I am going to close this PR. Please resubmit when ready.

[palisadoes]

This PR has too many submitted files.

Please ensure the following:

1. Fetch the latest upstream/develop-postgres files
2. Make your PR modifications based on the local copy of this develop-postgres branch
3. Submit your PRs against our develop-postgres branch.
4. Your source branch in your local repository must not be the same as the target branch

Closing

[prathmesh703]

Sure , i will follow the steps