Skip to content

Setup initial project folder structure and lint#8

Merged
PerHac13 merged 2 commits intoOPCODE-Open-Spring-Fest:mainfrom
fernandoobarbosa:add-directories-to-project
Oct 12, 2025
Merged

Setup initial project folder structure and lint#8
PerHac13 merged 2 commits intoOPCODE-Open-Spring-Fest:mainfrom
fernandoobarbosa:add-directories-to-project

Conversation

@fernandoobarbosa
Copy link
Copy Markdown
Contributor

@fernandoobarbosa fernandoobarbosa commented Oct 11, 2025

Description

This pull request sets up ESLint and Prettier for the project to ensure consistent code quality and formatting standards. The implementation includes comprehensive configuration files, npm scripts for linting and formatting, and verification that the tools work correctly on existing files. Additionally, created the initial folders setup for this project.

Changes Made

  • Created the initial folders setup for this project
  • Installed dev dependencies: eslint, prettier, and @eslint/js
  • Created ESLint configuration (eslint.config.js) with:
    • ES2021+ support and module configuration
    • Recommended ESLint rules
    • Custom quality rules (indentation, quotes, semicolons, etc.)
    • Node.js and browser environment support
  • Created Prettier configuration (.prettierrc) with sensible defaults:
    • 2-space indentation
    • Single quotes
    • Semicolons enabled
    • 80 character line width
    • Trailing commas where valid in ES5
  • Added .prettierignore to exclude common files from formatting
  • Added npm scripts to package.json:
    • npm run lint - Check for linting errors
    • npm run lint:fix - Automatically fix linting errors
    • npm run format - Format all files with Prettier
    • npm run format:check - Verify formatting compliance
  • Formatted existing files - Applied Prettier formatting to 17 files in the project
  • Verified configuration - Tested both tools on existing codebase to ensure proper functionality

Semver Changes

  • Patch (bug fix, no new features)
  • Minor (new features, no breaking changes)
  • Major (breaking changes)

Issues

Closes #[issue-number] - Configure ESLint and Prettier for code quality and formatting

Checklist

  • I have read the Contributing Guidelines.
  • Created the initial folders setup for this project
  • ESLint and Prettier are installed as dev dependencies
  • Configuration files (.eslintrc.json/.prettierrc) created with sensible rules
  • Lint and format scripts added to package.json
  • Configuration tested and verified on existing files
  • All existing files formatted according to new standards

@fernandoobarbosa fernandoobarbosa changed the title Add initial project structure and environment configuration Create Project Directory Structure #5 Oct 11, 2025
@fernandoobarbosa fernandoobarbosa changed the title Create Project Directory Structure #5 Create Project Directory Structure Oct 11, 2025
@fernandoobarbosa fernandoobarbosa changed the title Create Project Directory Structure Setup initial project folder structure Oct 11, 2025
@PerHac13
Copy link
Copy Markdown
Contributor

Hi, @fernandoobarbosa
Great work on this!

Since Issue #4 and Issue #5 are closely related, it would be best to merge them into one cohesive pull request. This helps us track the changes more effectively.

Would you be able to update this PR (#8) to include the fixes for both issues?

@PerHac13
Copy link
Copy Markdown
Contributor

Hi @fernandoobarbosa, thank you for your contribution!

We're hosting Opcode 2025, an open-source fest exclusively for college students, and we would love for you to be a part of it.

Website & Registration: opcode.gymkhana.iiitbh.ac.in

Join the Community: Be sure to join our Discord server to connect with other participants and stay up-to-date!

Important: To ensure your work is officially recognized on our fest leaderboard, we merge pull requests after you have registered. Please reply to this comment to let us know if you have registered or if you are not eligible to participate.

And great news – your contributions to this repository will also count towards Hacktoberfest!

Looking forward to seeing you at the fest!

* 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
@fernandoobarbosa fernandoobarbosa changed the title Setup initial project folder structure Setup initial project folder structure and lint Oct 11, 2025
@fernandoobarbosa
Copy link
Copy Markdown
Contributor Author

fernandoobarbosa commented Oct 11, 2025

@PerHac13 Now this PR contains #4 and #5 , thank you for the invitation but i dont want to participate to opcode, just wanted to help with this issues and with Hacktoberfest

@PerHac13 PerHac13 merged commit dac45f6 into OPCODE-Open-Spring-Fest:main Oct 12, 2025
1 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Create Project Directory Structure [Feature]: Configure Linter & Formatter

2 participants