Add options to exclude files

[LiamPattinson]

Fixes #233

Opened as a draft as I've yet to add tests.

Doesn't add all features suggested in #233:

• --respect-gitignore is a separate issue (Fortitude should respect .gitignore #231).
• --include isn't an option for the Ruff CLI, and we'll need to handle config files separately for that (CLI and config file should be decoupled #235)
• --force-exclude would be a small extension to this, and could be added along with the tests.

[ZedThree]

I think --include is essentially the positional arguments, basically files?

--force-exclude probably good to get in too, it sounds like it's useful for things like precommit

[ZedThree]

Hmm, this is perhaps getting a little long. Looks like ruff suppresses this somehow. Once we start adding individual rule settings, this might just not be helpful.

[ZedThree]

Should we add some default exclude values? Ruff has:

pub(crate) static EXCLUDE: &[FilePattern] = &[
    FilePattern::Builtin(".bzr"),
    FilePattern::Builtin(".direnv"),
    FilePattern::Builtin(".eggs"),
    FilePattern::Builtin(".git"),
    FilePattern::Builtin(".git-rewrite"),
    FilePattern::Builtin(".hg"),
    FilePattern::Builtin(".ipynb_checkpoints"),
    FilePattern::Builtin(".mypy_cache"),
    FilePattern::Builtin(".nox"),
    FilePattern::Builtin(".pants.d"),
    FilePattern::Builtin(".pyenv"),
    FilePattern::Builtin(".pytest_cache"),
    FilePattern::Builtin(".pytype"),
    FilePattern::Builtin(".ruff_cache"),
    FilePattern::Builtin(".svn"),
    FilePattern::Builtin(".tox"),
    FilePattern::Builtin(".venv"),
    FilePattern::Builtin(".vscode"),
    FilePattern::Builtin("__pypackages__"),
    FilePattern::Builtin("_build"),
    FilePattern::Builtin("buck-out"),
    FilePattern::Builtin("dist"),
    FilePattern::Builtin("node_modules"),
    FilePattern::Builtin("site-packages"),
    FilePattern::Builtin("venv"),
];

We probably want at least the version control ones, maybe some of the others too.

[LiamPattinson]

I think --include is essentially the positional arguments, basically files?

I think it's just a way to put an inclusive filter on the file choices. If you set it to some subset of a project in ruff.toml (src/myproject/some_dir/*.py and then try linting some other non-overlapping subset (src/myproject/some_other_dir/) , it responds by saying no Python files were found. I'm not sure why it's an option in the config file but not on the command line though.

Should we add some default exclude values?

Yes, it's probably worth excluding things like .git and .vscode by default. Perhaps also build and _build, as I think that would work for 90% of fpm and Cmake users?

[LiamPattinson]

I've added a list of default exclude directories and tweaked the logic in get_files a bit to make sure the file patterns work as expected. I also got a few tests in, but fortitude/tests/check.rs is beginning to get a bit unwieldy.

I think that respecting .gitignore will require swapping out walkdir for the ignore crate and rewriting the get_files function accordingly. I think I'd prefer to leave that for its own PR.

[ZedThree]

Maybe instead this should be in docs/index.md?

Actually, looking at ruff, they have some tools for extracting portions of the README.md into the site docs. We should look at that at some point

[LiamPattinson]

For now, I've moved that section to the docs along with some other things from the README.

[ZedThree]

Oh, does --exclude not override the builtins?

[LiamPattinson]

From playing around with Ruff, apparently not, as it behaves as if the built-ins are a mandatory set of --extend-exclude instead of --exclude. If you want it to lint everything in your venv, you have to manually pass it venv/lib/Python3.10/site-packages, and setting your own exclude doesn't change this behaviour.

I haven't played around with include in a config file, so I'm not sure how that might affect it.

[ZedThree]

Lowest possible priority, but you meant this?

Suggested change

	// - Overwrite 'foo.f90' in config file, see 'base.f90' and 'foo.f90' but not 'bar.f90'
	// - Override 'foo.f90' in config file, see 'base.f90' and 'foo.f90' but not 'bar.f90'