Name: cli-export-project
Owner: Dojo
Description: :rocket: Dojo 2 - A command which exports a project bundle
Created: 2017-04-20 12:45:14.0
Updated: 2018-05-01 16:50:22.0
Pushed: 2018-05-01 16:50:20.0
Homepage: null
Size: 229
Language: TypeScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
A command which exports a project bundle which can be used with the @dojo/web-editor and other tools.
WARNING This is alpha software. This is not yet production ready, so you should use at your own risk.
This command will create a JSON file which will contain all the necessary information about the current code to be
able to be loaded into the @dojo/web-editor. It is possible that it can be used with
other tools which can read the custom format.
The types for the file are located in interfaces/project.json.d.ts with the interface for the main file being ProjectJson.
To create a project export:
jo export project
rt project bundle
ported to "my-project.project.json"
This will export a file ending in .project.json which will be named after the name of your package in the package.json file.
There are several options that can be passed on the command line:
|Flag|Type|Description|
|—-|—-|———–|
|-c, --content|string|A comma seperated list of extentions of files to include in the project files. Defaults to "ts,html,css,json,xml,md".|
|-o, --out|string|The output path for the generated bundle. Defaults to the current working directory.|
|-p, --project|string|The path to the root of the project to bunde. Defaults to the current working directory.|
|-v, --verbose|flag|Provide verbose output when generating the editor bundle.|
|-h, --help|flag|Show help|
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
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 in node run:
grunt test
© 2017 JS Foundation & contributors. New BSD license.