Skip to content

Implement Code Quality Tooling with ESLint, Prettier, and Vitest #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Jockstrap6334 wants to merge 8 commits into
base: da87f529-c2de-4d3d-ad55-c33a5604e384
Choose a base branch
from
Open

Implement Code Quality Tooling with ESLint, Prettier, and Vitest #2

Jockstrap6334 wants to merge 8 commits into from

Conversation

@Jockstrap6334
Copy link

@Jockstrap6334 Jockstrap6334 commented May 24, 2025 •
edited
Loading

Implement Code Quality Tooling with ESLint, Prettier, and Vitest

Description

Task

Set Up ESLint and Code Quality Tools

Acceptance Criteria

  • Install ESLint as a dev dependency
  • Create .eslintrc.json with recommended rules
  • Add lint script to package.json
  • Configure IDE integration for ESLint
  • Lint check passes with zero errors

Summary of Work

Overview

This pull request sets up a robust code quality infrastructure for the project, implementing comprehensive linting, formatting, and testing tools.

🛠 Key Components Implemented

  1. ESLint Configuration

    • Configured .eslintrc.json with TypeScript support
    • Added recommended ESLint and TypeScript-specific rules
    • Integrated with Prettier to prevent formatting conflicts
    • Rules include:
      • Error on unused variables
      • Warnings for console logs
      • Complexity limits
      • Explicit function return types

  2. Prettier Integration

    • Created .prettierrc with consistent formatting rules
    • Configured for:
      • Single quotes
      • Trailing commas
      • 100 character line width
      • Consistent indentation

  3. Pre-Commit Hooks

    • Implemented Husky pre-commit hook
    • Automatically runs linting and formatting before each commit
    • Prevents committing code that doesn't meet quality standards

  4. Testing Infrastructure

    • Integrated Vitest as the test runner
    • Added sample utility function and test in src/utils.ts and src/utils.test.ts
    • Configured npm scripts for running tests

📋 NPM Scripts Added

  • lint: Check code quality
  • lint:fix: Automatically fix linting issues
  • format: Format code
  • format:check: Verify formatting
  • test: Run test suite
  • test:watch: Run tests in watch mode

🧪 Testing Approach

  • Created a sample utility function with comprehensive tests
  • Verified test runner configuration
  • Ensured all initial tests pass

✅ Acceptance Criteria Met

  • Implemented ESLint with TypeScript support
  • Added code formatting with Prettier
  • Configured pre-commit hooks
  • Set up test infrastructure
  • Provided clear, extensible configuration

🚨 Important Notes

  • Developers should install Husky hooks using `npm run prepare`
  • IDE integrations may require additional ESLint/Prettier plugin configuration

Next Steps

  • Expand test coverage
  • Potentially add more specific ESLint rules as project evolves
  • Consider adding type checking strictness

Test Results

✅ All initial tests passed successfully

  • Framework: Vitest
  • Tests Run: 1
  • Tests Passed: 1

Changes Made

  • Added ESLint configuration
  • Integrated Prettier
  • Created Husky pre-commit hook
  • Added Vitest test runner
  • Configured npm scripts for linting and testing
  • Created sample utility function and test

Tests

  • Verify ESLint configuration
  • Check Prettier formatting rules
  • Validate pre-commit hook functionality
  • Run initial utility function test

Signatures

Staking Key

DWBqahm2PaMoi28xYhwk66LkLYbZw7Df7AKb5hKRrBf: 5vRuJUuttYEuTzNo1VAgKQcNa4Ffeqf3wPpE2vBxVvvcYqsuEESzYbd9Crqm9jgHGktB5w4BgST3kPpTSmuLq4JBUZdZuwPTMWh9isKw5FqTfyhvMcg4EaFx3Ft5T9kXcri8W76y2tsd8ky8uaMZAaiRASJZTi2QTXRhdae3HYca7mSr3erymQbYBQfLsmF4ckpzqJqJnZYBbAQiGWRqvh4i6663VHooqZ2ibsHS7aCHJVrDcKmoKTg9zrgJfzUseY46v6TU2mXLUZHySxcVCqWRy7Tni7izRoQkkBRv56xj3UJzfTH6zaydwi9F1bns25EgaTakQCYMca41DtagwhYxWScqrNBSB5LLs7VV4ydqRTd853V9ugwPLWhnneeZYqzUwGUgYAFdQcsnc5iA1aJDZgLdVvNag4k1i

Public Key

2zjmVMjbiRMA7LSoefNKBMkhZyoK7hVpVz3xJU7m2NxW: 82n8fB5UJ49ouaz2dja4w1fuhCQbAcYrbkup7zQFSteuu1YmGF8fQo4VFBEK3etCrqvXYmhm1uiQ2568Zx8vRPG457AgXXLG6wDNEVJYcvHNMBoUYohLMyvWiz8FD9UwTSrsMTyaDn2kcfvpAk3KNtk5wGqFHK2PxHJ8xCN37GRahqHE3TpFGskRabG1HmyX8MWbzwAr7c8xh1yuHEjuyVZtVV8EvkLF7oXQa5U5t5t4ALvLQfipDedxQWAG22Rq8bLnmQYX8SJ3bGzajfKgpivq4r31ZBq6cjxTaAwkgijEPUgp8V8ocsTfe7UzDmfdY2TNkHMoPrGnfh96z2STmrsguDABBigxJ8jDMBaqCoD6yLuzW2RcoaX1VMv44vHUjtPUw2Qown6PTZ5Dy56XPjkcgayrxLPozo1m6

@Jockstrap6334 Jockstrap6334 changed the title [WIP] Setup ESLint and Code Quality Tooling Implement Code Quality Tooling with ESLint, Prettier, and Vitest May 24, 2025
@Jockstrap6334 Jockstrap6334 marked this pull request as ready for review May 24, 2025 07:16
@usaflees9
Copy link

usaflees9 commented May 24, 2025

Simple Utility Function Implementation

Description

Implementation of a basic sum function with accompanying unit tests

Recommendation

APPROVE

Reasons:

  • Implementation matches simple sum function requirements
  • Tests cover multiple input scenarios including zero and negative numbers
  • Code is located in the correct src directory
  • Tests are located in the correct src directory

Unmet Requirements

All requirements met

Tests

Failed Tests

No failing tests

Missing Test Cases

No missing test cases identified

Action Items

No action items required

Signatures

Staking Key

3cyGArGdrXQJ5vXXQ9UrTNoAgGu1tGMt3RNK3kHG3doP: rPVZwb9uJkLH3wvhipKaQGeVMSBXXUMwqx54FtfZvuzRBdC1vHWV9Pu6ux8Cw7xErr4kCswxkWRpB4tbTnXH6R75dxcBLqXCVY3VBTwCpoTuHopB4vzuhZdj2BhMDnsrDajvAyXwVp3bvB4JLVSs9WuYuqJGasYbmJAf4Nep2u3oTb4FxP8GyHBVm11GkjRhJ4ptnmnxKbb9MbAHatkLJu9hin13YJduRAeGXKNvYwKGCUdWLMm9qLX1TNhBiMQpKBHS1e9D1mC4JFZJQc

Public Key

9r4WshjZ7fueoiXxRrFvd54QGiu2pTmy2jQMFh44Kzo8: 3hH7FvwbkZNFgSuxXpWYm9MxFn3qRsyGhYfFCqMhqtbTVFcnguYbxkYy36rXuWW3YCaXcQUg4R9E4NFfFb5Aqxj9L6pTxC21Vb8SSpHX6YXLHeoBrxVKLANDMmCDdYncrbbemALrYhyn3URJcW8RWRLdiQBLvZNiWqSEz33gyFi2sQMJ8QDyPxWgKchGnnktvyXrurNG8ytXrjP4igBPepjk4GU74FyJzviRqM7iab5kJtAKA4dJcxTPg7A5To8MM1MsyA3P2PMXq521Xjr

@gapcomputer
Copy link
Owner

gapcomputer commented May 24, 2025

Simple Sum Utility Function Implementation

Description

Implementation of a basic sum utility function with corresponding unit tests.

Recommendation

APPROVE

Reasons:

  • Meets all specified requirements
  • Implemented in src/utils.ts
  • Tests implemented in src/utils.test.ts
  • All tests pass successfully
  • Simple and clean implementation

Unmet Requirements

All requirements met

Tests

Failed Tests

No failing tests

Missing Test Cases

No missing test cases identified

Action Items

  • Consider adding more edge case tests
  • Potentially add type safety for input validation

Signatures

Staking Key

EKjJikFMaWp6Kx3JPi6PRNqANutX8LCAsQnCd2UCu621: 4nhK2txnXcsBdjGRLaBh1aJTG71xDG82pUDmjFurBbAyrSEJZXq6MajVpzXMcj4t9WQsqKXK32pdcF5jm6o2ZFvpnVxTi7kecDRExgPmPgLuMu95rPrXa3iqndGUAqNHvukg5Mf9EshNdVLUkQQ5KBeufL6LcpfVbePT9RrWzoQHZmzqF6tDxPZmzRhdCnAXYBZ19PXGoovKUXSU21kWUVH7aYb21uQ61h3FCT3WWqAVLgSH3UoQ3XN68xrf1hxr9ir8QGRtSMdK1ufSHeL

Public Key

CXaf1KgZ3emsz9DoERxggja4xrtNYvWn8CDHzcybTqqc: 6cRR7vcAXAQAqsVuLG3VLrDM4VsK9wJji2szdrYKqPNJneKMJrc1o4cKxto3GQh9FBo24W16r7q6PZPCy18jgutuYBNiW51MntpezXYyPSdKSTR9hkV1nVX1dRzrLxDmhjPvBSsPxRR3JNxBpnyzEX1M5x8KPCRD76hXquzQ6xPNetj3izfW6Y2kxh1AircntWmi8fiU4VJzhBBKbxEMVin6UKWqiNmSa93csaBH6jWEiGZQGgaqGzNsRHCZPRcHhS8N92UY9pLFL2BsgF6

@ranjhayhero
Copy link

ranjhayhero commented May 24, 2025

Simple Sum Utility Function

Description

Implements a basic sum utility function with corresponding unit tests

Recommendation

APPROVE

Reasons:

  • Implementation matches problem description
  • Unit tests pass successfully
  • Code is in the correct src/ directory
  • Tests are in the correct location

Unmet Requirements

All requirements met

Tests

Failed Tests

No failing tests

Missing Test Cases

No missing test cases identified

Action Items

No action items required

Signatures

Staking Key

HUjFCWMEK2VxfsrCpayemKNcsvvevebHnM8xDRqPH6os: 6oc5FmZMVb2KvMs1JuxNDV7DT5oCcyBaqp7a227XQBtmJxBEuXuvQzfozFjUuCShSfm1wbHqK4H5oaj6QDyrC1Vz4mnhj5FDRsuAtuKz2nPinDEKvBaE3Vm5S1iB4Ci1YJ6TfMcuii6K5DkUXdz1EMXR6BSkxceBhhDBtwdCSabLYkTZVXeH1o8QJmZsyfMkcbsfdSaWZaUw82LrZKNx2fRgBMYFUtx13dShtxUx3NWtXNN1jK1Eu1XTsoNjqbWBUUDUvwxHaf3DkBpYstY

Public Key

21bw5w1jncJHRHNs2CwqSGC2JRdMVFPHx9F1nyMLQ61C: 73mo9RPuucV2UvRjjaXanHyAuedTTc3wzmfar1zE2UqnUd12fXbxMwP26pzLkEncrWbvoAD7JDjbFgeeJ4JrSsG15ipTGv9a1BSxenzjf5F522eZkYM1atNZZ4xEpMFTjemgu9Fd2kBo2kQkjEfRR3TSw4hiykuZvkRQcy5snddo2UZvcqWwH99pwfkSecUcQr7cbs89U6FjEZuGKAKp3xQQGCv1yrM4s3fToZaxu5iqJVDtK5gXvCTMpymi3HwXK2BG3syFiYABmV2Z9pg

@Vuk7912
Copy link

Vuk7912 commented May 24, 2025

Simple Utility Function Implementation

Description

Implemented a basic sum utility function with corresponding unit tests

Recommendation

APPROVE

Reasons:

  • Implementation meets all specified requirements
  • Tests cover basic functionality with multiple scenarios
  • Code is clean and follows best practices

Unmet Requirements

All requirements met

Tests

Failed Tests

No failing tests

Missing Test Cases

No missing test cases identified

Action Items

No action items required

Signatures

Staking Key

3oBzgQ4y8YtmkxYGkse1fKKefi25twpMKU9BBdsYtjDQ: 26p4Uhyn8LC32ewcTahTrEHzVEw8yKPEKWRxi1K1NSpaFRHRt84F7RwZAkXBYFT2mNjaMEDU2nBsDak7qV3Yu4RLnZYqs7XAoD1qDCpUfXMhKGGEfPMhARJW8aaN9Gxa7Z8HjqKZ6rsT8zR19RMiVxmjaDpZ8Xt6oqqnLqfXFhfnajDTPwsjKq6UtADCrUhovqKLHkXkTwmk7v9L2jRGHjnov2AsVoL87jTN9LJuK8izTVYyFF5CpChAF9esLu2Y5315Ryjq6hEG6E8RJzY

Public Key

4WA5vRJLthsg6sJqVc6DQuRkGzvoxZ11SkqzwbqxCo2V: 53LnxkdrZchFeBAns3QT4Uv8oe8bWzZH4izLrA3g4xGLHtV5jWnLPxdxZKfV6tzagictiXqB2eRjcDpZvFPSz423mzF9yxeGeUMgTk1u74YLjLYpSsZ8LCVXoRgL6aC85L3N9m41QiMiPcoPGFovECh1CxX5pjc1gDHcJGQaBwExQCWDqXanDPuVVP5rPyp5E4gsruXKXtobVHnpDC8rGqHKQswLHGq3Eypro1sd7BBef4b62L8UfkunL6HAj3MHhpDL4JxZeE3wAKha6ov

@SatoshiShibanuma
Copy link

SatoshiShibanuma commented May 24, 2025

Simple Utility Function Implementation

Description

Implementation of a basic sum utility function with accompanying tests

Recommendation

APPROVE

Reasons:

  • Implementation matches requirements
  • Tests cover multiple scenarios including zero and negative numbers
  • Single file implementation in /src directory
  • Tests in single file
  • All tests pass

Unmet Requirements

All requirements met

Tests

Failed Tests

No failing tests

Missing Test Cases

No missing test cases identified

Action Items

No action items required

Signatures

Staking Key

67sMTqztouCV7JyxbXwE9ukZw7DkzpGQ7SWFa26uEKiu: 2fx73BM1dtDKc7AQzp2tCLniCm8xDxtbGhugTLwhacqy4szBAhNKNZ6U4jyfjgrjMTrAZpgT3STPiiXcboY8b5r2zW9843uT87HVo7ammLgGCsHDAxkBMovAwbiRLeHQFWsDGLMiviZ58mXWZn3fwCk4HafyFiAUoWzFE71hhsaL7QX6FuRrmV1Kc4QsmHsfnVmJYEpocHWwsgYVxkSCxHUmQhRxy7X2UwyYMyUdr1PPKQu2ZKmwHBeqfAeQjNCGYAmjMWJok8zbJz3Ed2k

Public Key

3BQfPXJnnVjRidUnzVWY4SQiEQw7dJGQdAA2xQfYxFQe: H96Gors13cZMg518dNaLgfa7PTBKN7QURxLRJhLiUjBovWASuJGi96PDVXj2LwjKykHMDNfaKUVURnpxDrjB9DNMzAQRtY5zMpofPVXfsipb4nvb8G6nyMTf1kPkrY2F7kXc4DZKAti1UV8EkHWXMNsyMLwH2PrjweNfhy4rLnUoVLAdsdSPxFMyrgjTThLACawDwqDUGr2megqZ5ypmEnAbWatx6yYL6Wr7myd7HdLncXYWwUniGySEhYFiE4RRef6DQUZBpwY7bKcbXJ

@Santix1234
Copy link

Santix1234 commented May 24, 2025

Simple Sum Utility Function

Description

Implemented a basic sum utility function with corresponding tests

Recommendation

APPROVE

Reasons:

  • Implementation is in a single file in /src directory
  • Tests are in a single file in /src directory
  • All tests pass
  • No other files were modified

Unmet Requirements

All requirements met

Tests

Failed Tests

No failing tests

Missing Test Cases

No missing test cases identified

Action Items

No action items required

Signatures

Staking Key

DKCEYXWcoJrRVt9kB7nXZQkeL2MrNxobmbsWC8R3QWA8: 779BnZFKdXYYdpQL7L8jcvmEfHXcTaFqcdZvXkoxiZLfhQBpxRjuH2rNhYEAPozBWAtNrJeaS1ogi86E9tXa7UBQ6RwT2sN987piXn7jJSAKS5KHy9d7Li4pPWQo79cTW1Ag1h5pERXnQW999mDMiG8dtzHBnFV5au33vbZWd8qjiUyPhc7f7v71hhdNePVhnsduHSALiisXbtyBzXbjpyvtu2nXQB7spUKgkDmCfo3nd3ie9nMJXGDrRxs3P6kZ3GHeLWWBxJRN5nPZGdz

Public Key

BLkTvPfFXvR52AK1EoHFaPyE1eDy6Mr5GvgWAbFMvK6x: 4o1UFVfLiQoti6K32q6UucX4kGLiWZLMgGWHAQioyqHQ5gk591tB8VLWX2xo8n4uidaheVruK1uPmYdQ4FQCKkYSSd6jtN9HtrbGLrqNA5fXsCrfBQBFfXi52Y3gXGGxcMXc2t58mK2wxeqcnk6EMsypxMmg9q4hjUpXw6iwLGUQbhR2mZX6tHaE6dP9U9B67nxDqNWY3rAZqeVJqdBCy5tRKFs4yjJtySuk7wdtEDZTdPLpSPnCLec6eQVS5MuwpPYGMH27CEC13wA9fEc

@Santix1234 Santix1234 mentioned this pull request Jun 7, 2025
Merged
@NicolaFattore NicolaFattore mentioned this pull request Jun 7, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@Jockstrap6334 @usaflees9 @gapcomputer @ranjhayhero @Vuk7912 @SatoshiShibanuma @Santix1234