From d08e350a4b44c755f65d50227329e212efafb1b2 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Fri, 7 Nov 2025 19:57:35 +0100 Subject: Add formatting tools and VSCode configuration (#83) Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: arielcostas <94913521+arielcostas@users.noreply.github.com> Co-authored-by: Ariel Costas Guerrero --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index a1cfad1..1532b7a 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,49 @@ TODO: Update instructions 2. Open your browser and navigate to `http://localhost:5173`. +## Code Formatting and Linting + +This project uses automated formatting and linting tools to ensure code consistency. + +### Frontend (TypeScript/JavaScript) + +- **Prettier**: Code formatting +- **ESLint**: Code linting + +```sh +cd src/frontend +npm run format # Auto-format all files +npm run checkformat # Check formatting without making changes +npm run lint # Run ESLint +npm run lint:fix # Auto-fix ESLint issues +``` + +### Python + +- **Ruff**: Formatting and linting (configured in `pyproject.toml`) + +```sh +cd src/gtfs_vigo_stops +ruff format . # Format Python files +ruff check . # Check for linting issues +``` + +### C# + +- **EditorConfig**: Formatting rules (configured in `.editorconfig`) +- Format on save is enabled in VSCode + +### VSCode Setup + +When you open this project in VSCode, you'll be prompted to install recommended extensions. These include: +- Prettier +- ESLint +- Ruff +- C# Dev Kit +- EditorConfig + +The project is configured to auto-format on save. + ## Contributing Contributions are welcome! Please open an issue or submit a pull request. -- cgit v1.3