Name: cli-create-widget
Owner: Dojo
Description: Dojo 2 - cli command for creating widgets boilerplate.
Created: 2017-08-15 08:22:50.0
Updated: 2018-05-02 16:08:56.0
Pushed: 2018-05-02 16:08:55.0
Homepage: null
Size: 680
Language: TypeScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
A Dojo CLI command that creates a Dojo 2 widget template with an optional custom element descriptor.
To use @dojo/cli-create-widget
, install the project globally along side dojo cli
:
install -g @dojo/cli-create-widget
Run using:
create [widget] --name <widget name> --styles <CSS path> --tests <test path>
@dojo/cli-create-widget
generates an opinionated skeleton component structure for use within a Dojo 2 application. The location where styles and tests are created can be customized using the --styles
and --tests
arguments respectively. By default, the following folder structure will be created:
mponent.ts
es/
es/myComponent.m.css
es/myComponent.m.css.d.ts,
s/unit/MyComponent.ts
It's also possible to generate a Custom Element descriptor by passing the --component
boolean argument. This will generate a widget that includes the @customElement
decorator with an empty template object ready for configuration, please see the @dojo/widget-core
readme for more information.
We appreciate your interest! Please see the Dojo 2 Meta Repository for the Contributing Guidelines.
This repository uses prettier
for code styling rules and formatting. A pre-commit hook is installed automatically and configured to run prettier
against all staged files as per the configuration in the projects package.json
.
An additional npm script to run prettier
(with write set to true
) against all src
and test
project files is available by running:
run prettier
To start working with this package, clone the repository and run npm install
.
In order to build the project run grunt dev
or grunt dist
.
Test cases MUST be written using Intern using the Object test interface and Assert assertion interface.
90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul?s combined coverage results for all supported platforms.
To test locally run:
grunt test
© 2018 JS Foundation. New BSD license.