Skip to content

Conversation

@kzndotsh
Copy link
Contributor

@kzndotsh kzndotsh commented Jun 15, 2025

This PR enhances the developer experience by adding and improving configuration files:

Changes:

  • Add .editorconfig for consistent coding style across editors
  • Add .gitattributes for consistent line endings across platforms
  • Update pre-commit hooks with Prettier integration and end-of-file fixes
  • Apply consistent formatting and add missing newlines across config files
  • Update VSCode settings and recommended extensions
  • Exclude .vscode directory from Prettier formatting
  • Adjust print width to 80 characters for better readability

Benefits:

  • Ensures uniform code formatting across different editors and IDEs
  • Reduces formatting-related conflicts during collaboration
  • Adheres to POSIX standards and best practices
  • Automated formatting reduces manual effort
  • Cross-platform compatibility with consistent line endings

Commits:

  • b9f1019: Update prettier config and VSCode settings
  • adf75ba: Apply consistent formatting and add missing newlines
  • 7e940d6: Add .editorconfig and update VSCode configuration
  • 49ae236: Add .gitattributes for consistent line endings
  • 19259ca: Update pre-commit hooks configuration

No breaking changes. All changes are focused on developer tooling and code quality improvements.

Summary by Sourcery

Apply consistent formatting and enhance developer tooling by adding new config files, updating pre-commit hooks, and standardizing styles across editors and CI workflows.

Enhancements:

  • Introduce .editorconfig and .gitattributes to enforce consistent coding style and line endings.
  • Enhance pre-commit configuration with Prettier (80-char print width), EOF fixer, trailing-whitespace cleanup, and updated tool versions.
  • Exclude .vscode directory from formatting to preserve IDE settings and update VSCode recommended extensions.
  • Reformat GitHub workflows, Docker Compose, TOML, CSS, HTML, and other config files for consistent indentation, quoting, and newline conventions.

kzndotsh added 5 commits June 15, 2025 01:36
Add new hooks for end-of-file fixing and trailing whitespace
removal, excluding Markdown files to preserve line breaks. Integrate
Prettier for consistent formatting of YAML and JSON files, aligning
with .editorconfig settings. Update Ruff version to v0.11.13 for
consistency across linting and formatting. Expand exclusion patterns
to include node_modules and .venv directories, preventing unnecessary
checks in these areas.

These changes improve code quality and consistency by automating
formatting and ensuring adherence to style guidelines, while also
enhancing performance by excluding irrelevant directories.
…ings and file handling

Introduce a .gitattributes file to ensure consistent line
endings across different operating systems, which helps
prevent unnecessary diffs due to line ending differences.
Define handling for various file types, including text,
binary, and large files, to optimize Git's behavior and
improve collaboration. This setup also includes export
ignores for specific directories and files, enhancing
repository cleanliness and efficiency.
Add an .editorconfig file to enforce consistent coding style
across different editors and IDEs. This helps maintain uniform
code formatting, making collaboration easier and reducing
formatting-related issues.

chore: update VSCode settings and extensions for better integration

Add EditorConfig extension to recommended VSCode extensions to
ensure developers have the necessary tools for consistent code
formatting. Update VSCode settings to align with .editorconfig
rules, such as setting end-of-line characters, inserting final
newlines, and trimming trailing whitespace. This ensures that
the development environment is configured to automatically
adhere to the project's coding standards.
Ensure consistent formatting across various configuration
and workflow files by adjusting indentation, spacing, and
quotations. Add missing newlines at the end of files to
comply with POSIX standards and improve compatibility with
tools that expect newline-terminated files.

These changes enhance readability, maintainability, and
conformity to best practices, reducing potential issues
with file parsing and version control diffs.
…y and adjust print width

Exclude the .vscode directory from Prettier formatting to prevent unnecessary formatting of editor-specific settings. Adjust the print width to 80 to enforce shorter line lengths, improving readability, especially for arrays.

style(vscode): reformat settings.json for better readability

Reformat the "python.analysis.exclude" array in settings.json to have each entry on a new line, enhancing readability and consistency with other JSON formatting practices.
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 15, 2025

Reviewer's Guide

This PR implements cross-editor and cross-platform consistency by introducing editor and Git attributes, integrates Prettier into pre-commit hooks alongside other fixes, standardizes YAML formatting in GitHub Actions workflows, updates VSCode settings and extensions, and applies uniform formatting and newline corrections across various config and documentation files.

File-Level Changes

Change Details Files
Add editor and repository configuration files for cross-platform consistency
  • Introduce .editorconfig for coding style
  • Introduce .gitattributes for consistent line endings
.editorconfig
.gitattributes
Enhance pre-commit hooks with formatting and linting tools
  • Integrate end-of-file-fixer and trailing-whitespace hooks
  • Add Prettier hook with custom args and exclude patterns
  • Bump Ruff hooks to v0.11.13
.pre-commit-config.yaml
Standardize GitHub Actions workflow YAML formatting
  • Unify quote styles for strings and keys
  • Align list indentation and remove extraneous spaces
  • Adjust blank lines for readability
.github/workflows/codeql.yml
.github/workflows/remove-old-images.yml
.github/workflows/docker-image.yml
Update VSCode environment settings and extension recommendations
  • Add recommended extensions to extensions.json
  • Adjust settings.json and exclude .vscode from Prettier formatting
.vscode/settings.json
.vscode/extensions.json
Apply consistent formatting and newline fixes across config and docs
  • Fix missing trailing newlines
  • Remove extraneous blank lines
  • Normalize indentation in compose and tool configs
.mise.toml
docker-compose.yml
docker-compose.dev.yml
docs/content/assets/stylesheets/extra.css
docs/content/assets/stylesheets/mkdocstrings.css
docs/overrides/python/material/function.html

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

cursor[bot]

This comment was marked as outdated.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @kzndotsh - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

…chema glob pattern

Add binary attribute for media files (*.mp4, *.mov, *.avi) to ensure they are treated as binary files. Remove Git LFS configuration for these media files as they are now handled as binary. Correct the glob pattern for Prisma schema files to include all schema files in subdirectories, ensuring consistent line endings. This improves file handling and ensures correct processing of media and schema files.
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jun 15, 2025

Deploying tux with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0a6a285
Status: ✅  Deploy successful!
Preview URL: https://040c3ecf.tux-afh.pages.dev
Branch Preview URL: https://refactor-dotfiles.tux-afh.pages.dev

View logs

@kzndotsh kzndotsh merged commit f4ac715 into main Jun 15, 2025
9 checks passed
@kzndotsh kzndotsh deleted the refactor/dotfiles branch June 15, 2025 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants