Respect `.styluaignore` when explicitly passing in file names

[mrcjkb]

Hi 😄

I have a git pre-commit hook that calls stylua with file names (the staged files),
and I noticed that when passing in a file (rather than a directory), it is formatted, even if the file matches .styluaignore.

Is this intended behaviour? If so, I'm wondering if there's a way to modify this behaviour so that it works with pre-commit hooks, or if it would make sense to add a CLI flag?
(asking before I go ahead and open a PR)

[JohnnyMorganz]

Hey,
Yeah, passing a file directly will bypass ignore checks since we assume it was passed explicitly on purpose. Glob Filtering and .styluaignore both are only taken into account for directory traversal

[mrcjkb]

Thanks for the info. Sounds reasonable. I'll see if I can fix this in the pre-commit hook.

[dundargoc]

@JohnnyMorganz is this the intended behavior? If so, could I try to persuade you to to rethink this behavior?

I'll spare you the boring details but long story short: our build system caches required work at a file level, meaning that we have to run stylua on each file individually if we want to avoid linting and formatting unmodified files. This procedure helps us save immense amounts of time by only doing work that is necessary. I suspect our build system isn't the only one with this behavior and that our situation isn't unique.

My proposal is instead that .styluaignore to always be respected regardless if given path is a file or directory. This way it .styluaignore becomes authoritative and, in my opinion, more consistent.

If you'd still like a way for stylua to be able to bypass .styluaignore then I personally think an explicit flag, e.g. --force, would serve the same purpose. This also covers the case where a user might want to format an entire directory marked by .styluaignore. In both cases (respect/ignore .styluaignore) the behavior for files and directories would be the same, which I think is desirable.

Thank you for hearing me out and thank you for stylua :)

[JohnnyMorganz]

I think it is reasonable to provide some way to continue respecting ignores when explicitly passing file names. For backwards compatibility reasons, it would probably have to be the inverse of your suggestion, instead providing a --respect-ignores or similar flag to enable this behaviour. I would prefer having a --force flag for this though... it makes more sense.

I was curious what the default behaviour of other tools are for this:

• git add: respects .gitignore by default, with -f force flag

The following paths are ignored by one of your .gitignore files:
test.lua
hint: Use -f if you really want to add them.
hint: Turn this message off by running
hint: "git config advice.addIgnoredFile false"

• prettier: respects .prettierignore by default - there seems to be no way to "force" it

• black: does not respect includes by default. Requires a --force-exclude <TEXT> parameter to be passed to exclude a file even if it was passed explicitly to the command line

Each tool varies in its support

[mrcjkb]

I think --respect-ignores is fine.

As a user, if I'm running stylua on a file from the command line, I probably want to format that file, so --force might be a bit of an inconvenience.
For automated tasks (in a CI, or post-save in a text editor), it's trivial to add a --respect-ignores flag.

On the other hand, --force is safer - people have to be aware of --respect-ignores.