-
-
-oclif: Node.JS Open CLI Framework
-=================================
-
-[](https://gitter.im/oclif/oclif?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[](https://npmjs.org/package/oclif)
-[](https://circleci.com/gh/oclif/oclif/tree/master)
-[](https://ci.appveyor.com/project/heroku/oclif/branch/master)
-[](https://greenkeeper.io/)
-[](https://snyk.io/test/github/oclif/oclif)
-[](https://npmjs.org/package/oclif)
-[](https://github.com/oclif/oclif/blob/master/package.json)
-
+Salesforce Plugin Generator (Beta)
+==================
-* [๐ Description](#-description)
-* [๐ Getting Started Tutorial](#-getting-started-tutorial)
-* [โจ Features](#-features)
-* [๐ Requirements](#-requirements)
-* [๐ CLI Types](#-cli-types)
-* [๐ Usage](#-usage)
-* [๐ Examples](#-examples)
-* [๐จ Commands](#-commands)
-* [๐ญ Related Repositories](#-related-repositories)
-* [๐ฆ Learn More](#-learn-more)
-* [๐ฃ Feedback](#-feedback)
+* [Description](#description)
+* [Usage](#usage)
+* [Salesforce CLI Plugin Development ](#salesforce-cli-plugin-development)
+* [Plugin Generator Development](#plugin-generator-development)
+* [Related Docs and Repositories](#related-docs-and-repositories)
-# ๐ Description
-
-This is a framework for building CLIs in Node.js. This framework was built out of the [Heroku CLI](https://cli.heroku.com) but generalized to build any custom CLI. It's designed both for simple CLIs that can be just a single file with a few flag options, or for very complex CLIs that have subcommands (like git or heroku).
+# Description
-[See the docs for more information](http://oclif.io/docs/introduction.html).
-
-# ๐ Getting Started Tutorial
-
-The [Getting Started tutorial](http://oclif.io/docs/introduction.html) is a step-by-step guide to introduce you to oclif. If you have not developed anything in a command line before, this tutorial is a great place to get started.
-
-# โจ Features
-
-* **Flag/Argument parsing** - No CLI framework would be complete without a flag parser. We've built a custom one from years of experimentation that we feel consistently handles user input flexible enough for the user to be able to easily use the CLI in ways they expect, but without comprisiming strictness guarantees to the developer.
-* **Super Speed** - The overhead for running an oclif CLI command is almost nothing. [It requires very few dependencies](https://www.npmjs.com/package/@oclif/command?activeTab=dependencies). Also, only the command to be executed will be required with node. So large CLIs with many commands will load just as fast as a small one with a single command.
-* **CLI Generator** - Run a single command to scaffold out a fully functional CLI and get started quickly. See [Usage](#-usage) below.
-* **Testing Helpers** - We've put a lot of work into making commands easily testable and easy to mock out stdout/stderr. The generator will automatically create [scaffolded tests](https://github.com/oclif/example-multi-ts/blob/master/test/commands/hello.test.ts).
-* **Auto-documentation** - By default you can pass `--help` to the CLI to get help such as flag options and argument information. This information is also automatically placed in the README whenever the npm package of the CLI is published. See the [multi-command CLI example](https://github.com/oclif/example-multi-ts)
-* **Plugins** - Using [plugins](https://oclif.io/docs/plugins.html), users of the CLI can extend it with new functionality, a CLI can be split into modular components, and functionality can be shared amongst multiple CLIs. See [Building your own plugin](https://oclif.io/docs/plugins.html#building-your-own-plugin).
-* **Hooks** - Use lifecycle hooks to run functionality any time a CLI starts, or on custom triggers. Use this whenever custom functionality needs to be shared between various components of the CLI.
-* **TypeScript (or not)** - Everything in the core of oclif is written in TypeScript and the generator can build fully configured TypeScript CLIs or just plain JavaScript CLIs. By virtue of static properties in TypeScript the syntax is a bit cleaner in TypeScriptโbut everything will work no matter which language you choose. If you use plugins support, the CLI will automatically use `ts-node` to run the plugins making it easy and fast to use TypeScript with minimal-to-no boilerplate needed for any oclif CLI.
-* **Everything is Customizable** - Pretty much anything can be swapped out and replaced inside oclif if neededโincluding the arg/flag parser.
-* **Coming soon: man pages** - In addition to in-CLI help through `--help` and the README markdown help generation, the CLI can also automatically create man pages for all of its commands.
-* **Coming soon: Autocomplete** - Automatically include autocomplete for your CLI. This includes not just command names and flag names, but flag values as well. For example, it's easy to configure the Heroku CLI to have completions for Heroku app names:
-
-```
-$ heroku info --app=
+Congrats, you are now debugging!
+
+# Plugin Generator Development
+To make changes to the plugin generator, follow these instructions.
+=======
+
+Note: Only Node 8+ is supported. If you are new to Node.js, use nvm to install node.
+
+1. Start by cloning the repo.
+ ```sh-session
+ $ git clone TODO:update-with-repo
+ ```
+2. Change directories into the cloned repo.
+ ```sh-session
+ $ cd TODO:update-with-repo-name
+ ```
+3. If you don't have Node.js version 8 or above installed, install it now.
+ ```sh-session
+ $ nvm install v8.9.4
+ ```
+4. Install the Yarn package manager.
+ ```sh-session
+ $ npm install -g yarn
+ ```
+5. Install the plugin generator.
+ ```sh-session
+ $ yarn install
+ ```
+6. Compile the TypeScript code.
+ ```sh-session
+ $ yarn run build
+ ```
+7. Now you are ready to run the plugins:generate command and make any changes to the generator.
+ ```sh-session
+ $ bin/run plugins:generate yourPluginName
+ ```
+
+# Related Docs and Repositories
+* [salesforcedx/sfdx-command](TODO:add-link) - Base Salesforce CLI command
+* [salesforcedx/sfdx-core](TODO:add-link) - Helper API for working with a Salesforce DX project and managing Salesforce orgs
+* [@oclif/command](https://github.com/oclif/command) - Base command for oclif; this can be used directly without the generator
+* [@oclif/config](https://github.com/oclif/config) - Most of the core setup for oclif lives here
+* [@oclif/errors](https://github.com/oclif/errors) - Renders and logs errors from commands
+* [@oclif/cli-ux](https://github.com/oclif/cli-ux) - Library for common CLI UI utilities
+* [@oclif/test](https://github.com/oclif/test) - Test helper for oclif
\ No newline at end of file
diff --git a/package.json b/package.json
index 77684df..1a2d99e 100644
--- a/package.json
+++ b/package.json
@@ -1,10 +1,10 @@
{
- "name": "oclif",
- "description": "oclif: create your own CLI",
- "version": "1.7.13",
- "author": "Jeff Dickey @jdxcode",
+ "name": "@salesforce/plugin-generator",
+ "description": "create your own sfdx plugin",
+ "version": "0.0.5",
+ "author": "ALM - CI",
"bin": "./bin/run",
- "bugs": "https://github.com/oclif/oclif/issues",
+ "bugs": "",
"dependencies": {
"@oclif/command": "^1.4.6",
"@oclif/config": "^1.3.61",
@@ -52,9 +52,10 @@
".oclif.manifest.json",
"/bin",
"/lib",
- "/templates"
+ "/templates",
+ "/messages"
],
- "homepage": "https://github.com/oclif/oclif",
+ "homepage": "",
"keywords": [
"oclif"
],
@@ -75,6 +76,7 @@
"lint": "nps lint",
"postpublish": "rm .oclif.manifest.json",
"posttest": "yarn run lint",
+ "prepack": "oclif-dev manifest",
"prepublishOnly": "yarn run build && oclif-dev manifest",
"version": "oclif-dev readme && oclif-dev manifest && git add README.md",
"test": "nps test"
diff --git a/sfdx-ci.yaml b/sfdx-ci.yaml
new file mode 100644
index 0000000..1900089
--- /dev/null
+++ b/sfdx-ci.yaml
@@ -0,0 +1,4 @@
+jobs:
+ - name: publish
+ skipTests: true
+ - name: promote
diff --git a/src/command_base.ts b/src/command_base.ts
index ec9491b..27e3fe7 100644
--- a/src/command_base.ts
+++ b/src/command_base.ts
@@ -7,11 +7,11 @@ export default abstract class CommandBase extends Command {
env.register(
require.resolve(`./generators/${type}`),
- `oclif:${type}`
+ `sfdx:${type}`
)
await new Promise((resolve, reject) => {
- env.run(`oclif:${type}`, generatorOptions, (err: Error, results: any) => {
+ env.run(`sfdx:${type}`, generatorOptions, (err: Error, results: any) => {
if (err) reject(err)
else resolve(results)
})
diff --git a/src/commands/command.ts b/src/commands/command.ts
index 9f78b4b..f824d47 100644
--- a/src/commands/command.ts
+++ b/src/commands/command.ts
@@ -9,6 +9,7 @@ export interface Options {
}
export default abstract class AppCommand extends Base {
+ static hidden = true
static description = 'add a command to an existing CLI or plugin'
static flags = {
diff --git a/src/commands/multi.ts b/src/commands/multi.ts
index 759a1bd..144265f 100644
--- a/src/commands/multi.ts
+++ b/src/commands/multi.ts
@@ -1,6 +1,7 @@
import AppCommand from '../app_command'
export default class extends AppCommand {
+ static hidden = true
static description = 'generate a new multi-command CLI'
type = 'multi'
}
diff --git a/src/commands/plugin.ts b/src/commands/plugin.ts
index 7d55a9f..51cdbcd 100644
--- a/src/commands/plugin.ts
+++ b/src/commands/plugin.ts
@@ -1,6 +1,7 @@
import AppCommand from '../app_command'
export default class extends AppCommand {
+ static hidden = true
static description = 'create a new CLI plugin'
type = 'plugin'
}
diff --git a/src/commands/plugins/generate.ts b/src/commands/plugins/generate.ts
new file mode 100644
index 0000000..cfd08c3
--- /dev/null
+++ b/src/commands/plugins/generate.ts
@@ -0,0 +1,28 @@
+import Base from '../../command_base'
+import {flags} from '@oclif/command'
+
+export default class Generate extends Base {
+ static flags = {
+ defaults: flags.boolean({description: 'use defaults for every setting'}),
+ force: flags.boolean({description: 'overwrite existing files'}),
+ }
+
+ static args = [
+ {name: 'path', required: false}
+ ]
+
+ static description = 'create a new sfdx-cli plugin'
+ type = 'sfdx-plugin'
+
+ async run() {
+ const {flags, args} = this.parse(Generate)
+
+ await super.generate('app', {
+ type: this.type,
+ path: args.path,
+ defaults: flags.defaults,
+ force: flags.force,
+ options: []
+ })
+ }
+}
diff --git a/src/commands/single.ts b/src/commands/single.ts
index 0a5e6f6..bc05cca 100644
--- a/src/commands/single.ts
+++ b/src/commands/single.ts
@@ -1,6 +1,7 @@
import AppCommand from '../app_command'
export default class extends AppCommand {
+ static hidden = true
static description = 'generate a new single-command CLI'
type = 'single'
}
diff --git a/src/generators/app.ts b/src/generators/app.ts
index ebb2dd2..7206856 100644
--- a/src/generators/app.ts
+++ b/src/generators/app.ts
@@ -43,7 +43,7 @@ class App extends Generator {
yarn: boolean
}
args!: {[k: string]: string}
- type: 'single' | 'multi' | 'plugin' | 'base'
+ type: 'single' | 'multi' | 'plugin' | 'base' | 'sfdx-plugin'
path: string
pjson: any
githubUser: string | undefined
@@ -102,6 +102,9 @@ class App extends Generator {
case 'multi':
msg = 'Time to build a multi-command CLI with oclif!'
break
+ case 'sfdx-plugin':
+ msg = 'Time to build an sfdx-cli plugin!'
+ break
default:
msg = `Time to build a oclif ${this.type}!`
}
@@ -223,6 +226,7 @@ class App extends Generator {
{name: 'semantic-release (automated version management)', value: 'semantic-release', checked: this.options['semantic-release']}
],
filter: ((arr: string[]) => _.keyBy(arr)) as any,
+ when: this.type !== 'sfdx-plugin'
},
// {
// type: 'string',
@@ -234,7 +238,8 @@ class App extends Generator {
]) as any
}
debug(this.answers)
- this.options = this.answers.options
+ const sfdxPluginOptions = {typescript: true, mocha: true, 'semantic-release': false}
+ this.options = this.type === 'sfdx-plugin' ? sfdxPluginOptions : this.answers.options
this.ts = this.options.typescript
this.tslint = this.options.tslint
this.yarn = this.options.yarn
@@ -268,15 +273,32 @@ class App extends Generator {
this.pjson.scripts.build = 'rm -rf lib && tsc'
this.pjson.scripts.prepublishOnly = `${npm} run build`
}
- if (['plugin', 'multi'].includes(this.type)) {
+ if (['sfdx-plugin', 'plugin', 'multi'].includes(this.type)) {
this.pjson.scripts.prepublishOnly = nps.series(this.pjson.scripts.prepublishOnly, 'oclif-dev manifest')
if (this.semantic_release) this.pjson.scripts.prepublishOnly = nps.series(this.pjson.scripts.prepublishOnly, 'oclif-dev readme')
this.pjson.scripts.version = nps.series('oclif-dev readme', 'git add README.md')
this.pjson.scripts.clean = 'rm -f .oclif.manifest.json'
this.pjson.scripts.postpublish = this.pjson.scripts.preversion = `${npm} run clean`
this.pjson.files.push('.oclif.manifest.json')
+ if (this.type === 'sfdx-plugin') {
+ this.pjson.files.push('/messages')
+ this.pjson.scripts.prepare = this.pjson.scripts.prepublishOnly
+ }
+ }
+
+ let keywords
+ switch (this.type) {
+ case 'sfdx-plugin':
+ keywords = 'sfdx-plugin'
+ break
+ case 'plugin':
+ keywords = 'oclif-plugin'
+ break
+ default:
+ keywords = 'oclif'
}
- this.pjson.keywords = defaults.keywords || [this.type === 'plugin' ? 'oclif-plugin' : 'oclif']
+
+ this.pjson.keywords = defaults.keywords || [keywords]
this.pjson.homepage = defaults.homepage || `https://github.com/${this.pjson.repository}`
this.pjson.bugs = defaults.bugs || `https://github.com/${this.pjson.repository}/issues`
@@ -288,7 +310,7 @@ class App extends Generator {
} else if (this.type === 'plugin') {
this.pjson.oclif.bin = 'oclif-example'
}
- if (this.type !== 'plugin') {
+ if (this.type !== 'plugin' && this.type !== 'sfdx-plugin') {
this.pjson.main = defaults.main || (this.ts ? 'lib/index.js' : 'src/index.js')
if (this.ts) {
this.pjson.types = defaults.types || 'lib/index.d.ts'
@@ -302,6 +324,7 @@ class App extends Generator {
switch (this.type) {
case 'multi':
case 'plugin':
+ case 'sfdx-plugin':
this.pjson.oclif = {
commands: `./${this.ts ? 'lib' : 'src'}/commands`,
// hooks: {init: `./${this.ts ? 'lib' : 'src'}/hooks/init`},
@@ -310,7 +333,7 @@ class App extends Generator {
break
default:
}
- if (this.type === 'plugin' && !this.pjson.oclif.devPlugins) {
+ if ((this.type === 'plugin' || this.type === 'sfdx-plugin') && !this.pjson.oclif.devPlugins) {
this.pjson.oclif.devPlugins = [
'@oclif/plugin-help',
]
@@ -331,7 +354,11 @@ class App extends Generator {
}
this.fs.copyTpl(this.templatePath('tsconfig.json'), this.destinationPath('tsconfig.json'), this)
if (this.mocha) {
- this.fs.copyTpl(this.templatePath('test/tsconfig.json'), this.destinationPath('test/tsconfig.json'), this)
+ if (this.type === 'sfdx-plugin') {
+ this.fs.copyTpl(this.templatePath('sfdxPlugin/test/tsconfig.json'), this.destinationPath('test/tsconfig.json'), this)
+ } else {
+ this.fs.copyTpl(this.templatePath('test/tsconfig.json'), this.destinationPath('test/tsconfig.json'), this)
+ }
}
}
if (this.mocha && !this.fs.exists('test')) {
@@ -343,6 +370,7 @@ class App extends Generator {
}
if (_.isEmpty(this.pjson.oclif)) delete this.pjson.oclif
this.pjson.files = _.uniq((this.pjson.files || []).sort())
+
this.fs.writeJSON(this.destinationPath('./package.json'), sortPjson(this.pjson))
this.fs.copyTpl(this.templatePath('editorconfig'), this.destinationPath('.editorconfig'), this)
this.fs.copyTpl(this.templatePath('scripts/greenkeeper'), this.destinationPath('.circleci/greenkeeper'), this)
@@ -350,7 +378,7 @@ class App extends Generator {
// this.fs.copyTpl(this.templatePath('scripts/release'), this.destinationPath('.circleci/release'), this)
// }
// this.fs.copyTpl(this.templatePath('scripts/setup_git'), this.destinationPath('.circleci/setup_git'), this)
- this.fs.copyTpl(this.templatePath('README.md.ejs'), this.destinationPath('README.md'), this)
+
this.fs.copyTpl(this.templatePath('circle.yml.ejs'), this.destinationPath('.circleci/config.yml'), this)
this.fs.copyTpl(this.templatePath('appveyor.yml.ejs'), this.destinationPath('appveyor.yml'), this)
if (this.pjson.license === 'MIT' && (this.pjson.repository.startsWith('oclif') || this.pjson.repository.startsWith('heroku'))) {
@@ -362,9 +390,12 @@ class App extends Generator {
this.fs.copyTpl(this.templatePath('gitattributes'), this.destinationPath('.gitattributes'), this)
this.fs.write(this.destinationPath('.gitignore'), this._gitignore())
- this.fs.copyTpl(this.templatePath('eslintrc'), this.destinationPath('.eslintrc'), this)
- const eslintignore = this._eslintignore()
- if (eslintignore.trim()) this.fs.write(this.destinationPath('.eslintignore'), this._eslintignore())
+ if (this.type !== 'sfdx-plugin') {
+ this.fs.copyTpl(this.templatePath('README.md.ejs'), this.destinationPath('README.md'), this)
+ this.fs.copyTpl(this.templatePath('eslintrc'), this.destinationPath('.eslintrc'), this)
+ const eslintignore = this._eslintignore()
+ if (eslintignore.trim()) this.fs.write(this.destinationPath('.eslintignore'), this._eslintignore())
+ }
switch (this.type) {
case 'single':
@@ -373,6 +404,9 @@ class App extends Generator {
case 'plugin':
this._writePlugin()
break
+ case 'sfdx-plugin':
+ this._writeSfdxPlugin()
+ break
case 'multi':
this._writeMulti()
break
@@ -404,6 +438,21 @@ class App extends Generator {
'globby',
)
break
+ case 'sfdx-plugin':
+ dependencies.push(
+ '@oclif/command',
+ '@oclif/config',
+ '@oclif/errors',
+ '@salesforce/command',
+ )
+ devDependencies.push(
+ '@oclif/dev-cli',
+ '@oclif/plugin-help',
+ 'globby',
+ '@salesforce/dev-config',
+ 'sinon',
+ )
+ break
case 'multi':
dependencies.push(
'@oclif/config',
@@ -456,7 +505,7 @@ class App extends Generator {
install(devDependencies, {...yarnOpts, ...dev, ignoreScripts: true}),
install(dependencies, yarnOpts),
]).then(() => {
- if (['plugin', 'multi'].includes(this.type)) {
+ if (['sfdx-plugin', 'plugin', 'multi'].includes(this.type)) {
this.spawnCommandSync(path.join('.', 'node_modules/.bin/oclif-dev'), ['readme'])
}
console.log(`\nCreated ${this.pjson.name} in ${this.destinationRoot()}`)
@@ -518,6 +567,39 @@ class App extends Generator {
}
}
+ private _writeSfdxPlugin() {
+ const sfdxExampleCommand = 'org'
+ const topic = 'hello'
+ const bin = this._bin
+ const cmd = `${bin} ${sfdxExampleCommand}`
+ const opts = {...this as any, _, bin, cmd}
+ this.fs.copyTpl(this.templatePath('plugin/bin/run'), this.destinationPath('bin/run'), opts)
+ this.fs.copyTpl(this.templatePath('bin/run.cmd'), this.destinationPath('bin/run.cmd'), opts)
+ this.fs.copyTpl(this.templatePath('sfdxPlugin/README.md.ejs'), this.destinationPath('README.md'), this)
+ this.fs.copy(this.templatePath('.images/vscodeScreenshot.png'), this.destinationPath('.images/vscodeScreenshot.png'), this)
+ if (!fs.existsSync('src/commands')) {
+ this.fs.copyTpl(this.templatePath(`src/sfdxCommand.${this._ext}.ejs`), this.destinationPath(`src/commands/${topic}/${sfdxExampleCommand}.${this._ext}`), {
+ ...opts,
+ pluginName: this.pjson.name,
+ commandName: sfdxExampleCommand,
+ topicName: topic
+ })
+ }
+ this.fs.copyTpl(this.templatePath('sfdxPlugin/src/index.ts'), this.destinationPath('src/index.ts'), opts)
+ if (this.mocha && !fs.existsSync('test')) {
+ this.fs.copyTpl(this.templatePath(`sfdxPlugin/test/command.test.${this._ext}.ejs`), this.destinationPath(`test/commands/${topic}/${sfdxExampleCommand}.test.${this._ext}`),
+ {...opts, name: sfdxExampleCommand, topic})
+ }
+
+ if (!fs.existsSync('messages/messages.json')) {
+ this.fs.copyTpl(this.templatePath('messages/messages.json'), this.destinationPath(`messages/${sfdxExampleCommand}.json`), this)
+ }
+
+ if (!fs.existsSync('.vscode/launch.json')) {
+ this.fs.copyTpl(this.templatePath('.vscode/launch.json'), this.destinationPath(`.vscode/launch.json`), this)
+ }
+ }
+
private _writeSingle() {
const bin = this._bin
const opts = {...this as any, _, bin, cmd: bin, name: this.pjson.name}
diff --git a/templates/.images/vscodeScreenshot.png b/templates/.images/vscodeScreenshot.png
new file mode 100644
index 0000000..4b7206a
Binary files /dev/null and b/templates/.images/vscodeScreenshot.png differ
diff --git a/templates/.vscode/launch.json b/templates/.vscode/launch.json
new file mode 100644
index 0000000..08affd5
--- /dev/null
+++ b/templates/.vscode/launch.json
@@ -0,0 +1,16 @@
+{
+ // Use IntelliSense to learn about possible attributes.
+ // Hover to view descriptions of existing attributes.
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+ "version": "0.2.0",
+ "configurations": [
+ {
+ "type": "node",
+ "request": "attach",
+ "name": "Attach to Remote",
+ "address": "127.0.0.1",
+ "port": 9229,
+ "localRoot": "${workspaceFolder}"
+ }
+ ]
+}
diff --git a/templates/messages/messages.json b/templates/messages/messages.json
new file mode 100644
index 0000000..19bf8e6
--- /dev/null
+++ b/templates/messages/messages.json
@@ -0,0 +1,4 @@
+{
+ "commandDescription": "Prints a greeting and your org id(s)!",
+ "nameFlagDescription": "name to print"
+}
diff --git a/templates/sfdxPlugin/README.md.ejs b/templates/sfdxPlugin/README.md.ejs
new file mode 100644
index 0000000..85d5a89
--- /dev/null
+++ b/templates/sfdxPlugin/README.md.ejs
@@ -0,0 +1,42 @@
+<%= pjson.name %>
+<%= '='.repeat(pjson.name.length) %>
+
+<%= pjson.description %>
+
+[](https://npmjs.org/package/<%= pjson.name %>)
+[](https://circleci.com/gh/<%= repository %>/tree/master)
+[](https://ci.appveyor.com/project/heroku/<%= repository.split('/').pop() %>/branch/master)
+[](https://codecov.io/gh/<%= repository %>)
+[](https://greenkeeper.io/)
+[](https://snyk.io/test/github/<%= repository %>)
+[](https://npmjs.org/package/<%= pjson.name %>)
+[](https://github.com/<%= repository %>/blob/master/package.json)
+
+
+
+
+
+
+# Debugging your plugin
+We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
+
+To debug the `hello:org` command:
+1. Start the inspector
+
+If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
+```sh-session
+$ sfdx hello:org -u myOrg@example.com --dev-suspend
+```
+
+Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
+```sh-session
+$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u myOrg@example.com
+```
+
+2. Set some breakpoints in your command code
+3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
+4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
+5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
+6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
++Congrats, you are debugging! diff --git a/templates/sfdxPlugin/src/index.ts b/templates/sfdxPlugin/src/index.ts new file mode 100644 index 0000000..ff8b4c5 --- /dev/null +++ b/templates/sfdxPlugin/src/index.ts @@ -0,0 +1 @@ +export default {}; diff --git a/templates/sfdxPlugin/test/command.test.ts.ejs b/templates/sfdxPlugin/test/command.test.ts.ejs new file mode 100644 index 0000000..45ced07 --- /dev/null +++ b/templates/sfdxPlugin/test/command.test.ts.ejs @@ -0,0 +1,14 @@ +import { expect, test } from '@salesforce/command/dist/test'; + +describe('<%- topic %>:<%- name %>', () => { + test + .withOrg({ username: 'test@org.com' }, true) + .withConnectionRequest(function() { + return Promise.resolve({ records: [ { Name: 'Super Awesome Org', TrialExpirationDate: '2018-03-20T23:24:11.000+0000'}]}); + }) + .stdout() + .command(['<%- topic %>:<%- name %>', '--targetusername', 'test@org.com']) + .it('runs <%- topic %>:<%- name %> --targetusername test@org.com', (ctx) => { + expect(ctx.stdout).to.contain('Hello world! This is org: Super Awesome Org and I will be around until Tue Mar 20 2018!'); + }); +}); diff --git a/templates/sfdxPlugin/test/tsconfig.json b/templates/sfdxPlugin/test/tsconfig.json new file mode 100644 index 0000000..4f7a5ce --- /dev/null +++ b/templates/sfdxPlugin/test/tsconfig.json @@ -0,0 +1,4 @@ +{ + "extends": "../tsconfig" +} + diff --git a/templates/src/sfdxCommand.ts.ejs b/templates/src/sfdxCommand.ts.ejs new file mode 100644 index 0000000..e54cc14 --- /dev/null +++ b/templates/src/sfdxCommand.ts.ejs @@ -0,0 +1,80 @@ +import {flags} from '@oclif/command'; +import {join} from 'path'; +import {SfdxCommand, core} from '@salesforce/command'; +<%_ const klass = _.upperFirst(_.camelCase(commandName)) _%> + +core.Messages.importMessagesDirectory(join(__dirname, '..', '..', '..')); +const messages = core.Messages.loadMessages('<%- pluginName %>', '<%- commandName %>'); + +export default class <%- klass %> extends SfdxCommand { + + public static description = messages.getMessage('commandDescription'); + + public static examples = [ + `$ sfdx <%- topicName %>:<%- commandName %> --targetusername myOrg@example.com --targetdevhubusername devhub@org.com + Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018! + My hub org id is: 00Dxx000000001234 + `, + `$ sfdx <%- topicName %>:<%- commandName %> --name myname --targetusername myOrg@example.com + Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018! + ` + ]; + + public static args = [{name: 'file'}]; + + protected static flagsConfig = { + // flag with a value (-n, --name=VALUE) + name: flags.string({char: 'n', description: messages.getMessage('nameFlagDescription')}), + force: flags.boolean({char: 'f'}) + }; + + // Comment this out if your command does not require an org username + protected static requiresUsername = true; + + // Comment this out if your command does not support a hub org username + protected static supportsDevhubUsername = true; + + // Set this to true if your command requires a project workspace; 'requiresProject' is false by default + protected static requiresProject = false; + + public async run(): Promise