Skip to content

chore(@embark/site): Add —template deprecation notice. #2079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2019
Merged

chore(@embark/site): Add —template deprecation notice. #2079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions dapps/templates/boilerplate/config/pipeline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
// https://github.com/embark-framework/embark-flow-template
// A new DApp can be created from that template with:
// embark new --template flow
// NOTE: the `--template` option is DEPRECATED in v5.

module.exports = {
typescript: false,
Expand All @@ -20,6 +21,7 @@ module.exports = {
// https://github.com/embark-framework/embark-typescript-template
// A new DApp can be created from that template with:
// embark new --template typescript
// NOTE: the `--template` option is DEPRECATED in v5.
enabled: true
// Setting `enabled: false` in this config will disable Embark's built-in Webpack
// pipeline. The developer will need to use a different frontend build tool, such as
Expand Down
2 changes: 2 additions & 0 deletions dapps/templates/demo/config/pipeline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
// https://github.com/embark-framework/embark-flow-template
// A new DApp can be created from that template with:
// embark new --template flow
// NOTE: the `--template` option is DEPRECATED in v5.

module.exports = {
typescript: false,
Expand All @@ -20,6 +21,7 @@ module.exports = {
// https://github.com/embark-framework/embark-typescript-template
// A new DApp can be created from that template with:
// embark new --template typescript
// NOTE: the `--template` option is DEPRECATED in v5.
enabled: true
// Setting `enabled: false` in this config will disable Embark's built-in Webpack
// pipeline. The developer will need to use a different frontend build tool, such as
Expand Down
59 changes: 32 additions & 27 deletions packages/embark/src/cmd/cmd.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class Cmd {

newApp() {

let validateName = function(value) {
let validateName = function (value) {
try {
if (value.match(/^[a-zA-Z\s-]+$/)) return value;
} catch (e) {
Expand All @@ -52,10 +52,14 @@ class Cmd {
.option('--simple', __('an alias for --contracts-only'))
.option('--contracts-only', __('create a barebones project meant only for contract development'))
.option('--locale [locale]', __('language to use (default: en)'))
.option('--template <name/url>', __('download a template using a known name or a git host URL'))
.action(function(name, options) {
.option('--template <name/url>', __('DEPRECATED download a template using a known name or a git host URL'))
.action(function (name, options) {
setOrDetectLocale(options.locale);

if (options.template) {
console.warn('--template has been deprecated and will be removed in future versions.');
}

if (options.contractsOnly && options.template) {
console.error('invalid: --contracts-only and --template options cannot be used together'.red);
process.exit(1);
Expand All @@ -68,7 +72,7 @@ class Cmd {
return promptly.prompt(__("Name your app (default is %s):", 'embarkDapp'), {
default: "embarkDApp",
validator: validateName
}, function(err, inputvalue) {
}, function (err, inputvalue) {
if (err) {
console.error(__('Invalid name') + ':', err.message);
// Manually call retry
Expand Down Expand Up @@ -97,15 +101,16 @@ class Cmd {
program
.command('demo')
.option('--locale [locale]', __('language to use (default: en)'))
.option('--template <name/url>', __('download a demo template using a known name or a git host URL'))
.option('--template <name/url>', __('[DEPRECATED] download a demo template using a known name or a git host URL'))
.description(__('create a working dapp with a SimpleStorage contract'))
.action(function(options) {
.action(function (options) {
setOrDetectLocale(options.locale);
if(options.template) {
if (options.template) {
const hostedGitInfo = require('hosted-git-info');
const hgi = hostedGitInfo.fromUrl(options.template);
const url = !hgi ? `embark-framework/embark-${options.template}-template#demo`:options.template;
const folderName = !hgi ? `embark_${options.template}_demo`:'template_demo';
const url = !hgi ? `embark-framework/embark-${options.template}-template#demo` : options.template;
const folderName = !hgi ? `embark_${options.template}_demo` : 'template_demo';
console.warn('--template has been deprecated and will be removed in future versions.');
embark.generateTemplate('demo', './', folderName, url);
} else {
embark.generateTemplate('demo', './', 'embark_demo');
Expand All @@ -123,7 +128,7 @@ class Cmd {
.option('--locale [locale]', __('language to use (default: en)'))
.option('--pipeline [pipeline]', __('webpack config to use (default: production)'))
.description(__('deploy and build dapp at ') + 'dist/ (default: development)')
.action(function(env, _options) {
.action(function (env, _options) {
setOrDetectLocale(_options.locale);
_options.env = env || 'development';
_options.logFile = _options.logfile; // fix casing
Expand All @@ -150,7 +155,7 @@ class Cmd {
.option('--pipeline [pipeline]', __('webpack config to use (default: development)'))
.option('--no-single-use-auth-token', __('disable the single use of token in cockpit'))
.description(__('run dapp (default: %s)', 'development'))
.action(function(env, options) {
.action(function (env, options) {
setOrDetectLocale(options.locale);
embark.run({
env: env || 'development',
Expand Down Expand Up @@ -179,7 +184,7 @@ class Cmd {
.option('--pipeline [pipeline]', __('webpack config to use (default: development)'))
.option('--no-single-use-auth-token', __('disable the single use of token in cockpit'))
.description(__('Start the Embark console'))
.action(function(env, options) {
.action(function (env, options) {
setOrDetectLocale(options.locale);
embark.console({
env: env || 'development',
Expand Down Expand Up @@ -209,7 +214,7 @@ class Cmd {
.option('--pipeline [pipeline]', __('webpack config to use (default: development)'))
.option('--no-single-use-auth-token', __('disable the single use of token in cockpit'))
.description(__('run dapp (default: %s)', 'development'))
.action(function(env, options) {
.action(function (env, options) {
setOrDetectLocale(options.locale);
embark.blockchain({
env: env || 'development',
Expand Down Expand Up @@ -240,7 +245,7 @@ class Cmd {
.option('-l, --gasLimit [gasLimit]', __('custom gas limit (default: %s)', '8000000'))
.option('--locale [locale]', __('language to use (default: en)'))

.action(function(env, options) {
.action(function (env, options) {
setOrDetectLocale(options.locale);
embark.initConfig(env || 'development', {
embarkConfig: 'embark.json',
Expand All @@ -261,9 +266,9 @@ class Cmd {
.command('test [file]')
.option('-e, --env <env>', __('configuration environment to use (default: test)'))
.option('-n , --node <node>', __('node for running the tests ["vm", "embark", <endpoint>] (default: vm)\n') +
' vm - ' + __('start and use an Ethereum simulator (ganache)') + '\n' +
' embark - ' + __('use the node of a running embark process') + '\n' +
' <endpoint> - ' + __('connect to and use the specified node'))
' vm - ' + __('start and use an Ethereum simulator (ganache)') + '\n' +
' embark - ' + __('use the node of a running embark process') + '\n' +
' <endpoint> - ' + __('connect to and use the specified node'))
.option('--gasDetails', __('print the gas cost for each contract deployment when running the tests. Deprecated: Please use --gas-details'))
.option('-d , --gas-details', __('print the gas cost for each contract deployment when running the tests'))
.option('-t , --tx-details', __('print the details of the transactions that happen during tests'))
Expand All @@ -272,7 +277,7 @@ class Cmd {
.option('--loglevel [loglevel]', __('level of logging to display') + ' ["error", "warn", "info", "debug", "trace"]', /^(error|warn|info|debug|trace)$/i, 'warn')
.option('--solc', __('run only solidity tests'))
.description(__('run tests'))
.action(function(file, options) {
.action(function (file, options) {
const node = options.node || 'vm';
const urlRegexExp = /^(vm|embark|((ws|https?):\/\/([a-zA-Z0-9_.-]*):?([0-9]*)?))$/i;
if (!urlRegexExp.test(node)) {
Expand Down Expand Up @@ -310,7 +315,7 @@ class Cmd {
.option('-c, --client [client]', __('Use a specific ethereum client [%s] (default: %s)', 'geth, parity', 'geth'))
.option('--pipeline [pipeline]', __('webpack config to use (default: production)'))
.description(__('Upload your dapp to a decentralized storage') + '.')
.action(function(env, _options) {
.action(function (env, _options) {
setOrDetectLocale(_options.locale);
if (env === "ipfs" || env === "swarm") {
console.warn(("did you mean " + "embark upload".bold + " ?").underline);
Expand All @@ -334,7 +339,7 @@ class Cmd {
.option('--locale [locale]', __('language to use (default: en)'))
.option('--output [svgfile]', __('filepath to output SVG graph to (default: %s)', diagramPath()))
.description(__('generates documentation based on the smart contracts configured'))
.action(function(env, options) {
.action(function (env, options) {
setOrDetectLocale(options.locale);
embark.graph({
env: env || 'development',
Expand All @@ -354,7 +359,7 @@ class Cmd {
.option('--contract-language <language>', 'Language used for the smart contract generation (default: solidity)')
.option('--overwrite', 'Overwrite existing files. (default: false)')
.description(__('Generates a contract and a function tester for you\nExample: ContractName field1:uint field2:address --contract-language solidity --framework react'))
.action(function(contractOrFile, fields, options) {
.action(function (contractOrFile, fields, options) {
setOrDetectLocale(options.locale);
options.env = 'development';
options.logFile = options.logfile; // fix casing
Expand All @@ -374,7 +379,7 @@ class Cmd {
.command('reset')
.option('--locale [locale]', __('language to use (default: en)'))
.description(__('resets embarks state on this dapp including clearing cache'))
.action(function(options) {
.action(function (options) {
setOrDetectLocale(options.locale);
embark.initConfig('development', {
embarkConfig: 'embark.json', interceptLogs: false
Expand All @@ -390,7 +395,7 @@ class Cmd {
.command('eject-build-config')
.alias('eject-webpack')
.description(__('copy the default build config into your dapp for customization'))
.action(function() {
.action(function () {
embark.initConfig('development', {
embarkConfig: 'embark.json',
interceptLogs: false
Expand All @@ -403,7 +408,7 @@ class Cmd {
program
.command('version')
.description(__('output the version number'))
.action(function() {
.action(function () {
console.log(embark.version);
process.exit(0);
});
Expand All @@ -413,7 +418,7 @@ class Cmd {
program
.command('help')
.description(__('output usage information and help information'))
.action(function() {
.action(function () {
console.log("Documentation can be found at: ".green + "https://embark.status.im/docs/".underline.green);
console.log("");
console.log("Have an issue? submit it here: ".green + "https://github.com/embark-framework/embark/issues/new".underline.green);
Expand All @@ -425,7 +430,7 @@ class Cmd {

otherCommands() {
program
.action(function(cmd) {
.action(function (cmd) {
console.log((__('unknown command') + ' "%s"').red, cmd);

let suggestion;
Expand All @@ -435,7 +440,7 @@ class Cmd {
// similar enough
suggestion = 'build --contracts';
} else {
const {proposeAlternative} = require('embark-utils');
const { proposeAlternative } = require('embark-utils');
let dictionary = ['new', 'demo', 'build', 'run', 'blockchain', 'simulator', 'test', 'upload', 'version', 'console', 'eject-webpack', 'graph', 'help', 'reset'];
suggestion = proposeAlternative(cmd, dictionary);
}
Expand Down
3 changes: 3 additions & 0 deletions site/source/_posts/2019-03-18-upgrading-to-embark-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,9 @@ embark new --template embark-react-dapp my-dapp
cd my-dapp
embark run
```
{% notification danger 'DEPRECATION NOTICE' %}
The `--template` option has been deprecated in v5 and support will be removed in future versions.
{% endnotification %}

Then, in another terminal,

Expand Down
3 changes: 3 additions & 0 deletions site/source/docs/create_project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ $ embark new <YourDappName>
```

## Creating apps from templates
{% notification danger 'DEPRECATION NOTICE' %}
The `--template` option has been deprecated in v5 and support will be removed in future versions.
{% endnotification %}

Another possible scenario to start from is taking advantage of a template. Embark [comes with templates](/templates) for various environments and frameworks, but you can also use any template created by the community. In order to create a new app from a template, use the `--template` option and either specify a supported template name, or a Git host URL.

Expand Down
8 changes: 5 additions & 3 deletions site/source/docs/embark_commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ Option | Description
--- | ---
`--contracts-only` | create a barebones project meant only for contract development
`--simple` | an alias for `--contracts-only`
`--template` | download a template using a known name or a git host URL
`--template` | **DEPRECATED IN v5** download a template using a known name or a git host URL

{% notification danger 'DEPRECATION NOTICE' %}
The `--template` option has been deprecated in v5 and support will be removed in future versions.
{% endnotification %}

The `--template` option supports several URL styles and shortcuts for git hosts:

Expand Down Expand Up @@ -47,8 +51,6 @@ A short name can be used for templates maintained in the Embark GitHub organizat
$ embark new --template typescript
```

Please see our list of [officially supported templates](/templates/).

## demo

```
Expand Down
5 changes: 3 additions & 2 deletions site/source/templates/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
layout: plugins
layout: templates
tagline: 'Pick one and start right away.'
title: Templates
data: templates
---
deprecationNotice: 'The <code>--template</code> option has been deprecated in v5 and support will be removed in future versions.'
---
37 changes: 37 additions & 0 deletions site/themes/embark/layout/templates.swig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{{
partial('partial/header', {
title: __(page.title),
tagline: __(page.tagline),
compact: true
})
}}
<main role="main">
{% if page.deprecationNotice %}
<section class="o-container o-distance">
{{
partial('partial/notification', {
type: 'danger',
title: 'DEPRECATION NOTICE',
text: page.deprecationNotice
})
}}
</section>
{% endif %}
<section class="o-container o-distance">
<div class="o-grid">
{% for plugin in site.data[page.data] %}
{{
partial('partial/whisperbox', {
className: 'o-grid__column--1-1 o-grid__column--large-1-3',
title: plugin.name,
text: __(plugin.description),
link: {
text: __('plugins_page.learn_more_link'),
href: plugin.link
}
})
}}
{% endfor %}
</div>
</section>
</main>