Implemented a config file for beman-tidy by AndreiDurlea · Pull Request #228 · bemanproject/beman-tidy

AndreiDurlea · 2026-02-15T14:10:06Z

#227
Initial implementation:

Load config with default name, .beman-tidy.yml, or config_path param.
In the config yaml content, the entry ignored_paths: is used specify paths of dirs or files. Dirs exclude all files and dirs in them. (behaves like gitignore)
Previously excluded dirs (.idea etc.) are now merged with this functionality in the ignores param found on get_*_files() functions.
introduced is_ignored() function in lib/utils/file.py to check if a given path is ignored

AndreiDurlea · 2026-02-15T14:59:31Z

@neatudarius when you're free, can you take a look at this PR?

Besides the commited changes, I'm also thinking about a slight design improvement. Instead of forbidding, at config level, the ignoring of files/dirs such as README.md, LICENSE etc., I propose that their individual checks simply throw errors if those files seem nonexistent and print out a log message if they actually exist but are ignored in the config. For example
README.md was found, but was explicitly ignored in the config file (.beman-tidy.yml). Make sure it is visible to beman-tidy to pass this check and other related checks.

I can easily implement something like this for any check that requires files to be present - that means modifying those checks to

Check in non-ignored files first
If some required file is not found, check the ignored stuff, just in case, and print out something useful (example above) if the mandatory file was ignored.

This would allow users to check for other issues while keeping something temporarily ignored for their own reasons.

And then I'd simply remove mandatory_files from config.py. Let me know if this design sounds ok

and reversal of unnecessary logging changes

…reiDurlea/beman-tidy into origin/andreidurlea-issue227

neatudarius

Initial round of review

neatudarius · 2026-02-16T06:41:54Z

docs/dev-guide.md

 * `tests/`: Unit tests for the tool.
  * Structure is similar to the `beman_tidy/` directory.
  * `pytest` is used for testing.
+* `.beman-tidy.yml`: Configuration file for `beman-tidy` (optional).


Move it where ls -l says!

Should we first load default deployed beman_tidy/.beman-tidy.yml, and apply user file repo/path/.beman-tidy.yml over it? Aka should we provide a default .beman-tidy.yml near .beman-standard.yml? Right now it will be an empty config, but maybe we can add something in the future.

What do you think?

That sounds like better design. Will work on implementing it 👍🏻

Done! Is it ok?

neatudarius · 2026-02-16T06:42:39Z

beman_tidy/lib/checks/base/file_base_check.py

    """

    def __init__(self, repo_info, beman_standard_check_config, relative_path, name=None):
+        self.repo_info = repo_info


Check super().__init__(repo_info, beman_standard_check_config, name=name). It is doing what you need, right?

Okay so, after some investigative work:

repo_info is (was) not available at init

when I implemented should_skip() which calls get_ignroes(self.repo_info)which requires, of course, repo_info, a crash would happen

I half-fixed that problem by just setting repo_info myself

I'm now working on a bugfix regarding this issue, by changing when some params are intialized in base_check's constructor. Should I open a separate issue and do this in a separate pull request @neatudarius? Or is it fine to do this here.

I still don't understand why current status from main is not enough?

repo info is set in super here : https://github.com/bemanproject/beman-tidy/blob/main/beman_tidy/lib/checks/base/base_check.py#L79

path is et at this line https://github.com/bemanproject/beman-tidy/pull/228/changes#diff-f79f15f4db56c998457771c1b845d1d6c2c41ab811a221e46a86a7db7a2c1faaR24. if you still need relative_path, sure, add self.relative_path = Path(relative_path) at line 23.

TLDR: first line in any class that is derived needs to be called to super!

I managed to implement it so the first line is the super's constructor. See the changes here.

I initially didn't keep the constructor first because it needed should_skip() to set log_level. and my should_skip() needed properties that were not yet initialized (repo_info, relative_path) to find out if the check if for ignored paths. So I initialized them before the construcgtor and called it a day=)

Basically,
constructor -> log_level -> should_skip() -> stuff in the constructor.

So i made log_level be lazily initialized.

repo_info was easy to fix, as I just made sure it was initialized before log_level in the constructor. But relative_path was not intiliazed in the constructor at all, and, as you said, the constructor should be the first thing called, hence the lazy initialization required for anything that uses should_skip() (in this case log_level

This issue had me use more brainpower than I expected I'd need for it =)))

beman_tidy/lib/checks/base/file_base_check.py

Co-Authored-By: Darius Neațu <neatudarius@gmail.com>

This reverts commit 2a9b530.

Co-Authored-By: Darius Neațu <neatudarius@gmail.com>

AndreiDurlea · 2026-02-16T11:59:22Z

@neatudarius I applied your changes, ready for another round of review.
Mention: I'm working on the deeper bugfix to remove the temporary fix provided by L19 in file_base_check.py. Awaiting your response in the comment thread on that line.

README.md

beman_tidy/.beman-tidy.yml

neatudarius · 2026-02-19T11:34:46Z

beman_tidy/lib/checks/base/file_base_check.py

    """

    def __init__(self, repo_info, beman_standard_check_config, relative_path, name=None):
+        self.repo_info = repo_info


I still don't understand why current status from main is not enough?

repo info is set in super here : https://github.com/bemanproject/beman-tidy/blob/main/beman_tidy/lib/checks/base/base_check.py#L79

path is et at this line https://github.com/bemanproject/beman-tidy/pull/228/changes#diff-f79f15f4db56c998457771c1b845d1d6c2c41ab811a221e46a86a7db7a2c1faaR24. if you still need relative_path, sure, add self.relative_path = Path(relative_path) at line 23.

TLDR: first line in any class that is derived needs to be called to super!

Laziliy initialized it because it calls should_skip() which needs stuff that is not init'd before / in the constructor. And the constructor should be the first thing called Rabbit hole development =)

to match clang-tidy docs style

AndreiDurlea · 2026-02-19T22:25:15Z

@neatudarius ready for a re-review

neatudarius · 2026-02-23T20:42:12Z

beman_tidy/lib/checks/base/directory_base_check.py

+        """
+        if super().should_skip():
+            return True
+        return is_ignored(self.repo_info, self.relative_path)


neatudarius · 2026-02-23T20:44:39Z

beman_tidy/lib/utils/config.py

+    Load the configuration file.
+    """
+    # Load default configuration
+    default_config_path = files('beman_tidy').joinpath('.beman-tidy.yml')


This is not good practice. Do you want something like https://github.com/bemanproject/beman-tidy/blob/main/beman_tidy/lib/utils/git.py#L125?

Alright I get why, I'll implement that. I initially thought having that .parent.parent.parent structure would be prone to errors (for example if the file gets moved), but I suppose that's an okay compromise

Please test the installed tool. Does it work in your approach?

It did run on exemplar, but, for the sake of consistency, I'll refactor to what is also used for beman-standard.yml. I dont see my file moving in the near future but, to be sure, I wrapped getting the path in a different function that will be sure to pop in someones eyes, should they want to move that file. Mental gymnastics here trying to prevent future bugs :)

Done! @neatudarius is ok?

To be consistent with `beman-standard.yml`

AndreiDurlea · 2026-02-23T23:32:29Z

@neatudarius yet again ready for a re-review

AndreiDurlea added 5 commits February 15, 2026 16:06

Added config file functionality

721eac1

Added config file functionality

b7ab09e

Docs for config file

c970fb7

Tests for config file

f57c729

Removed unused imports and fixed linter issues

42a5aa6

AndreiDurlea force-pushed the origin/andreidurlea-issue227 branch from 8d1a86c to 42a5aa6 Compare February 15, 2026 14:58

AndreiDurlea added 8 commits February 15, 2026 18:11

Minor refactoring

00af02d

and reversal of unnecessary logging changes

Minor refactoring

40bcfbe

and reversal of unnecessary logging changes

Merge branch 'origin/andreidurlea-issue227' of https://github.com/And…

a009d4a

…reiDurlea/beman-tidy into origin/andreidurlea-issue227

Minor logging bugfix

7474c64

Added config ignoring support for individual file checks

42d6ae6

Implemented get_ignores() for modularity

c95952c

Missing argument pass fix

fc08bdf

Missing argument

dee1a63

AndreiDurlea changed the title ~~Config file for beman-tidy~~ Implemented a config file for beman-tidy Feb 15, 2026

Merge branch 'origin/andreidurlea-issue227' of https://github.com/And…

c89a623

…reiDurlea/beman-tidy into origin/andreidurlea-issue227

AndreiDurlea force-pushed the origin/andreidurlea-issue227 branch from cff2eb3 to c89a623 Compare February 15, 2026 23:47

neatudarius reviewed Feb 16, 2026

View reviewed changes

AndreiDurlea and others added 6 commits February 16, 2026 13:02

Added default config in beman_tidy/beman-tidy.yml

54ca7c6

Updated user config tests

e5d79da

Removed unnecessary param set

2a9b530

Co-Authored-By: Darius Neațu <neatudarius@gmail.com>

Revert "Removed unnecessary param set"

0702755

This reverts commit 2a9b530.

Readability fixes

a5da1f3

Co-Authored-By: Darius Neațu <neatudarius@gmail.com>

Updated beman-tidy config file docs

bc99576

neatudarius requested changes Feb 19, 2026

View reviewed changes

AndreiDurlea added 3 commits February 19, 2026 23:16

Laziliy initialized log_level in base_check

70c3d6e

Laziliy initialized it because it calls should_skip() which needs stuff that is not init'd before / in the constructor. And the constructor should be the first thing called Rabbit hole development =)

Implemented ignoring paths via config file for directory checks

5cc4064

Modularized is_ignored() logic

e63228a

AndreiDurlea and others added 3 commits February 19, 2026 23:23

Added SPDX License Identifier

08a8d9e

Merge branch 'main' into origin/andreidurlea-issue227

7872b1a

Laziliy initialized log_level in base_check

96abdb0

AndreiDurlea force-pushed the origin/andreidurlea-issue227 branch from 22d8e39 to 96abdb0 Compare February 19, 2026 21:59

AndreiDurlea added 3 commits February 20, 2026 00:15

Updated ignore logic

af28b21

Added better config ignored_paths examples

dca19c1

Updated config file docs style

b13dd9d

to match clang-tidy docs style

neatudarius reviewed Feb 23, 2026

View reviewed changes

Changed how getting a path is done

b8cb760

To be consistent with `beman-standard.yml`

AndreiDurlea force-pushed the origin/andreidurlea-issue227 branch from 5e973e4 to b8cb760 Compare February 23, 2026 23:26

Conversation

AndreiDurlea commented Feb 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AndreiDurlea commented Feb 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neatudarius left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreiDurlea Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreiDurlea Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreiDurlea Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AndreiDurlea commented Feb 16, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreiDurlea commented Feb 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreiDurlea Feb 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AndreiDurlea commented Feb 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

AndreiDurlea commented Feb 15, 2026 •

edited

Loading

AndreiDurlea commented Feb 15, 2026 •

edited

Loading

AndreiDurlea Feb 16, 2026 •

edited

Loading

AndreiDurlea Feb 16, 2026 •

edited

Loading

AndreiDurlea Feb 19, 2026 •

edited

Loading

AndreiDurlea Feb 23, 2026 •

edited

Loading