vcwild / norminette-hook

The Norminette pre-commit hook.

Norminette Hook

The Norminette pre-commit hook.

❓ About

Git hooks are actions triggered whenever you do a commit.

After you execute a git commit, the norminette-hook will automatically trigger Norminette on your staged files, and if you are off the norm it will display what needs to be fixed before you can record this commit to your git history.

This ensures that every commit you do will follow the rules, and you don't have to run Norminette manually anymore.

By default, the Norminette hook will only check for files in stage, it is not running for every existing file of your project!

We realized that this is a better design, for you can write tests and other libraries that do not require strict rules.

📝 Requirements

• Pre-commit must be installed system-wide or in a virtual environment.

NOTE: Currently the plugin is only supported in UNIX-like environments (Linux, BSD, Mac).

💿 Usage

Create a .pre-commit-config.yaml file in the root of your repository.

Add there the following lines:

default_language_version:
  python: python3

repos:
  - repo: https://github.com/vcwild/norminette-hook
    rev: v0.1.1
    hooks:
    - id: norminette-hook

When executing pre-commit run or pre-commit run norminette-hook, the hook will be triggered.

Now install the hook to execute it automatically for each commit.

pre-commit install --install-hooks --overwrite

You are now ready for some next level linting automation! 👨‍🚀🚀

🙋 FAQ / Common issues

Error "bash: pre-commit: command not found"

Make sure you have installed pre-commit and it is available in the current shell environment.

How to commit without running Norminette?

If you want to skip commit hooks for whatever reason, simply use:

git commit --no-verify

How to remove this hook?

Simply remove the folder where pre-commit hooks is installed:

rm -f [root_dir]/.git/hooks/pre_commit`

This only removes the hook from executing after every commit. If you want to wipe your pre-commit installation, please follow pre-commit uninstall

🤝 Contributing

Fork the repository and create a pull request.

🏷️ License

The project is under the MIT License. The software is provided as is, without warranty of any kind.

norminette-hook's Issues

Python on WSL Ubuntu is Python3 and is not executed

Hi there,

Many thanks for your awsome work.
I tried to install norminette-hook on Win10 with WSL Ubuntu 22.04 and I got the following error:

An unexpected error has occurred: CalledProcessError: command: ('python', '-mpip', 'install', '.')
return code: 1
expected return code: 0
stdout:
    Executable `python` not found
stderr: (none)

Traceback (most recent call last):
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/error_handler.py", line 73, in error_handler
    yield
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/main.py", line 386, in main
    return run(args.config, store, args)
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/commands/run.py", line 424, in run
    install_hook_envs(to_install, store)
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/repository.py", line 223, in install_hook_envs
    _hook_install(hook)
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/repository.py", line 79, in _hook_install
    lang.install_environment(
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/languages/python.py", line 221, in install_environment
    helpers.run_setup_cmd(prefix, install_cmd)
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/languages/helpers.py", line 48, in run_setup_cmd
    cmd_output_b(*cmd, cwd=prefix.prefix_dir, **kwargs)
  File "/home/user/.local/lib/python3.10/site-packages/pre_commit/util.py", line 146, in cmd_output_b
    raise CalledProcessError(returncode, cmd, retcode, stdout_b, stderr_b)
pre_commit.util.CalledProcessError: command: ('python', '-mpip', 'install', '.')
return code: 1
expected return code: 0
stdout:
    Executable `python` not found
stderr: (none)

I made some tests and I think its because if you run python in ubuntu it isn't recognized. Only if I run python3 I get python running.

Thanks in advance.