Unified formatting for YAML, MD, JSON

Prettier configuration for the repository that can be invoked manually,
or through pre-commit

Author: kazmer97

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,35 +4,33 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Describe the bug** A clear and concise description of what the bug is.
+
+**To Reproduce** Steps to reproduce the behavior:
 
-**To Reproduce**
-Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+**Expected behavior** A clear and concise description of what you expected to
+happen.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+**Screenshots** If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
 
-**Additional context**
-Add any other context about the problem here.
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context** Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -4,17 +4,16 @@ about: Suggest an idea for this project
 title: ''
 labels: ''
 assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Is your feature request related to a problem? Please describe.** A clear and
+concise description of what the problem is. Ex. I'm always frustrated when [...]
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+**Describe the solution you'd like** A clear and concise description of what you
+want to happen.
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+**Describe alternatives you've considered** A clear and concise description of
+any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional context** Add any other context or screenshots about the feature
+request here.

.gitignore

@@ -1,25 +1,40 @@
+# Environment files
 .env
+
+# Build outputs
 .aws-sam
 build.toml
 model.tar.gz
 .checksum
 .checksums/
 .build_checksum
 .lib_checksum
+dist/
+build/
+*.egg-info/
+
+# IDE
 .vscode/
+.idea/
+*.code-workspace
+
+# OS
 .DS_Store
-dist/
+
+# Temporary/Data
 .sav/
 .delete/
 .data/
-*.egg-info/
-build/
-__pycache__
-*.code-workspace
-.ruff_cache
 .kiro
 rvl_cdip_*
 notebooks/examples/data
-.idea/
 .dsr/
-*tmp-dev-assets*
+*tmp-dev-assets*
+
+# Python
+__pycache__
+.ruff_cache
+
+# Node.js (prettier/pre-commit)
+node_modules/
+package-lock.json

.gitlab-ci.yml

@@ -22,13 +22,13 @@ stages:
 developer_tests:
   stage: developer_tests
   rules:
-    - when: always  # Run on all branches
-  
+    - when: always # Run on all branches
+
   before_script:
     - python --version
     - apt-get update -y
     - apt-get install make -y
-    - pip install ruff
+    - pip install ruff pre-commit
     # Install dependencies needed by publish.py for test imports
     - pip install typer rich boto3
     # Install test dependencies
@@ -37,7 +37,7 @@ developer_tests:
   script:
     - make lint-cicd
     - make test-cicd -C lib/idp_common_pkg
-  
+
   artifacts:
     paths:
       - lib/idp_common_pkg/test-reports/coverage.xml
@@ -56,9 +56,9 @@ integration_tests:
   #   AWS_CREDS_TARGET_ROLE: ${AWS_CREDS_TARGET_ROLE}
   #   AWS_DEFAULT_REGION: ${AWS_DEFAULT_REGION}
   #   IDP_ACCOUNT_ID: ${IDP_ACCOUNT_ID}
-  
- # Add rules to only run on develop branch
- # Add rules to only run on develop branch
+
+  # Add rules to only run on develop branch
+  # Add rules to only run on develop branch
   rules:
     - if: $CI_COMMIT_BRANCH == "develop"
       when: always # always # When idp-accelerator CICD is reconfigured
@@ -70,13 +70,13 @@ integration_tests:
       when: manual
     - if: $CI_COMMIT_BRANCH =~ /^release\/.*/
       when: manual
-    - when: manual  # This will make it available on all other branches
+    - when: manual # This will make it available on all other branches
 
   before_script:
     - python --version
     - apt-get update -y
     - apt-get install zip unzip curl make -y
-       
+
     # Install Poetry
     - curl -sSL https://install.python-poetry.org | python3 -
     - export PATH="/root/.local/bin:$PATH"
@@ -113,4 +113,3 @@ deployment_validation:
   script:
     # Check if service role has sufficient permissions for main stack deployment
     - python3 scripts/validate_service_role_permissions.py
-  

.pre-commit-config.yaml

@@ -0,0 +1,94 @@
+# Pre-commit hooks for code quality and formatting
+# See https://pre-commit.com for more information
+
+repos:
+  # Ruff - Python linter and formatter (replaces black, isort, flake8, etc.)
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: [--fix]
+      # Run the formatter
+      - id: ruff-format
+
+  # Prettier - YAML, JSON, Markdown formatter
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.1.0
+    hooks:
+      - id: prettier
+        types_or: [yaml, json, markdown]
+        exclude: |
+          (?x)^(
+              package-lock\.json|
+              .*\.lock|
+              \.aws-sam/.*|
+              node_modules/.*|
+              .*/testing/.*\.(json|yaml|yml)|
+              .*/examples?/.*\.(json|yaml|yml)|
+              .*[Ee]xample.*\.(json|yaml|yml)|
+              .*[Tt]emplate.*\.(json|yaml|yml)
+          )$
+
+  # General file checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: |
+          (?x)^(
+              .*\.md|
+              \.aws-sam/.*
+          )$
+      - id: end-of-file-fixer
+        exclude: \.aws-sam/.*
+      - id: check-yaml
+        args: [--unsafe] # Allow custom YAML tags (CloudFormation)
+        exclude: |
+          (?x)^(
+              \.aws-sam/.*|
+              templates/.*
+          )$
+      - id: check-json
+        exclude: |
+          (?x)^(
+              \.vscode/.*|
+              \.aws-sam/.*
+          )$
+      - id: check-added-large-files
+        args: [--maxkb=5000]
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: mixed-line-ending
+
+  # Python-specific checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-ast # Validate Python syntax
+      - id: debug-statements # Check for debugger imports
+      - id: name-tests-test # Ensure test files are named correctly
+        args: [--pytest-test-first]
+
+  # Security checks
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+        args: [--baseline, .secrets.baseline]
+        exclude: |
+          (?x)^(
+              .*\.lock|
+              package-lock\.json|
+              \.aws-sam/.*
+          )$
+
+# Global configuration
+default_language_version:
+  python: python3
+
+# Don't fail if hooks are missing
+fail_fast: false
+
+# Minimum pre-commit version
+minimum_pre_commit_version: "3.0.0"

.prettierignore

@@ -0,0 +1,57 @@
+# Dependencies
+node_modules/
+**/node_modules/
+
+# Build outputs
+build/
+dist/
+.aws-sam/
+**/.aws-sam/
+
+# Python
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+venv/
+env/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+
+# Environment files
+.env
+.env.*
+!.env.example
+!.env.*.template
+
+# Lock files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# Git
+.git/
+
+# Specific files that shouldn't be formatted
+VERSION
+LICENSE
+NOTICE
+
+# Template/example files with placeholder tokens (using <> syntax)
+**/testing/**/*.json
+**/examples/**/*.json
+**/*Example*.json
+**/*Template*.json
+**/*example*.json
+**/*template*.json

.prettierrc.json

@@ -0,0 +1,51 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": ["*.yaml", "*.yml"],
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 2,
+        "useTabs": false,
+        "bracketSpacing": true,
+        "singleQuote": false,
+        "proseWrap": "preserve"
+      }
+    },
+    {
+      "files": ["template.yaml", "**/template.yaml", "**/*.template.yaml"],
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 2,
+        "proseWrap": "preserve"
+      }
+    },
+    {
+      "files": ["*.js", "*.jsx", "*.ts", "*.tsx"],
+      "options": {
+        "printWidth": 120,
+        "singleQuote": true,
+        "trailingComma": "all"
+      }
+    },
+    {
+      "files": "*.json",
+      "options": {
+        "printWidth": 120,
+        "tabWidth": 2
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "printWidth": 80,
+        "proseWrap": "always"
+      }
+    }
+  ]
+}

.secrets.baseline

@@ -0,0 +1 @@
+{}