oclif 3.2.1 → 3.2.3
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.
- package/.oclif.manifest.json +1 -1
- package/README.md +4 -4
- package/lib/commands/promote.js +6 -0
- package/lib/generators/hook.js +1 -1
- package/lib/version-indexes.js +1 -0
- package/package.json +2 -2
- package/CHANGELOG.md +0 -2817
package/.oclif.manifest.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"3.2.
|
|
1
|
+
{"version":"3.2.3","commands":{"generate":{"id":"generate","description":"generate a new CLI\nThis will clone the template repo 'oclif/hello-world' and update package properties","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"directory name of new project","required":true}]},"manifest":{"id":"manifest","description":"generates plugin manifest json","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"path to plugin","default":"."}]},"promote":{"id":"promote","description":"promote CLI builds to a S3 release channel","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to the oclif CLI project root","required":true,"multiple":false,"default":"."},"version":{"name":"version","type":"option","description":"semantic version of the CLI to promote","required":true,"multiple":false},"sha":{"name":"sha","type":"option","description":"7-digit short git commit SHA of the CLI to promote","required":true,"multiple":false},"channel":{"name":"channel","type":"option","description":"which channel to promote to","required":true,"multiple":false,"default":"stable"},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to promote (e.g.: linux-arm,win32-x64)","multiple":false},"deb":{"name":"deb","type":"boolean","char":"d","description":"promote debian artifacts","allowNo":false},"macos":{"name":"macos","type":"boolean","char":"m","description":"promote macOS pkg","allowNo":false},"win":{"name":"win","type":"boolean","char":"w","description":"promote Windows exe","allowNo":false},"max-age":{"name":"max-age","type":"option","char":"a","description":"cache control max-age in seconds","multiple":false,"default":"86400"},"xz":{"name":"xz","type":"boolean","description":"also upload xz","allowNo":true},"indexes":{"name":"indexes","type":"boolean","description":"append the promoted urls into the index files","allowNo":false}},"args":[]},"readme":{"id":"readme","description":"adds commands to README.md in current directory\nThe readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:\n# Usage\n<!-- usage -->\n# Commands\n<!-- commands -->\n\nCustomize the code URL prefix by setting oclif.repositoryPrefix in package.json.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"dir":{"name":"dir","type":"option","description":"output directory for multi docs","required":true,"multiple":false,"default":"docs"},"multi":{"name":"multi","type":"boolean","description":"create a different markdown page for each topic","allowNo":false},"aliases":{"name":"aliases","type":"boolean","description":"include aliases in the command list","allowNo":true}},"args":[]},"generate:command":{"id":"generate:command","description":"add a command to an existing CLI or plugin","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","description":"overwrite existing files","allowNo":false}},"args":[{"name":"name","description":"name of command","required":true}]},"generate:hook":{"id":"generate:hook","description":"add a hook to an existing CLI or plugin","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","description":"overwrite existing files","allowNo":false},"event":{"name":"event","type":"option","description":"event to run hook on","multiple":false,"default":"init"}},"args":[{"name":"name","description":"name of hook (snake_case)","required":true}]},"pack:deb":{"id":"pack:deb","description":"pack CLI into debian package","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"tarball":{"name":"tarball","type":"option","char":"t","description":"optionally specify a path to a tarball already generated by NPM","required":false,"multiple":false}},"args":[]},"pack:macos":{"id":"pack:macos","description":"pack CLI into macOS .pkg","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"additional-cli":{"name":"additional-cli","type":"option","description":"an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"","hidden":true,"multiple":false},"tarball":{"name":"tarball","type":"option","char":"t","description":"optionally specify a path to a tarball already generated by NPM","required":false,"multiple":false}},"args":[]},"pack:tarballs":{"id":"pack:tarballs","description":"packages oclif CLI into tarballs\n\nThis can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to pack (e.g.: linux-arm,win32-x64)","multiple":false},"xz":{"name":"xz","type":"boolean","description":"also build xz","allowNo":true},"parallel":{"name":"parallel","type":"boolean","description":"build tarballs in parallel","allowNo":false},"tarball":{"name":"tarball","type":"option","char":"l","description":"optionally specify a path to a tarball already generated by NPM","required":false,"multiple":false}},"args":[]},"pack:win":{"id":"pack:win","description":"create windows installer from oclif CLI\n\n This command requires WINDOWS_SIGNING (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) to be set in the environment","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"additional-cli":{"name":"additional-cli","type":"option","description":"an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"","hidden":true,"multiple":false},"tarball":{"name":"tarball","type":"option","char":"t","description":"optionally specify a path to a tarball already generated by NPM","required":false,"multiple":false}},"args":[]},"upload:deb":{"id":"upload:deb","description":"upload deb package built with pack:deb","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"upload:macos":{"id":"upload:macos","description":"upload macos installers built with pack:macos","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"upload:tarballs":{"id":"upload:tarballs","description":"upload an oclif CLI to S3\n\n\"aws-sdk\" will need to be installed as a devDependency to upload.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to upload (e.g.: linux-arm,win32-x64)","multiple":false},"xz":{"name":"xz","type":"boolean","description":"also upload xz","allowNo":true}},"args":[]},"upload:win":{"id":"upload:win","description":"upload windows installers built with pack:win","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]}}}
|
package/README.md
CHANGED
|
@@ -146,7 +146,7 @@ DESCRIPTION
|
|
|
146
146
|
This will clone the template repo 'oclif/hello-world' and update package properties
|
|
147
147
|
```
|
|
148
148
|
|
|
149
|
-
_See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/v3.2.
|
|
149
|
+
_See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/v3.2.1/src/commands/generate.ts)_
|
|
150
150
|
|
|
151
151
|
## `oclif generate command NAME`
|
|
152
152
|
|
|
@@ -220,7 +220,7 @@ DESCRIPTION
|
|
|
220
220
|
generates plugin manifest json
|
|
221
221
|
```
|
|
222
222
|
|
|
223
|
-
_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/v3.2.
|
|
223
|
+
_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/v3.2.1/src/commands/manifest.ts)_
|
|
224
224
|
|
|
225
225
|
## `oclif pack deb`
|
|
226
226
|
|
|
@@ -320,7 +320,7 @@ DESCRIPTION
|
|
|
320
320
|
promote CLI builds to a S3 release channel
|
|
321
321
|
```
|
|
322
322
|
|
|
323
|
-
_See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/v3.2.
|
|
323
|
+
_See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/v3.2.1/src/commands/promote.ts)_
|
|
324
324
|
|
|
325
325
|
## `oclif readme`
|
|
326
326
|
|
|
@@ -351,7 +351,7 @@ DESCRIPTION
|
|
|
351
351
|
Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
|
|
352
352
|
```
|
|
353
353
|
|
|
354
|
-
_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/v3.2.
|
|
354
|
+
_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/v3.2.1/src/commands/readme.ts)_
|
|
355
355
|
|
|
356
356
|
## `oclif upload deb`
|
|
357
357
|
|
package/lib/commands/promote.js
CHANGED
|
@@ -41,6 +41,7 @@ class Promote extends core_1.Command {
|
|
|
41
41
|
// eslint-disable-next-line no-await-in-loop
|
|
42
42
|
await aws_1.default.s3.copyObject({
|
|
43
43
|
Bucket: s3Config.bucket,
|
|
44
|
+
ACL: s3Config.acl || 'public-read',
|
|
44
45
|
CopySource: copySource,
|
|
45
46
|
Key: key,
|
|
46
47
|
CacheControl: maxAge,
|
|
@@ -60,6 +61,7 @@ class Promote extends core_1.Command {
|
|
|
60
61
|
// eslint-disable-next-line no-await-in-loop
|
|
61
62
|
await aws_1.default.s3.copyObject({
|
|
62
63
|
Bucket: s3Config.bucket,
|
|
64
|
+
ACL: s3Config.acl || 'public-read',
|
|
63
65
|
CopySource: versionedTarGzKey,
|
|
64
66
|
Key: unversionedTarGzKey,
|
|
65
67
|
CacheControl: maxAge,
|
|
@@ -83,6 +85,7 @@ class Promote extends core_1.Command {
|
|
|
83
85
|
// eslint-disable-next-line no-await-in-loop
|
|
84
86
|
await aws_1.default.s3.copyObject({
|
|
85
87
|
Bucket: s3Config.bucket,
|
|
88
|
+
ACL: s3Config.acl || 'public-read',
|
|
86
89
|
CopySource: versionedTarXzKey,
|
|
87
90
|
Key: unversionedTarXzKey,
|
|
88
91
|
CacheControl: maxAge,
|
|
@@ -106,6 +109,7 @@ class Promote extends core_1.Command {
|
|
|
106
109
|
// eslint-disable-next-line no-await-in-loop
|
|
107
110
|
await aws_1.default.s3.copyObject({
|
|
108
111
|
Bucket: s3Config.bucket,
|
|
112
|
+
ACL: s3Config.acl || 'public-read',
|
|
109
113
|
CopySource: darwinCopySource,
|
|
110
114
|
Key: darwinKey,
|
|
111
115
|
CacheControl: maxAge,
|
|
@@ -129,6 +133,7 @@ class Promote extends core_1.Command {
|
|
|
129
133
|
// eslint-disable-next-line no-await-in-loop
|
|
130
134
|
await aws_1.default.s3.copyObject({
|
|
131
135
|
Bucket: s3Config.bucket,
|
|
136
|
+
ACL: s3Config.acl || 'public-read',
|
|
132
137
|
CopySource: winCopySource,
|
|
133
138
|
Key: winKey,
|
|
134
139
|
CacheControl: maxAge,
|
|
@@ -158,6 +163,7 @@ class Promote extends core_1.Command {
|
|
|
158
163
|
// eslint-disable-next-line no-await-in-loop
|
|
159
164
|
await aws_1.default.s3.copyObject({
|
|
160
165
|
Bucket: s3Config.bucket,
|
|
166
|
+
ACL: s3Config.acl || 'public-read',
|
|
161
167
|
CopySource: debCopySource,
|
|
162
168
|
Key: debKey,
|
|
163
169
|
CacheControl: maxAge,
|
package/lib/generators/hook.js
CHANGED
|
@@ -30,7 +30,7 @@ class Hook extends Generator {
|
|
|
30
30
|
this.pjson.oclif = this.pjson.oclif || {};
|
|
31
31
|
this.pjson.oclif.hooks = this.pjson.oclif.hooks || {};
|
|
32
32
|
const hooks = this.pjson.oclif.hooks;
|
|
33
|
-
const p = `./
|
|
33
|
+
const p = `./dist/hooks/${this.options.event}/${this.options.name}`;
|
|
34
34
|
if (hooks[this.options.event]) {
|
|
35
35
|
hooks[this.options.event] = _.castArray(hooks[this.options.event]);
|
|
36
36
|
hooks[this.options.event] = hooks[this.options.event].concat(p);
|
package/lib/version-indexes.js
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oclif",
|
|
3
3
|
"description": "oclif: create your own CLI",
|
|
4
|
-
"version": "3.2.
|
|
4
|
+
"version": "3.2.3",
|
|
5
5
|
"author": "Salesforce",
|
|
6
6
|
"bin": {
|
|
7
7
|
"oclif": "bin/run"
|
|
@@ -142,4 +142,4 @@
|
|
|
142
142
|
"registry": "https://registry.npmjs.org"
|
|
143
143
|
},
|
|
144
144
|
"types": "lib/index.d.ts"
|
|
145
|
-
}
|
|
145
|
+
}
|