Add config files for pre/post Github hooks?

[armaandhull]

Can we add a yaml and config file for this repo to be used for git hooks e.g pre-commit?

[andialbrecht]

Why? Armaan Dhull <notifications@github.com> schrieb am Fr., 6. März 2020, 17:50:

…

Can we add a yaml and config file for this repo to be used for git hooks e.g pre-commit? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#537?email_source=notifications&email_token=AAAGIIDUE3A5VD2OSEJHGSTRGESUFA5CNFSM4LDD6Q32YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4ITFD6EQ>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAGIIFAX7K2MRJKK23IQ3LRGESUFANCNFSM4LDD6Q3Q> .

[armaandhull]

@andialbrecht because it helps sqlformat work as a pre-commit hook with pre-commit

the .pre-commit-hooks.yaml could look something like

-  id: sqlformat
   name: sqlformat
   stages: [commit]
   language: system
   entry: sqlformat
   types: [sql]

[andialbrecht]

ah, ok. But shouldn't the hooks be added in the repository where you want to use it, and not in the sqlparse repo itself? Armaan Dhull <notifications@github.com> schrieb am Fr., 6. März 2020, 18:55:

…

something like - id: sqlformat name: sqlformat stages: [commit] language: system entry: sqlformat types: [sql] — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#537?email_source=notifications&email_token=AAAGIIGQOPARII4OOXITQGLRGE2J7A5CNFSM4LDD6Q32YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEOCIDDQ#issuecomment-595886478>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAGIIGXRPKOKO27LZVLVW3RGE2J7ANCNFSM4LDD6Q3Q> .

[armaandhull]

@andialbrecht afaik the hook definition/settings i.e. .pre-commit-hooks.yaml need to be in the repo being used by pre-commit and the repo using the hook needs to have a .pre-commit-config.yaml

[andialbrecht]

Pretty sure you're referring to https://pre-commit.com/ and that those configurations need to be added to the .pre-commti-hooks.yaml file in your repository. But not in the repository of the tools you want to use in a hook.

[armaandhull]

@andialbrecht take a look at https://github.com/psf/black/blob/master/.pre-commit-hooks.yaml and https://github.com/timothycrosley/isort/blob/develop/.pre-commit-hooks.yaml. These hooks yaml files are what allow users to use them with pre-commit.

Also, https://pre-commit.com/#creating-new-hooks

A git repo containing pre-commit plugins must contain a .pre-commit-hooks.yaml file that tells pre-commit:

[PeterFogh]

@armaandhull is correct. The sqlparse repo needs a .pre-commit-hooks.yaml file to enable use of the sqlformat CLI in pre-commit hooks. As seen in my terminal error when attempting to use sqlformat in a precommit hook:

[INFO] Initializing environment for https://github.com/andialbrecht/sqlparse.
An error has occurred: InvalidManifestError:
=====> C:\Users\fogh\.cache\pre-commit\repo851egosl\.pre-commit-hooks.yaml is not a file
Check the log at C:\Users\fogh\.cache\pre-commit\pre-commit.log

When i use this .pre-commit-config.yaml file in my repo (not in https://github.com/andialbrecht/sqlparse):

repos:
  - repo: https://github.com/andialbrecht/sqlparse
    rev: 0.4.4
    hooks:
      - id: sqlformat

Why was this issue closed? Was it decided that sqlparse should not support pre-commit? :)

[ashrub-holvi]

Yep, would be good it sqlparse would support pre-commit specification and provide a .pre-commit-hooks.yaml config for make it usable in user's .pre-commit-config.yaml for sql formatting.

[ashrub-holvi]

Example of changes needed, here.

[andialbrecht]

Thanks for grabbing this up again! A pre-commit hook configuration is now available. I'm not so much a fan of pre-commit hooks myself, so feel free to test it out and give feedback.

@ashrub-holvi thanks for the example! I need to do some more changes to make the CLI work with multiple files. Also the name of the flag is --in-place instead of --write. It's a bit clearer IMO