-
Notifications
You must be signed in to change notification settings - Fork 518
Tool tasks
ljacqu edited this page Dec 17, 2016
·
6 revisions
Tool tasks are tasks that can be run from the AuthMe codebase for various purposes, e.g. to generate docs pages or to verify the completeness of translation files. All tool tasks are started from the same runner, the ToolsRunner, located under test/tools/ToolsRunner.java. Tip: you can save the run configuration for the ToolsRunner so that you can easily run a tool task at any time.
Once you start the ToolsRunner, a list of all available tools will be displayed. After entering the name the corresponding task will be run.
| Cat | Name | Description |
|---|---|---|
| 📎 | addJavaDocToMessageEnum | Adds a JavaDoc comment to each MessageKey entry with the according English message. |
| 📎 | checkTestMocks | Checks that test classes' @Mock fields correspond to the tested class' @Inject fields. |
| 📗 | createCommandPage | Updates the docs/commands.md page. |
| 📗 | describeHashAlgos | Updates the docs/hash_algorithms.md page. |
| 📎 | drawDependencyGraph | Generates AuthMe's dependency graph as .dot file - requires GraphWiz to render. |
| ✏️ | generateCommandsYml | Creates the commands.yml config file with default data. |
| ✏️ | generatePluginYml | Generates the plugin.yml with up-to-date command and permission info. |
| 📗 | updateConfigPage | Updates the docs/config.md page. |
| 📗 | updateDocs | Updates all files in the docs/ folder. |
| 📗 | updateTranslations | Updates the docs/translations.md page. |
| 🔦 | verifyHelpTranslations | Verifies all or a specific help translation file in resources/messages. |
| 🔦 | verifyMessages | Verifies all or a specific messages file in resources/messages. |
| 📗 | writePermissionsList | Updates the docs/permission_nodes.md page. |
| Icon | Category |
|---|---|
| 📗 | Docs/ page generation |
| 🔦 | Verification task |
| ✏️ | Project file udpate |
| 📎 | Technical task |