Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Activate improvements #345

Merged
merged 10 commits into from
Aug 11, 2022
Merged

Activate improvements #345

merged 10 commits into from
Aug 11, 2022

Conversation

bjoernricks
Copy link
Contributor

@bjoernricks bjoernricks commented Aug 9, 2022

What:

Improve installation, setup and usage of autohooks activate by writing the settings to the pyproject.toml file.
With this change the user doesn't need to change the pyproject.toml file manually during the setup.

Why:

Make the setup easier.

How:

Checklist:

  • Tests
  • PR merge commit message adjusted
  • Documentation

The settigs contain the mode and the list of activated plugin modules.
The class allows to write the mode and plugins to a toml file like the
pyproject.toml.
The argument modestring is actuallly optional.
The method is the same as has_autohooks_config.
Move checking for an existing and determining the path to the projects
pyproject.toml file into the load_config_from_pyproject_toml function
and generalize the AutohooksConfig method to be independent of the
pyproject.toml.
The BaseToolConfig was only used in the AutohooksConfig class. Therefore
there is no need for a class hierarchy. While merging remove the
has_config method which was only used in tests.
Currently this method just shadows the constructor but this will change
in additional commits.
Using the AutohooksSettings makes the class simpler.
Make the installation and usage of autohooks much easier by not having
to edit the pyproject toml config file manually.

If there is no settings for autohooks or changes are forced autohooks
activate will write the settings to the pyproject.toml file.
@bjoernricks bjoernricks requested a review from a team as a code owner August 9, 2022 08:47
@codecov
Copy link

codecov bot commented Aug 9, 2022

Codecov Report

Merging #345 (4cbe779) into main (4220c1c) will increase coverage by 0.47%.
The diff coverage is 94.02%.

@@            Coverage Diff             @@
##             main     #345      +/-   ##
==========================================
+ Coverage   87.69%   88.16%   +0.47%     
==========================================
  Files          13       13              
  Lines         577      600      +23     
==========================================
+ Hits          506      529      +23     
  Misses         71       71              
Impacted Files Coverage Δ
autohooks/config.py 92.85% <88.23%> (-0.48%) ⬇️
autohooks/cli/activate.py 100.00% <100.00%> (ø)
autohooks/cli/check.py 100.00% <100.00%> (ø)
autohooks/settings.py 100.00% <100.00%> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@bjoernricks bjoernricks merged commit 5f352a8 into main Aug 11, 2022
@bjoernricks bjoernricks deleted the activate-improvements branch August 11, 2022 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants