@oclif/core 1.19.0 → 1.19.2

package/README.md

@@ -21,20 +21,20 @@ The [cli-ux README](./src/cli-ux/README.md) also contains detailed usage example
 Usage
 =====
 
-Without the generator, you can create a simple CLI like this:
+We strongly encourage you generate an oclif CLI using the [oclif cli](https://github.com/oclif/oclif). The generator will generate an npm package with `@oclif/core` as a dependency.
 
-**TypeScript**
-```js
+You can, however, use `@oclif/core` in a standalone script like this:
+```typescript
 #!/usr/bin/env ts-node
 
 import * as fs from 'fs'
 import {Command, Flags} from '@oclif/core'
 
 class LS extends Command {
+  static description = 'List the files in a directory.'
   static flags = {
     version: Flags.version(),
     help: Flags.help(),
-    // run with --dir= or -d=
     dir: Flags.string({
       char: 'd',
       default: process.cwd(),
@@ -43,34 +43,23 @@ class LS extends Command {
 
   async run() {
     const {flags} = await this.parse(LS)
-    let files = fs.readdirSync(flags.dir)
-    for (let f of files) {
+    const files = fs.readdirSync(flags.dir)
+    for (const f of files) {
       this.log(f)
     }
   }
 }
 
-LS.run()
-.catch(require('@oclif/core/handle'))
+LS.run().then(() => {
+  require('@oclif/core/flush')
+}, () => {
+  require('@oclif/core/handle')
+})
 ```
 
-Then run either of these with:
+Then run it like this:
 
 ```sh-session
-$ ./myscript
+$ ts-node myscript.ts
 ...files in current dir...
-$ ./myscript --dir foobar
-...files in ./foobar...
-$ ./myscript --version
-myscript/0.0.0 darwin-x64 node-v9.5.0
-$ ./myscript --help
-USAGE
-  $ @oclif/core
-
-OPTIONS
-  -d, --dir=dir  [default: /Users/jdickey/src/github.com/oclif/core]
-  --help         show CLI help
-  --version      show CLI version
 ```
-
-See the [generator](https://github.com/oclif/oclif) for all the options you can pass to the command.

package/lib/config/config.js

@@ -642,6 +642,7 @@ async function toCached(c, plugin) {
                 helpGroup: flag.helpGroup,
                 allowNo: flag.allowNo,
                 dependsOn: flag.dependsOn,
+                relationships: flag.relationships,
                 exclusive: flag.exclusive,
                 deprecated: flag.deprecated,
                 aliases: flag.aliases,
@@ -701,7 +702,7 @@ async function toCached(c, plugin) {
         args,
     };
     // do not include these properties in manifest
-    const ignoreCommandProperties = ['plugin', '_flags'];
+    const ignoreCommandProperties = ['plugin', '_flags', '_enableJsonFlag', '_globalFlags'];
     const stdKeys = Object.keys(stdProperties);
     const keysToAdd = Object.keys(c).filter(property => ![...stdKeys, ...ignoreCommandProperties].includes(property));
     const additionalProperties = {};

package/lib/flags.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.help = exports.version = exports.enum = exports._enum = exports.custom = exports.option = exports.build = exports.string = exports.file = exports.directory = exports.url = exports.integer = exports.boolean = void 0;
 const parser_1 = require("./parser");
+const help_1 = require("./help");
 var parser_2 = require("./parser");
 Object.defineProperty(exports, "boolean", { enumerable: true, get: function () { return parser_2.boolean; } });
 Object.defineProperty(exports, "integer", { enumerable: true, get: function () { return parser_2.integer; } });
@@ -41,7 +42,8 @@ const help = (opts = {}) => {
         description: 'Show CLI help.',
         ...opts,
         parse: async (_, cmd) => {
-            cmd._help();
+            new help_1.Help(cmd.config).showHelp(cmd.argv);
+            cmd.exit(0);
         },
     });
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/core",
   "description": "base library for oclif CLIs",
-  "version": "1.19.0",
+  "version": "1.19.2",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/core/issues",
   "dependencies": {