Howto setup file-contents-sorter

You maybe aware of the encryption tool StackExchange/blackbox

It tracks the encrypted files in keyrings/live/blackbox-files.txt. This file soon-ish gets a merge mess up when worked on collaboratively because the tool sorts it when adding new files. Therefore, I wanted to make use of file-contents-sorter.

However, I am a bit stuck with configuring it properly. I tried many combinations. The union of all and what I consider most reasonable is

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.1.0
    hooks:
       - id: file-contents-sorter
         verbose: true
         files: 'blackbox\-files\.txt$'
         args: ['./keyrings/live/blackbox-files.txt']

Can you please direct me to the right solution here? Thanks. 💟

[dan98765]

Thanks for the ping @asottile. @xasx - we’ve been using it for the same thing you’re looking for: to sort files that are kinda generic lists to reduce merge conflicts.

Specifically, here’s one example of its entry in a .pre-commit-config.yaml in a production service repository:

repos:
...
    -   id: file-contents-sorter
        files: ^(deploy-whitelist.txt|\.gitignore|\.dockerignore)$
...

[asottile]

looks close – I think the way to configure it (read:I haven’t used it myself so I’m just basing this on the config) is as follows:

repos:
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.1.0
    hooks:
       - id: file-contents-sorter
         # verbose: true (only if you need to debug it, shouln't be necessary)
         files: blackbox-files\.txt$

CC @dan98765 who might have a concrete example of using this hook somewhere