Commands.md

Commands for roc-package-web-component-dev

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

Commands

• development
  • build
  • clean
  • dev
• meta
  • docs
  • list-settings

development

Project development

roc development <command>

Commands for development purposes.

build

Used to build the current project.

roc development build [targets]

Arguments

Name	Description	Default	Type	Required	Can be empty
targets	The targets the project should be built for, overrides the settings if provided.		`Array(/^web$	^cjs$	^esm$/)`

Settings options

• build

Defined by extensions

roc-abstract-package-base-dev, roc-package-module-dev, roc-package-webpack-dev, roc-package-web-component-dev

clean

Cleans the current project.

roc development clean

Settings options

• build

Defined by extensions

roc-abstract-package-base-dev

dev

Used to start the current project in development mode.

roc development dev

Will start a demo server that will load the component.

By default an internal template will be used but it can easily be changed. Important to note when changing the template is that http://mozilla.github.io/nunjucks/ is used.

Two template variables is available:

name        The name of the project, can be used to display <title> and run a JavaScript function.
bundlePath  The bundle path, used to add the script to the template.

Settings options

• build
• dev

Defined by extensions

roc-abstract-package-base-dev, roc-package-module-dev, roc-package-webpack-dev, roc-package-web-component-dev

meta

Meta commands

roc meta <command>

Meta commands that can be used to generate meta data about the current project.

docs

Generates documentation for the current project.

roc meta docs

Command options

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

Defined by extensions

roc

list-settings

Prints all the available settings that can be changed.

roc meta list-settings

Defined by extensions

roc