Configure lint and prettier (#1)

fernandoobarbosa · web-flow · commit 5bc681c7a223 · 2025-10-11T18:59:09.000-03:00
* chore: update devDependencies and add linting scripts

- Added @eslint/js and eslint for code linting.
- Added prettier for code formatting.
- Updated scripts to include linting and formatting commands.

* style: format markdown and YAML files for consistency
diff --git a/.github/Contributor_Guide/Contributing.md b/.github/Contributor_Guide/Contributing.md
@@ -1,6 +1,6 @@
 # Contribute to <Project_Name>
 
-Thank you for taking the time to contribute to <project_name>! We really appreciate it. 
+Thank you for taking the time to contribute to <project_name>! We really appreciate it.
 
 Before contributing, please make sure to read the [Code of Conduct](../../CODE_OF_CONDUCT.md). We expect you to follow it in all your interactions with the project.
 
@@ -29,9 +29,7 @@ If you want to suggest an enhancement to <Project_Name>, please [submit an issue
 If you want to contribute to <Project_Name>, submit a pull request.
 
 - url: `https://github.com/OPCODE-Open-Spring-Fest/<project_Name>/compare/branch...YOURGITHUBUSERNAME:<project_Name>:BRANCH?quick_pull=1&template=pr.md`
-  
-### Requirements
 
+### Requirements
 
 ### Setup
-
diff --git a/.github/Contributor_Guide/Project_Tour.md b/.github/Contributor_Guide/Project_Tour.md
@@ -1,12 +1,12 @@
 # Project Tour
 
-* notes:
-*  > Discuss about your project file structure
-*  > what each folder is responsible
-*  > then go through each file in folders and explain there purpose
-*  > if possible create a doc system ( there are autogen docs available for most of the languages )
-*  > decide coding style , linting style and formatting style and other themes like variable naming etc.
-*  > provide an example for existing function and tests system if possible 
-*  
+- notes:
+- > Discuss about your project file structure
+- > what each folder is responsible
+- > then go through each file in folders and explain there purpose
+- > if possible create a doc system ( there are autogen docs available for most of the languages )
+- > decide coding style , linting style and formatting style and other themes like variable naming etc.
+- > provide an example for existing function and tests system if possible
+-
 
-# MAKE SURE PROJECT MANAGERS UPDATE THIS MD 
+# MAKE SURE PROJECT MANAGERS UPDATE THIS MD
diff --git a/.github/Contributor_Guide/commiting.md b/.github/Contributor_Guide/commiting.md
@@ -7,15 +7,13 @@
 ### Writing Commit Messages
 
 - **Clear Subject Line**: Start the commit message with a clear and concise description of the change. It should be no more than 50 characters, start with a capital letter, and be in imperative mood.
-
   - > ```bash
     > feat: Add function to calculate average
     > ```
 
 - **Separate Subject from Body**: If further explanation is needed, include it in the body of the commit message, following a blank line after the subject line.
 
 - **Explain the Change**: The body of the commit message should explain why the change was needed and how it was implemented. Keep it wrapped to 72 characters and written in present tense.
-
   - > ```bash
     > fix: Resolve issue with login form not submitting on Safari
     >
@@ -25,7 +23,6 @@
 - **Avoid "How" Details**: Use the commit message to explain what changes were made and why, not how they were made. Well-written code should be self-explanatory.
 
 - **Reference Issues or Pull Requests**: If the commit is related to an issue or a pull request, include the reference in the commit message. This can be done in the body of the message or at the end.
-
   - > ```bash
     > feat: Add user authentication feature
     >
@@ -37,7 +34,6 @@
 ### Commit Message Structure Rules
 
 - **Type Enum**: Ensure your commit type matches one of the predefined values: `build`, `chore`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `revert`, `style`, `test`.
-
   - `build`: This type is used for changes related to build processes or tools. It includes modifications to build scripts, configuration files, and build-related dependencies.
 
   - `chore`: Chore changes typically involve tasks related to maintenance or housekeeping. This could include updating dependencies, cleaning up code, or configuring development tools.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -1,7 +1,7 @@
 name: Bug Report
 description: File a bug report
-title: "[Bug]: "
-labels: ["Issue:bug"]
+title: '[Bug]: '
+labels: ['Issue:bug']
 assignees:
   - <project_manager>
 body:
@@ -15,7 +15,7 @@ body:
       label: Description
       description: Also tell us, what did you expect to happen?
       placeholder: Tell us what you see!
-      value: "Describe the issue happened"
+      value: 'Describe the issue happened'
     validations:
       required: true
   - type: textarea
@@ -42,7 +42,7 @@ body:
       label: Steps to reproduce
       description: Please provide detailed steps for reproducing the issue.
       placeholder: Tell us how to reproduce the issue
-      value: "1. 2. 3."
+      value: '1. 2. 3.'
     validations:
       required: true
   - type: textarea
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -1,16 +1,15 @@
-name: Feature Request 
+name: Feature Request
 description: Request a feature or suggest us what is in your mind!
-title: "[Feature]: "
-labels: "Issue:feature"
+title: '[Feature]: '
+labels: 'Issue:feature'
 assignees:
-  - <project manager> 
+  - <project manager>
 body:
   - type: markdown
     attributes:
       value: |
         Please explain what is in your mind, we would like to hear it from you! 🤠
-      
-      
+
   - type: textarea
     id: explaining
     attributes:
@@ -19,12 +18,12 @@ body:
       placeholder: It's about...
     validations:
       required: true
-      
+
   - type: checkboxes
     id: terms
     attributes:
       label: Code of Conduct
       description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/OPCODE-Open-Spring-Fest/template/blob/main/.github/Contributor_Guide/CODE_OF_CONDUCT.md)
       options:
-        - label: I agree to follow this project's Code of Conduct 
+        - label: I agree to follow this project's Code of Conduct
           required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE/pr.md b/.github/PULL_REQUEST_TEMPLATE/pr.md
@@ -1,4 +1,3 @@
-
 ## Description
 
 > Give a brief description of the pull request.
@@ -16,4 +15,3 @@
 ## Checklist
 
 - [ ] I have read the [Contributing Guidelines](../Contributor_Guide/Contruting.md).
-
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,4 +1,3 @@
-
 ## Description
 
 > Give a brief description of the pull request.
@@ -16,4 +15,3 @@
 ## Checklist
 
 - [ ] I have read the [Contributing Guidelines](../Contributor_Guide/Contruting.md).
-
diff --git a/.github/workflows/checklabels.yaml b/.github/workflows/checklabels.yaml
@@ -18,4 +18,4 @@ jobs:
       - name: Run Label Checker
         run: node .github/workflows/label-checker.js
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/label-checker.js b/.github/workflows/label-checker.js
@@ -17,16 +17,16 @@ async function run() {
       issue_number: pullNumber,
     });
 
-    const labelNames = labels.map((label) => label.name);
+    const labelNames = labels.map(label => label.name);
 
     const requiredLabels = [
       ['Type:Easy', 'Type:Medium', 'Type:Hard'],
       ['Semver:major', 'Semver:minor', 'Semver:patch'],
       ['PR:Accept'],
     ];
 
-    const hasRequiredLabels = requiredLabels.every((labelGroup) =>
-      labelGroup.some((label) => labelNames.includes(label))
+    const hasRequiredLabels = requiredLabels.every(labelGroup =>
+      labelGroup.some(label => labelNames.includes(label))
     );
 
     if (!hasRequiredLabels) {
@@ -39,4 +39,4 @@ async function run() {
   }
 }
 
-run();
+run();
diff --git a/.github/workflows/prmerged.yaml b/.github/workflows/prmerged.yaml
@@ -5,7 +5,6 @@ on:
     types: [closed]
 
 jobs:
-
   on-merge:
     runs-on: ubuntu-latest
     if: ${{ github.event.pull_request.merged == true }}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,7 @@
+node_modules
+dist
+build
+.git
+*.log
+package-lock.json
+.husky
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,11 @@
+{
+  "semi": true,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "endOfLine": "lf"
+}
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
   overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
   advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
   address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within
diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
 # RBAC (Role Based Access Control)
+
 Repository for OpenSpringFest (OSF)
 
 # 🔐 RBAC Authentication System
 
 A secure and extendable **Role-Based Access Control (RBAC)** authentication system built with **Node.js, Express, and MongoDB**.  
-This project is developed and maintained under **Opcode, IIIT Bhagalpur** 🚀.  
+This project is developed and maintained under **Opcode, IIIT Bhagalpur** 🚀.
 
 ---
 
@@ -39,33 +40,41 @@ rbac-auth/
 └── README.md
 ```
 
-
 ---
 
 ## 🚀 Getting Started
 
 ### 1️⃣ Clone the Repository
+
 ```bash
 git clone https://github.com/<your-org>/rbac-auth.git
 cd rbac-auth
 ```
+
 ### 2️⃣ Install Dependencies
+
 ```
 npm install
 ```
+
 ### 3️⃣ Setup Environment
+
 ```
 PORT=5000
 MONGO_URI=mongodb://localhost:27017/rbac
 JWT_SECRET=your-secret-key
 ```
+
 ### 4️⃣ Run the Project
+
 ```
 npm run dev
 ```
+
 ---
 
 ### 🔄 System Flows
+
 🔑 Authentication Flow
 
 User signs up → password hashed → stored in DB
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -1 +1 @@
-export default {extends: ['@commitlint/config-conventional']};
+export default { extends: ['@commitlint/config-conventional'] };
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,33 @@
+import js from '@eslint/js';
+
+export default [
+  js.configs.recommended,
+  {
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'module',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        global: 'readonly',
+        module: 'readonly',
+        require: 'readonly',
+        exports: 'readonly',
+      },
+    },
+    rules: {
+      indent: ['error', 2],
+      quotes: ['error', 'single'],
+      semi: ['error', 'always'],
+      'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      'no-console': 'warn',
+      'prefer-const': 'error',
+      'no-var': 'error',
+      'object-shorthand': 'error',
+      'prefer-arrow-callback': 'error',
+    },
+  },
+];
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
