Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: ✨ add initial configuration files for various tools and linters #1746

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

Anselmoo
Copy link
Owner

@Anselmoo Anselmoo commented Dec 17, 2024

All PR-Submissions:


  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open
    Pull Requests for the same
    update/change?

New ✨✨ Feature-Submissions:


  • Does your submission pass tests?
  • Have you lint your code locally prior to submission? Fixed:
  • This PR is for a new feature, not a bug fix.

Changes to ⚙️ Core-Features:


  • Have you added an explanation of what your changes do and why you'd like
    us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully run tests with your changes locally?

Summary by Sourcery

Add initial configuration files for Trunk and various linters and tools to set up project standards and automation.

Build:

  • Add initial configuration files for Trunk, including trunk.yaml for managing plugins, runtimes, and linters.

Chores:

  • Include configuration files for various linters and tools such as svgo, yamllint, ruff, hadolint, isort, markdownlint, and shellcheck.

@Anselmoo Anselmoo enabled auto-merge December 17, 2024 20:52
Copy link

semanticdiff-com bot commented Dec 17, 2024

Review changes with  SemanticDiff

Changed Files
File Status
  .trunk/.gitignore Unsupported file format
  .trunk/configs/.hadolint.yaml Unsupported file format
  .trunk/configs/.isort.cfg Unsupported file format
  .trunk/configs/.markdownlint.yaml Unsupported file format
  .trunk/configs/.shellcheckrc Unsupported file format
  .trunk/configs/.yamllint.yaml Unsupported file format
  .trunk/configs/ruff.toml Unsupported file format
  .trunk/configs/svgo.config.js  0% smaller
  .trunk/trunk.yaml Unsupported file format

Copy link
Contributor

sourcery-ai bot commented Dec 17, 2024

Reviewer's Guide by Sourcery

This PR introduces initial configuration files for various development tools and linters using Trunk as the primary configuration management system. The implementation focuses on setting up a comprehensive set of linting and code quality tools with specific configurations for Python, JavaScript, Docker, Markdown, and shell scripts.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Set up Trunk as the main tool orchestrator with specific runtime and plugin configurations
  • Configured three runtime environments: Go 1.21.0, Node 18.20.5, and Python 3.10.8
  • Enabled multiple linters including black, pylint, ruff, prettier, and others
  • Set up four trunk actions for announcing, pre-push checks, pre-commit formatting, and upgrade notifications
.trunk/trunk.yaml
Added specific linter configurations for various tools
  • Configured SVGO for SVG optimization with specific plugin parameters
  • Set up YAML linting rules with custom quoted-string handling
  • Created Ruff configuration with selected rule sets B, D3, E, F and ignored E501
  • Added Hadolint configuration to ignore specific shell source-related rules
  • Configured isort to use black profile for compatibility
  • Set up Markdownlint to be Prettier-friendly by extending prettier style
.trunk/configs/svgo.config.js
.trunk/configs/.yamllint.yaml
.trunk/configs/ruff.toml
.trunk/configs/.hadolint.yaml
.trunk/configs/.isort.cfg
.trunk/configs/.markdownlint.yaml
.trunk/configs/.shellcheckrc

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

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 @Anselmoo - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider consolidating Python linting tools - having ruff, pylint, and black might be redundant. Ruff can handle most of pylint's checks with better performance.
  • Consider adding documentation explaining the chosen tools and their versions to help future maintainers understand the decisions made.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

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.

Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ee4ced3) to head (8781531).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1746   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           45        45           
  Lines         4520      4520           
=========================================
  Hits          4520      4520           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@Anselmoo Anselmoo merged commit 2fd7656 into main Dec 17, 2024
58 checks passed
@Anselmoo Anselmoo deleted the feature/trunk branch December 17, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant