How to exclude/skip a file (e.g. poetry.lock)?

[jamesbraza]

I am using toml-sort==0.23.1 with the below pyproject.toml config:

[tool.tomlsort]
all = true
in_place = true
trailing_comma_inline_array = true

I integrate toml-sort into my pre-commit like so:

  - repo: https://github.com/pappasam/toml-sort
    rev: v0.23.1
    hooks:
      - id: toml-sort-fix

Running identify to see the associations on poetry.lock:

> identify-cli poetry.lock
["file", "non-executable", "text", "toml"]

We can see it's considered TOML, so toml-sort will pick it up. However, poetry.lock is made programmatically, so it should not be touched by toml-sort.

How can one skip a particular file? I don't see anything in toml-sort --help that will exclude or skip files.

Is the only route right now to use an exclude within pre-commit?

[vfazio]

i think you would use either the files or exclude option within pre-commit

  - repo: https://github.com/pappasam/toml-sort/
    rev: v0.23.1
    hooks:
      - id: toml-sort
        name: Sort pyproject.toml
        entry: toml-sort
        files: pyproject.toml
        args: []

  - repo: https://github.com/pappasam/toml-sort/
    rev: v0.23.1
    hooks:
      - id: toml-sort
        name: Sort pyproject.toml
        entry: toml-sort
        exclude: poetry.lock
        args: []

[jamesbraza]

Oh thanks for that, yeah that's a fix for pre-commit usage indeed. I think though then it wouldn't apply to users directly invoking toml-sort from the CLI (outside of pre-commit).

Do you know of a way to configure exclusions from within the pyproject.toml config's tool.tomlsort?