pre-commit
mirrors-prettier
Our great sponsors
pre-commit | mirrors-prettier | |
---|---|---|
192 | 5 | |
12,049 | 124 | |
2.7% | - | |
8.0 | 7.2 | |
2 days ago | 16 days ago | |
Python | ||
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
pre-commit
-
How to setup Black and pre-commit in python for auto text-formatting on commit
Today we are going to look at how to setup Black (a python code formatter) and pre-commit (a package for handling git hooks in python) to automatically format you code on commit.
-
Implementing Quality Checks In Your Git Workflow With Hooks and pre-commit
# See https://pre-commit.com for more information # See https://pre-commit.com/hooks.html for more hooks repos: - repo: https://github.com/pre-commit/pre-commit-hooks rev: v3.2.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: check-toml - id: check-added-large-files - repo: local hooks: - id: tox lint name: tox-validation entry: pdm run tox -e test,lint language: system files: ^src\/.+py$|pyproject.toml|^tests\/.+py$ types_or: [python, toml] pass_filenames: false - id: tox docs name: tox-docs language: system entry: pdm run tox -e docs types_or: [python, rst, toml] files: ^src\/.+py$|pyproject.toml|^docs\/ pass_filenames: false - repo: https://github.com/pdm-project/pdm rev: 2.10.4 # a PDM release exposing the hook hooks: - id: pdm-lock-check - repo: https://github.com/jumanjihouse/pre-commit-hooks rev: 3.0.0 hooks: - id: markdownlint
-
Embracing Modern Python for Web Development
Pre-commit hooks act as the first line of defense in maintaining code quality, seamlessly integrating with linters and code formatters. They automatically execute these tools each time a developer tries to commit code to the repository, ensuring the code adheres to the project's standards. If the hooks detect issues, the commit is paused until the issues are resolved, guaranteeing that only code meeting quality standards makes it into the repository.
- EmacsConf Live Now
-
A Tale of Two Kitchens - Hypermodernizing Your Python Code Base
Pre-commit Hooks: Pre-commit is a tool that can be set up to enforce coding rules and standards before you commit your changes to your code repository. This ensures that you can't even check in (commit) code that doesn't meet your standards. This allows a code reviewer to focus on the architecture of a change while not wasting time with trivial style nitpicks.
-
Things I just don't like about Git
Ah, fair enough!
On my team we use pre-commit[0] a lot. I guess I would define the history to be something like "has this commit ever been run through our pre-commit hooks?". If you rewrite history, you'll (usually) produce commits that have not been through pre-commit (and they've therefore dodged a lot of static checks that might catch code that wasn't working, at that point in time). That gives some manner of objectivity to the "history", although it does depend on each user having their pre-commit hooks activated in their local workspace.
[0]: https://pre-commit.com/
-
Django Code Formatting and Linting Made Easy: A Step-by-Step Pre-commit Hook Tutorial
Pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. It supports hooks for various programming languages. Using this framework, you only have to specify a list of hooks you want to run before every commit, and pre-commit handles the installation and execution of those hooks despite your project’s primary language.
-
Git: fu** the history!
You can learn more here: pre-commit.com
-
[Tool Anouncement] github-distributed-owners - A tool for managing GitHub CODEOWNERS using OWNERS files distributed throughout your code base. Especially helpful for monorepos / multi-team repos
Note this includes support for pre-commit.
-
Packaging Python projects in 2023 from scratch
As a nice next step, you could also add mypy to check your type hints are consistent, and automate running all this via pre-commit hooks set up with… pre-commit.
mirrors-prettier
-
Setting Up Pre-Commit Hooks in GitHub: Ensuring Code Quality and Consistency
repos: - repo: https://github.com/pre-commit/mirrors-prettier rev: hooks: - id: prettier files: \.(json|markdown|md|yaml|yml)$
-
Hugo no theme
note, we also need to add prettier itself too because usually JavaScript hooks use additional_dependencies to install libraries that hook uses, here is example
-
Python Code Quality - Improve the quality of your Python code with linters, code formatters, and security vulnerability scanners
yaml repos: - repo: https://github.com/myint/autoflake rev: v1.4 hooks: - id: autoflake args: - --in-place - --remove-all-unused-imports - --expand-star-imports - --remove-duplicate-keys - --remove-unused-variables - repo: https://github.com/asottile/pyupgrade rev: v2.29.0 hooks: - id: pyupgrade args: [--py36-plus] - repo: https://github.com/PyCQA/isort rev: 5.9.3 hooks: - id: isort - repo: https://github.com/psf/black rev: 21.10b0 hooks: - id: black args: [--safe, --quiet] - repo: https://github.com/PyCQA/flake8 rev: 4.0.1 hooks: - id: flake8 - repo: local hooks: - id: pylint name: pylint entry: pylint language: system types: [python] args: [ "-rn", "-sn", ] - repo: https://github.com/pre-commit/mirrors-mypy rev: v0.910-1 hooks: - id: mypy name: mypy entry: mypy language: python types: [python] args: [] require_serial: true - repo: https://github.com/pre-commit/mirrors-prettier rev: v2.4.1 hooks: - id: prettier args: [--prose-wrap=always, --print-width=88]
-
It's too peaceful here, let's start a flame war
Might be a python package, but they've designed it to be language-agnostic, running hooks in their own virtual environments locally. For instance, they have a mirror for Prettier available.
-
Creating vite vue ts template: Setup pre-commit
+- repo: https://github.com/pre-commit/mirrors-prettier + rev: '' # Use the sha / tag you want to point at + hooks: + - id: prettier
What are some alternatives?
husky - Git hooks made easy 🐶 woof!
editorconfig-vim - EditorConfig plugin for Vim
gitleaks - Protect and discover secrets using Gitleaks 🔑
mirrors-mypy - Mirror of mypy for pre-commit
ruff - An extremely fast Python linter and code formatter, written in Rust.
Flake8 - flake8 is a python tool that glues together pycodestyle, pyflakes, mccabe, and third-party plugins to check the style and quality of some python code.
semgrep - Lightweight static analysis for many languages. Find bug variants with patterns that look like source code.
pylint - It's not just a linter that annoys you! [Moved to: https://github.com/pylint-dev/pylint]
Poetry - Python packaging and dependency management made easy
pyupgrade - A tool (and pre-commit hook) to automatically upgrade syntax for newer versions of the language.
pre-commit-golang - Pre-commit hooks for Golang with support for monorepos, the ability to pass arguments and environment variables to all hooks, and the ability to invoke custom go tools.
prettier-plugin-go-template - Fixes prettier formatting for go templates 🐹