Upstream/AuthMeReloaded
1
0
Fork 0
mirror of https://github.com/AuthMe/AuthMeReloaded.git synced 2024-11-29 13:45:16 +01:00
Code Issues Projects Releases Wiki Activity

Add description & categorization for tasks

ljacqu 2016-12-17 13:12:14 +01:00
parent ceb4ab6878
commit 0a7ad01e73
1 changed files with 28 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Tool-tasks.md

@ -2,19 +2,31 @@ _Tool tasks_ are tasks that can be run from the AuthMe codebase for various purp
Once you start the ToolsRunner, a list of all available tools will be displayed. After entering the tool name the corresponding tool will be run. Once you start the ToolsRunner, a list of all available tools will be displayed. After entering the tool name the corresponding tool will be run.
### Available tasks _Tool tasks_ are tasks that can be run from the AuthMe codebase for various purposes, e.g. to generate docs pages or to verify messages tasks. All tool tasks are started from the same runner, the ToolsRunner, located test/tools/ToolsRunner.java. Tip: you can save the run configuration for the ToolsRunner so that you can always easily run a tool task.
Name | Description
---- | ----------------------------- Once you start the ToolsRunner, a list of all available tools will be displayed. After entering the tool name the corresponding tool will be run.
- addJavaDocToMessageEnum |
- checkTestMocks | ## Available tasks
- createCommandPage | Cat | Name | Description
- describeHashAlgos | ------------ | ----------------------- | -----------
- drawDependencyGraph | :paperclip: | addJavaDocToMessageEnum | Adds a JavaDoc comment to each MessageKey entry with the according English message.
- generateCommandsYml | :paperclip: | checkTestMocks | Checks that test classes' `@Mock` fields correspond to the tested class' `@Inject` fields.
- generatePluginYml | :green_book: | createCommandPage | Updates the docs/commands.md page.
- updateConfigPage | :green_book: | describeHashAlgos | Updates the docs/hash_algorithms.md page.
- updateDocs | :paperclip: | drawDependencyGraph | Generates AuthMe's dependency graph as .dot file - requires GraphWiz to render.
- updateTranslations | :pencil2: | generateCommandsYml | Creates the commands.yml config file with default data.
- verifyHelpTranslations | :pencil2: | generatePluginYml | Generates the plugin.yml with up-to-date command and permission info.
- verifyMessages | :green_book: | updateConfigPage | Updates the docs/config.md page.
- writePermissionsList | :green_book: | updateDocs | Updates all files in the docs/ folder.
:green_book: | updateTranslations | Updates the docs/translations.md page.
:flashlight: | verifyHelpTranslations | Verifies all or a specific help translation file in resources/messages.
:flashlight: | verifyMessages | Verifies all or a specific messages file in resources/messages.
:green_book: | writePermissionsList | Updates the docs/permission_nodes.md page.
### Categories
Icon | Category
------------ | --------
:green_book: | Docs/ page generation
:flashlight: | Verification task
:pencil2: | Project file udpate
:paperclip: | Technical task