chore: update repo to use @oclif/core [skip ci] (#12)

* chore: update repo to use @oclif/core and add base project deploy command

* chore: code review

* chore: code review

Author: mdonnalley

.circleci/config.yml

@@ -1,29 +1,46 @@
 version: 2.1
 orbs:
   release-management: salesforce/npm-release-management@4
+parameters:
+  run-auto-workflows:
+    description: >
+      Boolean that controls when an workflow would run.
+
+      It is used to gate which workflows should run when github events occur.
+
+      This parameter is used by automation to determine if a workflow will run
+      within a pipeline.
+    default: true
+    type: boolean
+  run-just-nuts:
+    description: >
+      Boolean that controls when the just-nuts will run.
+
+      Default value is false and this parameter is used by automation to
+      determine if
+
+      the just-nuts workflow will run.
+    default: false
+    type: boolean
+  sfdx_version:
+    description: |
+      By default, the latest version of the standalone CLI will be installed.
+      To install via npm, supply a version tag such as "latest" or "6".
+    default: ''
+    type: string
+  repo_tag:
+    description: "The tag of the module repo to checkout, '' defaults to branch/PR"
+    default: ''
+    type: string
 workflows:
   version: 2
   test-and-release:
+    when: << pipeline.parameters.run-auto-workflows >>
     jobs:
       - release-management/validate-pr:
           filters:
             branches:
               ignore: main
-        release-management/test-package:
-          matrix:
-            parameters:
-              os:
-                - linux
-                - windows
-              node_version:
-                - latest
-                - lts
-                - maintenance
-            exclude:
-              - os: windows
-                node_version: lts
-              - os: windows
-                node_version: maintenance
       - release-management/test-package:
           matrix:
             parameters:
@@ -39,6 +56,17 @@ workflows:
                 node_version: lts
               - os: windows
                 node_version: maintenance
+      - release-management/test-nut:
+          name: nuts-on-linux
+          sfdx_version: latest
+          requires:
+            - release-management/test-package
+      - release-management/test-nut:
+          name: nuts-on-windows
+          sfdx_version: latest
+          os: windows
+          requires:
+            - release-management/test-package
       - release-management/release-package:
           sign: true
           github-release: true
@@ -47,7 +75,7 @@ workflows:
           filters:
             branches:
               only: main
-    when: << pipeline.parameters.run-auto-workflows >>
+          context: CLI_CTC
   test-ts-update:
     triggers:
       - schedule:
@@ -71,34 +99,3 @@ workflows:
               os:
                 - linux
                 - windows
-parameters:
-  run-auto-workflows:
-    description: >
-      Boolean that controls when an workflow would run.
-
-      It is used to gate which workflows should run when github events occur.
-
-      This parameter is used by automation to determine if a workflow will run
-      within a pipeline.
-    default: true
-    type: boolean
-  run-just-nuts:
-    description: >
-      Boolean that controls when the just-nuts will run.
-
-      Default value is false and this parameter is used by automation to
-      determine if
-
-      the just-nuts workflow will run.
-    default: false
-    type: boolean
-  sfdx_version:
-    description: |
-      By default, the latest version of the standalone CLI will be installed.
-      To install via npm, supply a version tag such as "latest" or "6".
-    default: ''
-    type: string
-  repo_tag:
-    description: 'The tag of the module repo to checkout, '''' defaults to branch/PR'
-    default: ''
-    type: string

README.md

@@ -1,51 +1,13 @@
-### Use the [lerna template](https://github.com/salesforcecli/lerna-template) if you need a library and plugin
+# plugin-project
 
-### This template is useful if the library is already in another repository or the plugin is a wrapper around an API.
-
-# plugin-<REPLACE ME>
-
-[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-template.svg?label=@salesforce/plugin-template)](https://www.npmjs.com/package/@salesforce/plugin-template) [![CircleCI](https://circleci.com/gh/salesforcecli/plugin-template/tree/main.svg?style=shield)](https://circleci.com/gh/salesforcecli/plugin-template/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-template.svg)](https://npmjs.org/package/@salesforce/plugin-template) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-template/main/LICENSE.txt)
-
-Change above to <REPLACE_ME> before finalizing
-
-&lt;REPLACE ME DESCRIPTION START&gt;
-
-This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
-
-1. Clone this repo
-2. Delete the .git folder
-3. Replace filler values
-   a) Every instance of `<REPLACE_ME>` can be directly substitued for the name of the new plugin. However beware, things like github paths are for the salesforcecli Github organization
-   b) Search for case-matching `REPLACE` to find other filler values, such as for the plugin description
-4. Use `git init` to set up the desired git information
-5. Follow the getting started steps below until the `sfdx hello:org` commmand is functioning
-
-&lt;REPLACE ME DESCRIPTION END&gt;
-
-## Learn about the plugin-template
-
-Salesforce CLI plugins are based on the [oclif plugin framework](<(https://oclif.io/docs/introduction.html)>). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
-
-This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](https://github.com/forcedotcom/sfdx-dev-packages/) used by Salesforce. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards.
-
-Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is recommended to keep these tests active in your plugin, regardless if you plan to have it bundled.
-
-# Everything past here is only a suggestion as to what should be in your specific plugin's description
-
-This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
-
-We always recommend using the latest version of these commands bundled with the CLI, however, you can install a specific version or tag if needed.
+[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-project.svg?label=@salesforce/plugin-project)](https://www.npmjs.com/package/@salesforce/plugin-project) [![CircleCI](https://circleci.com/gh/salesforcecli/plugin-project/tree/main.svg?style=shield)](https://circleci.com/gh/salesforcecli/plugin-project/tree/main) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-project.svg)](https://npmjs.org/package/@salesforce/plugin-project) [![License](https://img.shields.io/badge/License-BSD%203--Clause-brightgreen.svg)](https://raw.githubusercontent.com/salesforcecli/plugin-project/main/LICENSE.txt)
 
 ## Install
 
 ```bash
-sfdx plugins:install <REPLACE_ME>@x.y.z
+sf plugins:install plugin-project@x.y.z
 ```
 
-## Issues
-
-Please report any issues at https://github.com/forcedotcom/cli/issues
-
 ## Contributing
 
 1. Please read our [Code of Conduct](CODE_OF_CONDUCT.md)
@@ -71,7 +33,7 @@ To build the plugin locally, make sure to have yarn installed and run the follow
 
 ```bash
 # Clone the repository
-git clone [email protected]:salesforcecli/plugin-<REPLACE_ME>
+git clone [email protected]:salesforcecli/plugin-project
 
 # Install the dependencies and compile
 yarn install
@@ -82,58 +44,47 @@ To use your plugin, run using the local `./bin/run` or `./bin/run.cmd` file.
 
 ```bash
 # Run using local run file.
-./bin/run <REPLACE_ME>
+./bin/run project
 ```
 
 There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
 
 ```bash
-# Link your plugin to the sfdx cli
-sfdx plugins:link .
+# Link your plugin to the sf cli
+sf plugins:link .
 # To verify
-sfdx plugins
+sf plugins
 ```
 
 ## Commands
 
 <!-- commands -->
 
-- [`sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
-
-## `sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
+## `sf project:deploy`
 
-print a greeting and your org IDs
+deploy a Salesforce project
 
 ```
 USAGE
-  $ sfdx hello:org [-n <string>] [-f] [-v <string>] [-u <string>] [--apiversion <string>] [--json] [--loglevel
-  trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+  $ sf project:deploy
 
 OPTIONS
-  -f, --force                                                                       example boolean flag
-  -n, --name=name                                                                   name to print
-
-  -u, --targetusername=targetusername                                               username or alias for the target
-                                                                                    org; overrides default target org
+  --directory=directory    directory to deploy
+  --interactive            TBD
+  --target-env=target-env  TBD
 
-  -v, --targetdevhubusername=targetdevhubusername                                   username or alias for the dev hub
-                                                                                    org; overrides default dev hub org
-
-  --apiversion=apiversion                                                           override the api version used for
-                                                                                    api requests made by this command
-
-  --json                                                                            format output as json
-
-  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
-                                                                                    this command invocation
+DESCRIPTION
+  Deploy a project, including org metadata and functions. Be default, the deploy analyze your project and assume
+  sensible defaults when possible, otherwise it will prompt. To always prompt and not assume defaults, use
+  "--interctive".
+  To run specialized deploys, especially when interactivity isn't an option like continuous deployment, used the scoped
+  deploy commands like "sf project deploy org" or "sf project deploy functions"
 
 EXAMPLES
-  $ sfdx hello:org --targetusername [email protected] --targetdevhubusername [email protected]
-     Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
-     My hub org id is: 00Dxx000000001234
-
-  $ sfdx hello:org --name myname --targetusername [email protected]
-     Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
+  sf project:deploy
+  sf project:deploy --remote
 ```
 
+_See code: [src/commands/project/deploy.ts](https://github.com/salesforcecli/plugin-project/blob/v0.0.1/src/commands/project/deploy.ts)_
+
 <!-- commandsstop -->

bin/dev

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+process.env.NODE_ENV = 'development';
+
+const g = global.oclif = global.oclif || {};
+
+// In dev mode, always show stack traces
+global.oclif.debug = true;
+
+require('ts-node').register()
+
+require('@oclif/core').run()
+.then(require('@oclif/core/flush'))
+.catch(require('@oclif/core/handle'))

bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+set NODE_ENV=development
+node "%~dp0\dev" %*

bin/run

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
 
-require('@oclif/command').run()
-.catch(require('@oclif/errors/handle'))
+require('@oclif/core').run()
+.then(require('@oclif/core/flush'))
+.catch(require('@oclif/core/handle'))

bin/run.cmd

@@ -1,3 +1,3 @@
 @echo off
 
-node "%~dp0\run" %*
+node "%~dp0\run" %*

command-snapshot.json

@@ -1,7 +1,7 @@
 [
   {
-    "command": "hello:org",
-    "plugin": "@salesforce/plugin-template",
-    "flags": ["apiversion", "force", "json", "loglevel", "name", "targetdevhubusername", "targetusername"]
+    "command": "project:deploy",
+    "plugin": "@salesforce/plugin-project",
+    "flags": ["directory", "interactive", "target-env"]
   }
 ]

messages/org.json

@@ -0,0 +1,6 @@
+{
+  "deploy": {
+    "commandDescription": "deploy a Salesforce project\nDeploy a project, including org metadata and functions. Be default, the deploy analyze your project and assume sensible defaults when possible, otherwise it will prompt. To always prompt and not assume defaults, use \"--interctive\".\nTo run specialized deploys, especially when interactivity isn't an option like continuous deployment, used the scoped deploy commands like \"sf project deploy org\" or \"sf project deploy functions\"",
+    "examples": ["<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --remote"]
+  }
+}