feat: have --json global flag disabled by default (#252)

oclif · Sep 15, 2021 · c2a7799 · c2a7799
1 parent b89c94b
commit c2a7799
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/src/command.ts b/src/command.ts
@@ -90,7 +90,7 @@ export default abstract class Command {
 
   static parserOptions = {}
 
-  static disableJsonFlag: boolean | undefined
+  static enableJsonFlag = false
 
   // eslint-disable-next-line valid-jsdoc
   /**
@@ -127,7 +127,7 @@ export default abstract class Command {
   }
 
   static set flags(flags: Interfaces.FlagInput<any>) {
-    this._flags = this.disableJsonFlag || settings.disableJsonFlag ? flags : Object.assign({}, Command.globalFlags, flags)
+    this._flags = this.enableJsonFlag || settings.enableJsonFlag ? Object.assign({}, Command.globalFlags, flags) : flags
   }
 
   id: string | undefined
@@ -193,7 +193,7 @@ export default abstract class Command {
   }
 
   public jsonEnabled(): boolean {
-    return !this.ctor.disableJsonFlag && this.argv.includes('--json')
+    return this.ctor.enableJsonFlag && this.argv.includes('--json')
   }
 
   /**

diff --git a/src/settings.ts b/src/settings.ts
@@ -31,9 +31,9 @@ export type Settings = {
    */
   tsnodeEnabled?: boolean;
   /**
-   * Disable the --json flag for all commands
+   * Enable the --json flag for all commands
    */
-  disableJsonFlag?: boolean;
+  enableJsonFlag?: boolean;
 };
 
 // Set global.oclif to the new object if it wasn't set before

diff --git a/test/help/format-command.test.ts b/test/help/format-command.test.ts
@@ -45,6 +45,8 @@ describe('formatCommand', () => {
       static description = `first line
 multiline help`
 
+      static enableJsonFlag = true
+
       static args = [{name: 'app_name', description: 'app to use'}]
 
       static flags = {
@@ -97,6 +99,8 @@ ALIASES
 
         static aliases = ['app:init', 'create']
 
+        static enableJsonFlag = true
+
         static args = [{name: 'app_name', description: 'app to use'.repeat(35)}]
 
         static flags = {
@@ -149,6 +153,8 @@ ALIASES
 
         static aliases = ['app:init', 'create']
 
+        static enableJsonFlag = true
+
         static args = [{name: 'app_name', description: 'app to use'.repeat(35)}]
 
         static flags = {
@@ -238,6 +244,8 @@ DESCRIPTION
 
         static aliases = ['app:init', 'create']
 
+        static enableJsonFlag = true
+
         static args = [{name: 'app_name', description: 'app to use'}]
 
         static flags = {