[PR #306] Add Prettier formatting scripts and dependencies to both root and app… #350

Open
opened 2025-11-22 20:36:05 -06:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Dokploy/templates/pull/306
Author: @jaainil
Created: 8/25/2025
Status: 🔄 Open

Base: mainHead: adding-prettier


📝 Commits (10+)

  • c881ead Add Prettier formatting scripts and dependencies to both root and app package.json
  • 92fb1ec Configure Prettier with file-specific formatting rules for consistent code style
  • 91cbaaf Update Prettier configuration to standardize code formatting and ignore markdown files
  • bc0570d Expand Prettier configuration with file-specific rules and update ignore patterns
  • b7df120 Added Config Files
  • 4561d49 Add comprehensive Prettier formatting documentation to README
  • 4532036 Merge branch 'Dokploy:main' into adding-prettier
  • 6ecd998 Formatted All Files!!!
  • 28c343d Remove custom JSON formatting in favor of standard formatting with Prettier
  • b6e3669 Format meta.json with Prettier to improve readability and maintainability

📊 Changes

190 files changed (+3529 additions, -3502 deletions)

View changed files

📝 .github/ISSUE_TEMPLATE/bug-report.yml (+4 -4)
📝 .github/ISSUE_TEMPLATE/feature-request.yml (+3 -3)
📝 .github/workflows/build-preview.yml (+1 -1)
📝 .github/workflows/cloudflare-pages-production.yml (+2 -2)
📝 .github/workflows/deploy-preview.yml (+1 -1)
📝 .github/workflows/validate.yml (+1 -1)
.prettierignore (+91 -0)
.prettierrc (+1 -0)
📝 README-meta-processing.md (+47 -1)
📝 README.md (+5 -6)
📝 app/components.json (+1 -1)
📝 app/package.json (+6 -1)
📝 app/pnpm-lock.yaml (+2289 -1464)
📝 app/src/App.css (+2 -2)
📝 app/src/components/Navigation.tsx (+5 -3)
📝 app/src/components/Search.tsx (+20 -6)
📝 app/src/components/Tags.tsx (+1 -1)
📝 app/src/components/TemplateGrid.tsx (+3 -3)
📝 app/src/components/ui/badge.tsx (+2 -2)
📝 app/src/components/ui/button.tsx (+10 -10)

...and 80 more files

📄 Description

What is this PR about?

Add global Prettier configuration for consistent code formatting across the entire project

Changes Made

  • Added .prettierrc - Comprehensive configuration supporting 20+ file types (JS/TS/TSX, HTML, CSS, JSON, YAML, TOML, Docker, Makefile, and more)
  • Created .prettierignore - Excludes build outputs, node_modules, lock files, and sensitive files
  • Updated package.json - Added Prettier dependency and formatting scripts (format, format:check, format:app, format:check:app)
  • Updated app/package.json - Added app-specific Prettier scripts and dependency
  • Enhanced README-meta-processing.md - Added comprehensive documentation section with usage examples and supported file types
  • Fixed JSON syntax errors - Resolved malformed configuration blocks and duplicate entries

Benefits

  • Team Consistency - Prevents formatting conflicts across team members
  • CI/CD Ready - Includes format checking scripts for automated workflows
  • Comprehensive Coverage - Supports all project file types including React, Node.js, config files, and documentation
  • Zero Configuration - Works out-of-the-box with sensible defaults for all languages

Commands Tested

# All commands work perfectly with exit code 0

✅ npm run format                # Formatted 306 files successfully
✅ npm run format:check          # "All matched files use Prettier code style!"
✅ npm run format:app            # App-specific formatting working
✅ npm run format:check:app      # App format validation passingcd app && npm run format      # Direct app directory formatting working

Checklist

  • I have tested all Prettier commands with npm run format, npm run format:check, npm run format:app, and npm run format:check:app
  • I have verified comprehensive file type support across the entire project (306 files processed)
  • I have added complete documentation in README-meta-processing.md with usage examples
  • I have ensured the configuration doesn't break existing code or build processes
  • I have validated JSON syntax and confirmed no parsing errors
  • I have confirmed exit code 0 for all formatting operations

Testing Results

  • 306 files processed across entire project without errors
  • All file types supported - JS/TS/TSX, YAML, Docker, HTML, CSS, JSON, TOML, etc.
  • Format validation passing - "All matched files use Prettier code style!"
  • App directory working - Separate app formatting pipeline functional
  • No syntax errors - Clean JSON configuration with proper structure

Resolves team formatting inconsistencies and establishes comprehensive project-wide code style standards with full testing validation.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Dokploy/templates/pull/306 **Author:** [@jaainil](https://github.com/jaainil) **Created:** 8/25/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `adding-prettier` --- ### 📝 Commits (10+) - [`c881ead`](https://github.com/Dokploy/templates/commit/c881eadd5caff2cea52a414cae97b91a9f694253) Add Prettier formatting scripts and dependencies to both root and app package.json - [`92fb1ec`](https://github.com/Dokploy/templates/commit/92fb1ec40d12d797302cc1dea10dc3710c5d0015) Configure Prettier with file-specific formatting rules for consistent code style - [`91cbaaf`](https://github.com/Dokploy/templates/commit/91cbaaf0b57ce918fa035587cce17c3d7281e8a2) Update Prettier configuration to standardize code formatting and ignore markdown files - [`bc0570d`](https://github.com/Dokploy/templates/commit/bc0570db81e4aab9e58d325fae737ee9b314a57f) Expand Prettier configuration with file-specific rules and update ignore patterns - [`b7df120`](https://github.com/Dokploy/templates/commit/b7df1200c82ee32452933491515dc0dd9074fc62) Added Config Files - [`4561d49`](https://github.com/Dokploy/templates/commit/4561d49eb5ec02830fbbb91d5fedabd3bf69411a) Add comprehensive Prettier formatting documentation to README - [`4532036`](https://github.com/Dokploy/templates/commit/4532036f2b1c64eba5054fbfbfb2f1789836b04d) Merge branch 'Dokploy:main' into adding-prettier - [`6ecd998`](https://github.com/Dokploy/templates/commit/6ecd9989ac6f178f8ef8d5d750be8585f3fc1756) Formatted All Files!!! - [`28c343d`](https://github.com/Dokploy/templates/commit/28c343d24be4d28f390524c21e7fefbf425a7d19) Remove custom JSON formatting in favor of standard formatting with Prettier - [`b6e3669`](https://github.com/Dokploy/templates/commit/b6e36692805107260b81f45d2b0d5ca1ee68e06e) Format meta.json with Prettier to improve readability and maintainability ### 📊 Changes **190 files changed** (+3529 additions, -3502 deletions) <details> <summary>View changed files</summary> 📝 `.github/ISSUE_TEMPLATE/bug-report.yml` (+4 -4) 📝 `.github/ISSUE_TEMPLATE/feature-request.yml` (+3 -3) 📝 `.github/workflows/build-preview.yml` (+1 -1) 📝 `.github/workflows/cloudflare-pages-production.yml` (+2 -2) 📝 `.github/workflows/deploy-preview.yml` (+1 -1) 📝 `.github/workflows/validate.yml` (+1 -1) ➕ `.prettierignore` (+91 -0) ➕ `.prettierrc` (+1 -0) 📝 `README-meta-processing.md` (+47 -1) 📝 `README.md` (+5 -6) 📝 `app/components.json` (+1 -1) 📝 `app/package.json` (+6 -1) 📝 `app/pnpm-lock.yaml` (+2289 -1464) 📝 `app/src/App.css` (+2 -2) 📝 `app/src/components/Navigation.tsx` (+5 -3) 📝 `app/src/components/Search.tsx` (+20 -6) 📝 `app/src/components/Tags.tsx` (+1 -1) 📝 `app/src/components/TemplateGrid.tsx` (+3 -3) 📝 `app/src/components/ui/badge.tsx` (+2 -2) 📝 `app/src/components/ui/button.tsx` (+10 -10) _...and 80 more files_ </details> ### 📄 Description ## What is this PR about? Add global Prettier configuration for consistent code formatting across the entire project ## Changes Made - ✅ **Added `.prettierrc`** - Comprehensive configuration supporting 20+ file types (JS/TS/TSX, HTML, CSS, JSON, YAML, TOML, Docker, Makefile, and more) - ✅ **Created `.prettierignore`** - Excludes build outputs, node_modules, lock files, and sensitive files - ✅ **Updated `package.json`** - Added Prettier dependency and formatting scripts (`format`, `format:check`, `format:app`, `format:check:app`) - ✅ **Updated `app/package.json`** - Added app-specific Prettier scripts and dependency - ✅ **Enhanced `README-meta-processing.md`** - Added comprehensive documentation section with usage examples and supported file types - ✅ **Fixed JSON syntax errors** - Resolved malformed configuration blocks and duplicate entries ## Benefits - **Team Consistency** - Prevents formatting conflicts across team members - **CI/CD Ready** - Includes format checking scripts for automated workflows - **Comprehensive Coverage** - Supports all project file types including React, Node.js, config files, and documentation - **Zero Configuration** - Works out-of-the-box with sensible defaults for all languages ## Commands Tested ✅ ```bash # All commands work perfectly with exit code 0 ✅ npm run format # Formatted 306 files successfully ✅ npm run format:check # "All matched files use Prettier code style!" ✅ npm run format:app # App-specific formatting working ✅ npm run format:check:app # App format validation passing ✅ cd app && npm run format # Direct app directory formatting working ``` ## Checklist - [x] I have tested all Prettier commands with `npm run format`, `npm run format:check`, `npm run format:app`, and `npm run format:check:app` - [x] I have verified comprehensive file type support across the entire project (306 files processed) - [x] I have added complete documentation in README-meta-processing.md with usage examples - [x] I have ensured the configuration doesn't break existing code or build processes - [x] I have validated JSON syntax and confirmed no parsing errors - [x] I have confirmed exit code 0 for all formatting operations ## Testing Results - ✅ **306 files processed** across entire project without errors - ✅ **All file types supported** - JS/TS/TSX, YAML, Docker, HTML, CSS, JSON, TOML, etc. - ✅ **Format validation passing** - "All matched files use Prettier code style!" - ✅ **App directory working** - Separate app formatting pipeline functional - ✅ **No syntax errors** - Clean JSON configuration with proper structure ## Issues related #216 Resolves team formatting inconsistencies and establishes comprehensive project-wide code style standards with full testing validation. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2025-11-22 20:36:05 -06:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/templates#350