Commands for roc

October 14, 2016 · View on GitHub

General Information

All commands can be called with some additional options illustrated in the table below.

General options

Name	Description	Required
-b, --better-feedback	Enables source-map-support and loud-rejection.	No
-c, --config	Path to configuration file.	No
-d, --directory	Path to working directory.	No
-h, --help	Output usage information.	No
-V, --verbose	Enable verbose mode.	No
-v, --version	Output version number.	No

create

Project creation

roc create <command>

Commands that can be used to create new projects.

init

Init a new project.

roc create init [template] [version]

The init command can be used to initiate a new Roc project and currently expects that it is run inside an empty directory. As shown above it takes two optional arguments, template and version. If no template is given a prompt will be displayed with the possible alternatives that exist. Currently these alternatives are coded into Roc and matches web-app and web-app-react.

template Template can either be a short name for a specific template, currently it accepts web-app and web-app-react that will be converted internally to rocjs/roc-template-web-app and rocjs/roc-template-web-app-react. The actual template reference is a GitHub repo and can be anything matching that pattern USERNAME/PROJECT.

The template can also point to a local zip file (ending in .zip) of a template repository. This is useful if the template is in a private repo or not available on GitHub.

It will also expect that the template has a folder named template that contains a package.json file with at least one dependency to a Roc package following the pattern roc-package-* or that it has a roc.config.js file (this file is then expected to have some packages defined but this is not checked immediately).

version Versions should match a tag on the GitHub repo and will default to master if none exists. When providing an input on the command line Roc will automatically add v in front of versions that starts with a number to match GitHub default conventions that have version tags that start with v like v1.0.0. master is also always available as an option.

Arguments

Name	Description	Default	Type	Required	Can be empty
template	The template to use.		`Filepath`	No	No
version	The version of the template to use.		`String`	No	No

Command options

Name	Description	Type	Required
--clone	If git clone should be used when downloading the template.	`Boolean`	No
-f, --force	Ignore non empty directory warning.	`Boolean`	No
-l, --list-versions	List the available versions of a template.	`Boolean`	No

Defined by extensions

roc

new

Create a new project.

roc create new <name> [template] [version]

Alias for "init" that always will try to create a new directory.

Arguments

Name	Description	Type	Required	Can be empty
name	Name for a new directory to create the project in.	`String`	Yes	No
template	The template to use.	`Filepath`	No	No
version	The version of the template to use.	`String`	No	No

Command options

Name	Description	Type	Required
--clone	If git clone should be used when downloading the template.	`Boolean`	No
-f, --force	Ignore non empty directory warning.	`Boolean`	No
-l, --list-versions	List the available versions of a template.	`Boolean`	No

Defined by extensions

roc

Name	Description	Default	Type	Required	Can be empty
--html	If HTML should be generated. (Not supported yet)	`false`	`Boolean`	No
--markdown	If markdown should be generated.	`true`	`Boolean`	No
--mode	The platform that is to be used, for link generation.	`"github.com"`	`/github.com	nodejs.org	bitbucket.org
--output	A directory to place the generated documentation inside of.	`"docs"`	`String`	No	No
--project	If the projects configuration and actions should be included.	`false`	`Boolean`	No