feat: expose AutoFirma configuration via HM module #67
+247
−7
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These changes implement a new `programs.autofirma.config` submodule to configure AutoFirma via Home Manager. To achieve this in an automated way, several new components are in place: - **XMLDoclet**: A Java plugin included in `pom.xml` to export Javadoc in XML format. - **properties-to-json**: A custom Python script that combines the information from the aforementioned Javadoc and a properties file present in the source code. This file contains the parameters that can be set in the AutoFirma configuration. During the compilation process, the Javadoc is generated and then transformed into a JSON file containing a list of configuration settings with their default values and descriptions. The Home Manager module reads this JSON file and builds the `config` submodule. If the user modifies any of the values under `config`, a configuration file is generated and linked to the path that AutoFirma expects. To prevent AutoFirma from overwriting the configuration (which happens every time the configuration dialog is opened), the directory containing the link has its permissions modified to forbid the user from writing.
|
At the moment, the compilation process has been downgraded to Luckily, a new contribution is changing that situation; see here: manticore-projects/xml-doclet#2 As soon as we can update the doclet to work on an up-to-date JDK, I'll remove the draft status of this PR for review. Tracking XMLDoclet issue: manticore-projects/xml-doclet#3 |
nilp0inter
force-pushed
the
feature/autofirma-hm-config
branch
2 times, most recently
from
ac3ba91 to
419eb86
Compare
2 tasks
nilp0inter
force-pushed
the
feature/autofirma-hm-config
branch
from
419eb86 to
7f19498
Compare
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These changes implement a new
programs.autofirma.configsubmodule to configure AutoFirma via Home Manager.To achieve this in an automated way, several new components are in place:
pom.xmlto export Javadoc in XML format.During the compilation process, the Javadoc is generated and then transformed into a JSON file containing a list of configuration settings with their default values and descriptions.
The Home Manager module reads this JSON file and builds the
configsubmodule.If the user modifies any of the values under
config, a configuration file is generated and linked to the path that AutoFirma expects. To prevent AutoFirma from overwriting the configuration (which happens every time the configuration dialog is opened), the directory containing the link has its permissions modified to forbid the user from writing.