#2128 ✓resolved
Robert Rettig

feature: help for module comannds like for core commands

Reported by Robert Rettig | May 29th, 2017 @ 12:06 PM | in 1.5.3 (closed)

Currently Play! does not allow to write command line documentation for module specific commands like documentation/commands/cmd-mymodule.txt
Assumption: A module mymodule was added to yabe ( c:\dev\tmp\test2\yabe ).

Resolving dependencies should result in something like this.

c:\dev\tmp\test2>play deps yabe --sync --clearcache  
~       modules/crud -> c:\dev\src\github.com\playframework\play1\modules\crud
~       modules/secure -> c:\dev\src\github.com\playframework\play1\modules\secure
~       modules/mymodule -> d:\play1-modules\mymodule

calling help should work like for any other play commands (it should be assumed 2. argument is application_path(abs/rel)).

c:\dev\tmp\test2>play help yabe  
~ For all commands, if the application is not specified, the current directory is used
~ Use 'play help cmd' to get more help on a specific command
~ Core commands:
~ ~~~~~~~~~~~~~~
~ antify          Create a build.xml file for this project
~ war             Export the application as a standalone WAR archive
~ Modules commands:
~ ~~~~~~~~~~~~~~~~~
~ crud:override       Override a view
~ mymodule:hello      test1
~ secure:             Show help for the secure module
~ secure:override     Override the CSS, login or layout
~ Also refer to documentation at https://www.playframework.com/documentation

A call for the specific command like the help intro tells `play help cmd should work.

c:\dev\tmp\test2>play help yabe mymodule:hello  
~        _            _
~  _ __ | | __ _ _  _| |
~ | '_ \| |/ _' | || |_|
~ |  __/|_|\____|\__ (_)
~ |_|            |__/
help text from mymodule ...

This must slugify the command mymodule:hello to find the correct file for display.
For example here a file d:\play1-modules\mymodule\documentation\commands\cmd-mymodulehello.txt should exist.

Comments and changes to this ticket

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

<h2>Play framework</h2>

Play makes it easier to build Web applications with Java. It is a clean alternative to bloated Enterprise Java stacks. It focuses on developer productivity and targets RESTful architectures. Learn more on the <a href="http://www.playframework.org">http://www.playframework.org</a> website.<br><br>

<h2>Source code is hosted on github</h2>Check out our repository at <a href="http://github.com/playframework/play">http://github.com/playframework/play</a><br><br>

<h2>Contributing, creating a patch</h2> Please read the <a href="http://play.lighthouseapp.com/projects/57987/contributor-guide">contributor guide</a><br><br>

<h2>Reporting Security Vulnerabilities</h2> Since all bug reports are public, please report any security vulnerability directly to <em>guillaume dot bort at gmail dot com</em>.<br><br>

<h2>Creating a bug report</h2> Bug reports are incredibly helpful, so take time to report bugs and request features in our ticket tracker. We’re always grateful for patches to Play’s code. Indeed, bug reports with attached patches will get fixed far quickly than those without any.<br><br>

Please include as much relevant information as possible including the exact framework version you're using and a code snippet that reproduces the problem.<br><br>

Don't have too much expectations. Unless the bug is really a serious "everything is broken" thing, you're creating a ticket to start a discussion. Having a patch (or a branch on Github we can pull from) is better, but then again we'll only pull high quality branches that make sense to be in the core of Play.