@salesforce/cli 1.8.0 → 1.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +3 -2
  2. package/LICENSE.txt +1 -1
  3. package/README.md +103 -55
  4. package/oclif.manifest.json +1 -1
  5. package/package.json +14 -40
package/CHANGELOG.md CHANGED
@@ -2,12 +2,13 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
- ## [1.8.0](https://github.com/salesforcecli/cli/compare/v1.7.0...v1.8.0) (2022-01-06)
5
+ ## [1.9.0](https://github.com/salesforcecli/cli/compare/v1.8.0...v1.9.0) (2022-01-12)
6
6
 
7
+ ## [1.8.0](https://github.com/salesforcecli/cli/compare/v1.7.0...v1.8.0) (2022-01-06)
7
8
 
8
9
  ### Features
9
10
 
10
- * verify promote for stable-rc channel ([0678adb](https://github.com/salesforcecli/cli/commit/0678adb1b13a274381a7d9bb92acf46156f5a7c6))
11
+ - verify promote for stable-rc channel ([0678adb](https://github.com/salesforcecli/cli/commit/0678adb1b13a274381a7d9bb92acf46156f5a7c6))
11
12
 
12
13
  ## [1.7.0](https://github.com/salesforcecli/cli/compare/v1.6.0...v1.7.0) (2021-12-15)
13
14
 
package/LICENSE.txt CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2018, Salesforce.com, Inc.
1
+ Copyright (c) 2022, Salesforce.com, Inc.
2
2
  All rights reserved.
3
3
 
4
4
  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
package/README.md CHANGED
@@ -6,11 +6,12 @@
6
6
  [![License](https://img.shields.io/npm/l/@salesforce/cli.svg)](https://github.com/salesforcecli/cli/blob/master/package.json)
7
7
 
8
8
  <!-- toc -->
9
- * [@salesforce/cli](#salesforcecli)
10
- * [Getting Started](#getting-started)
11
- * [Feedback](#feedback)
12
- * [Usage](#usage)
13
- * [Commands](#commands)
9
+
10
+ - [@salesforce/cli](#salesforcecli)
11
+ - [Getting Started](#getting-started)
12
+ - [Feedback](#feedback)
13
+ - [Usage](#usage)
14
+ - [Commands](#commands)
14
15
  <!-- tocstop -->
15
16
 
16
17
  # Getting Started
@@ -24,68 +25,72 @@ To provide feedback, use create a new issue [here](https://github.com/forcedotco
24
25
  # Usage
25
26
 
26
27
  <!-- usage -->
28
+
27
29
  ```sh-session
28
30
  $ npm install -g @salesforce/cli
29
31
  $ sf COMMAND
30
32
  running command...
31
33
  $ sf (--version|-v)
32
- @salesforce/cli/1.8.0 linux-x64 node-v14.18.2
34
+ @salesforce/cli/1.9.0 linux-x64 node-v14.18.3
33
35
  $ sf --help [COMMAND]
34
36
  USAGE
35
37
  $ sf COMMAND
36
38
  ...
37
39
  ```
40
+
38
41
  <!-- usagestop -->
39
42
 
40
43
  # Commands
41
44
 
42
45
  <!-- commands -->
43
- * [`sf autocomplete [SHELL]`](#sf-autocomplete-shell)
44
- * [`sf config get`](#sf-config-get)
45
- * [`sf config list`](#sf-config-list)
46
- * [`sf config set`](#sf-config-set)
47
- * [`sf config unset`](#sf-config-unset)
48
- * [`sf deploy`](#sf-deploy)
49
- * [`sf deploy functions`](#sf-deploy-functions)
50
- * [`sf deploy metadata`](#sf-deploy-metadata)
51
- * [`sf env create compute`](#sf-env-create-compute)
52
- * [`sf env delete`](#sf-env-delete)
53
- * [`sf env display`](#sf-env-display)
54
- * [`sf env list`](#sf-env-list)
55
- * [`sf env log tail`](#sf-env-log-tail)
56
- * [`sf env logdrain add`](#sf-env-logdrain-add)
57
- * [`sf env logdrain list`](#sf-env-logdrain-list)
58
- * [`sf env logdrain remove`](#sf-env-logdrain-remove)
59
- * [`sf env open`](#sf-env-open)
60
- * [`sf env var get KEY`](#sf-env-var-get-key)
61
- * [`sf env var list`](#sf-env-var-list)
62
- * [`sf env var set`](#sf-env-var-set)
63
- * [`sf env var unset`](#sf-env-var-unset)
64
- * [`sf generate function`](#sf-generate-function)
65
- * [`sf generate project`](#sf-generate-project)
66
- * [`sf help [COMMAND]`](#sf-help-command)
67
- * [`sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
68
- * [`sf login`](#sf-login)
69
- * [`sf login functions`](#sf-login-functions)
70
- * [`sf login functions jwt`](#sf-login-functions-jwt)
71
- * [`sf login org`](#sf-login-org)
72
- * [`sf login org jwt`](#sf-login-org-jwt)
73
- * [`sf logout`](#sf-logout)
74
- * [`sf logout functions`](#sf-logout-functions)
75
- * [`sf logout org`](#sf-logout-org)
76
- * [`sf plugins`](#sf-plugins)
77
- * [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
78
- * [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin)
79
- * [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
80
- * [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
81
- * [`sf plugins update`](#sf-plugins-update)
82
- * [`sf retrieve metadata`](#sf-retrieve-metadata)
83
- * [`sf run function`](#sf-run-function)
84
- * [`sf run function start`](#sf-run-function-start)
85
- * [`sf run function start local`](#sf-run-function-start-local)
86
- * [`sf update [CHANNEL]`](#sf-update-channel)
87
- * [`sf version`](#sf-version)
88
- * [`sf whoami functions`](#sf-whoami-functions)
46
+
47
+ - [`sf autocomplete [SHELL]`](#sf-autocomplete-shell)
48
+ - [`sf config get`](#sf-config-get)
49
+ - [`sf config list`](#sf-config-list)
50
+ - [`sf config set`](#sf-config-set)
51
+ - [`sf config unset`](#sf-config-unset)
52
+ - [`sf deploy`](#sf-deploy)
53
+ - [`sf deploy functions`](#sf-deploy-functions)
54
+ - [`sf deploy metadata`](#sf-deploy-metadata)
55
+ - [`sf env create compute`](#sf-env-create-compute)
56
+ - [`sf env delete`](#sf-env-delete)
57
+ - [`sf env display`](#sf-env-display)
58
+ - [`sf env list`](#sf-env-list)
59
+ - [`sf env log tail`](#sf-env-log-tail)
60
+ - [`sf env logdrain add`](#sf-env-logdrain-add)
61
+ - [`sf env logdrain list`](#sf-env-logdrain-list)
62
+ - [`sf env logdrain remove`](#sf-env-logdrain-remove)
63
+ - [`sf env open`](#sf-env-open)
64
+ - [`sf env var get KEY`](#sf-env-var-get-key)
65
+ - [`sf env var list`](#sf-env-var-list)
66
+ - [`sf env var set`](#sf-env-var-set)
67
+ - [`sf env var unset`](#sf-env-var-unset)
68
+ - [`sf generate function`](#sf-generate-function)
69
+ - [`sf generate project`](#sf-generate-project)
70
+ - [`sf help [COMMAND]`](#sf-help-command)
71
+ - [`sf info:releasenotes:display [-v <string>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sf-inforeleasenotesdisplay--v-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
72
+ - [`sf login`](#sf-login)
73
+ - [`sf login functions`](#sf-login-functions)
74
+ - [`sf login functions jwt`](#sf-login-functions-jwt)
75
+ - [`sf login org`](#sf-login-org)
76
+ - [`sf login org jwt`](#sf-login-org-jwt)
77
+ - [`sf logout`](#sf-logout)
78
+ - [`sf logout functions`](#sf-logout-functions)
79
+ - [`sf logout org`](#sf-logout-org)
80
+ - [`sf plugins`](#sf-plugins)
81
+ - [`sf plugins:inspect PLUGIN...`](#sf-pluginsinspect-plugin)
82
+ - [`sf plugins:install PLUGIN...`](#sf-pluginsinstall-plugin)
83
+ - [`sf plugins:link PLUGIN`](#sf-pluginslink-plugin)
84
+ - [`sf plugins:uninstall PLUGIN...`](#sf-pluginsuninstall-plugin)
85
+ - [`sf plugins update`](#sf-plugins-update)
86
+ - [`sf retrieve metadata`](#sf-retrieve-metadata)
87
+ - [`sf run function`](#sf-run-function)
88
+ - [`sf run function start`](#sf-run-function-start)
89
+ - [`sf run function start container`](#sf-run-function-start-container)
90
+ - [`sf run function start local`](#sf-run-function-start-local)
91
+ - [`sf update [CHANNEL]`](#sf-update-channel)
92
+ - [`sf version`](#sf-version)
93
+ - [`sf whoami functions`](#sf-whoami-functions)
89
94
 
90
95
  ## `sf autocomplete [SHELL]`
91
96
 
@@ -1460,7 +1465,7 @@ ALIASES
1460
1465
  $ sf plugins add
1461
1466
 
1462
1467
  EXAMPLES
1463
- $ sf plugins:install myplugin
1468
+ $ sf plugins:install myplugin
1464
1469
 
1465
1470
  $ sf plugins:install https://github.com/someuser/someplugin
1466
1471
 
@@ -1664,7 +1669,7 @@ EXAMPLES
1664
1669
 
1665
1670
  ## `sf run function start`
1666
1671
 
1667
- Build and run a Salesforce Function in a container.
1672
+ Build and run a Salesforce Function.
1668
1673
 
1669
1674
  ```
1670
1675
  USAGE
@@ -1681,10 +1686,14 @@ FLAGS
1681
1686
  --no-pull Skip pulling builder image before use.
1682
1687
 
1683
1688
  DESCRIPTION
1684
- Build and run a Salesforce Function in a container.
1689
+ Build and run a Salesforce Function.
1685
1690
 
1686
1691
  Run this command from the directory of your Salesforce Functions project.
1687
1692
 
1693
+ This command will run the target function in a container. In the future, this command will run the target function on
1694
+ the host operating system (locally) instead. If one mode is preferred over the other, consider using the `container`
1695
+ or `local` subcommand instead.
1696
+
1688
1697
  EXAMPLES
1689
1698
  Build and run a function:
1690
1699
 
@@ -1699,6 +1708,44 @@ EXAMPLES
1699
1708
  $ sf run function start --env KEY=VALUE --network host
1700
1709
  ```
1701
1710
 
1711
+ ## `sf run function start container`
1712
+
1713
+ Build and run a Salesforce Function in a container.
1714
+
1715
+ ```
1716
+ USAGE
1717
+ $ sf run function start container [-p <value>] [-b <value>] [--clear-cache] [--no-pull] [-e <value>] [--network
1718
+ <value>] [-v]
1719
+
1720
+ FLAGS
1721
+ -b, --debug-port=<value> [default: 9229] Port for remote debugging.
1722
+ -e, --env=<value>... Set environment variables (provided during build and run).
1723
+ -p, --port=<value> [default: 8080] Port for running the function.
1724
+ -v, --verbose Output additional logs.
1725
+ --clear-cache Clear associated cache before executing.
1726
+ --network=<value> Connect and build containers to a network. This can be useful to build containers which
1727
+ require a local resource.
1728
+ --no-pull Skip pulling builder image before use.
1729
+
1730
+ DESCRIPTION
1731
+ Build and run a Salesforce Function in a container.
1732
+
1733
+ Run this command from the directory of your Salesforce Functions project.
1734
+
1735
+ EXAMPLES
1736
+ Build and run a function:
1737
+
1738
+ $ sf run function start container
1739
+
1740
+ Run a function on a specific port with additional logs:
1741
+
1742
+ $ sf run function start container --port 5000 --verbose
1743
+
1744
+ Add environment variables and specify a network:
1745
+
1746
+ $ sf run function start container --env KEY=VALUE --network host
1747
+ ```
1748
+
1702
1749
  ## `sf run function start local`
1703
1750
 
1704
1751
  Build and run a Salesforce Function locally.
@@ -1776,4 +1823,5 @@ EXAMPLES
1776
1823
 
1777
1824
  $ sf whoami functions --show-token --json
1778
1825
  ```
1826
+
1779
1827
  <!-- commandsstop -->
package/oclif.manifest.json CHANGED
@@ -1 +1 @@
1
- {"version":"1.8.0","commands":{}}
1
+ {"version":"1.9.0","commands":{}}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/cli",
3
3
  "description": "The Salesforce CLI",
4
- "version": "1.8.0",
4
+ "version": "1.9.0",
5
5
  "author": "Salesforce",
6
6
  "bin": {
7
7
  "sf": "./bin/run"
@@ -45,7 +45,7 @@
45
45
  "@sf/gen",
46
46
  "@sf/info",
47
47
  "@sf/login",
48
- "@salesforce/plugin-telemetry"
48
+ "@sf/telemetry"
49
49
  ],
50
50
  "devPlugins": [
51
51
  "@oclif/plugin-command-snapshot",
@@ -89,39 +89,19 @@
89
89
  "@oclif/plugin-plugins": "2.0.12",
90
90
  "@oclif/plugin-update": "2.1.4",
91
91
  "@oclif/plugin-version": "1.0.4",
92
- "@salesforce/plugin-telemetry": "1.4.0",
93
92
  "@salesforce/sf-plugins-core": "1.0.5",
94
93
  "@sf/config": "npm:@salesforce/plugin-config@2.2.11",
95
94
  "@sf/deploy-retrieve": "npm:@salesforce/plugin-deploy-retrieve@1.0.5",
96
95
  "@sf/drm": "npm:@salesforce/plugin-deploy-retrieve-metadata@1.0.7",
97
96
  "@sf/env": "npm:@salesforce/plugin-env@1.0.3",
98
- "@sf/functions": "npm:@salesforce/plugin-functions@1.3.0",
97
+ "@sf/functions": "npm:@salesforce/plugin-functions@1.4.3",
99
98
  "@sf/gen": "npm:@salesforce/plugin-generate@1.0.5",
100
99
  "@sf/info": "npm:@salesforce/plugin-info@1.2.0",
101
100
  "@sf/login": "npm:@salesforce/plugin-login@1.0.6",
101
+ "@sf/telemetry": "npm:@salesforce/plugin-telemetry@1.4.0",
102
102
  "tslib": "^2.3.1"
103
103
  },
104
- "pinnedDependencies": [
105
- "@sf/config@sf",
106
- "@sf/deploy-retrieve",
107
- "@sf/drm",
108
- "@sf/env",
109
- "@sf/functions",
110
- "@sf/gen",
111
- "@sf/info",
112
- "@sf/login",
113
- "@salesforce/plugin-telemetry",
114
- "@oclif/plugin-autocomplete",
115
- "@oclif/plugin-help",
116
- "@oclif/plugin-not-found",
117
- "@oclif/plugin-plugins",
118
- "@oclif/plugin-update",
119
- "@oclif/plugin-version"
120
- ],
121
104
  "resolutions": {
122
- "@salesforce/templates": "52.7.0",
123
- "@oclif/config": "1.18.2",
124
- "@oclif/command": "1.8.16",
125
105
  "@oclif/core/**/cli-ux": "^6.0.7",
126
106
  "oclif/**/cli-ux": "^6.0.7"
127
107
  },
@@ -129,8 +109,8 @@
129
109
  "scripts": {
130
110
  "build": "sf-build",
131
111
  "channel:promote": "sf-release channel:promote",
132
- "clean-all": "sf-clean all",
133
112
  "clean": "sf-clean",
113
+ "clean-all": "sf-clean all",
134
114
  "compile": "sf-compile",
135
115
  "docs": "sf-docs",
136
116
  "format": "sf-format",
@@ -144,14 +124,16 @@
144
124
  "postpack": "rm -f oclif.manifest.json",
145
125
  "posttest": "yarn test:deprecation-policy",
146
126
  "prepack": "sf-prepack",
147
- "prepare": "yarn compile && yarn lint",
127
+ "prepare": "sf-install && yarn compile && yarn lint",
148
128
  "pretarball": "sf-release cli:tarballs:prepare --types",
129
+ "pretest": "echo disable # sf-compile-test",
149
130
  "promote-dist-tags": "./scripts/promote-dist-tags",
150
131
  "promote:verify": "sf-release cli:versions:inspect --channels stable --locations archive --cli sf",
151
132
  "promote:verify-rc": "sf-release cli:versions:inspect --channels stable-rc --locations archive --cli sf",
152
- "test:smoke-unix": "sf-release cli:tarballs:smoke --cli sf",
153
- "test:deprecation-policy": "./bin/dev snapshot:compare",
154
133
  "test": "echo disable # sf-test",
134
+ "test:deprecation-policy": "./bin/dev snapshot:compare",
135
+ "test:json-schema": "sf-release cli:schemas:compare",
136
+ "test:smoke-unix": "sf-release cli:tarballs:smoke --cli sf",
155
137
  "upload:deb": "oclif upload:deb",
156
138
  "upload:macos": "oclif upload:macos",
157
139
  "upload:tarballs": "oclif upload:tarballs",
@@ -159,18 +141,10 @@
159
141
  "version": "oclif readme"
160
142
  },
161
143
  "types": "dist/index.d.ts",
162
- "husky": {
163
- "hooks": {
164
- "commit-msg": "sf-husky-commit-msg",
165
- "pre-commit": "sf-husky-pre-commit",
166
- "pre-push": "sf-husky-pre-push"
167
- }
168
- },
169
144
  "devDependencies": {
170
145
  "@oclif/plugin-command-snapshot": "^3.1.2",
171
- "@oclif/test": "^1",
172
- "@salesforce/dev-config": "^2.1.2",
173
- "@salesforce/dev-scripts": "^0.9.18",
146
+ "@salesforce/dev-config": "^3.0.0",
147
+ "@salesforce/dev-scripts": "^2",
174
148
  "@salesforce/plugin-release-management": "^2.7.1",
175
149
  "@salesforce/prettier-config": "^0.0.2",
176
150
  "@typescript-eslint/eslint-plugin": "^4.33.0",
@@ -189,10 +163,10 @@
189
163
  "eslint-plugin-jsdoc": "^35.5.1",
190
164
  "eslint-plugin-prettier": "^3.4.1",
191
165
  "globby": "^11.0.4",
192
- "husky": "^4.3.8",
166
+ "husky": "^7.0.4",
193
167
  "mocha": "^9.1.3",
194
168
  "nyc": "^15.1.0",
195
- "oclif": "^2.0.0-main.6",
169
+ "oclif": "^2.1.0",
196
170
  "prettier": "^2.4.1",
197
171
  "pretty-quick": "^3.1.1",
198
172
  "sinon": "^11.1.2",