Make generate-types pipe instead

Author: kyle-ssg

.gitignore

@@ -10,3 +10,5 @@ node_modules
 oclif.manifest.json
 .idea
 flagsmith.json
+FlagsmithTypes.ts
+tsconfig.tsbuildinfo

README.md

@@ -53,7 +53,7 @@ $ npm install -g flagsmith-cli
 $ flagsmith COMMAND
 running command...
 $ flagsmith (--version)
-flagsmith-cli/0.1.2 darwin-arm64 node-v18.13.0
+flagsmith-cli/0.3.0 darwin-arm64 node-v18.20.4
 $ flagsmith --help [COMMAND]
 USAGE
   $ flagsmith COMMAND
@@ -62,38 +62,70 @@ USAGE
 <!-- usagestop -->
 # Commands
 <!-- commands -->
+* [`flagsmith generate-types PROJECT`](#flagsmith-generate-types-project)
 * [`flagsmith get [ENVIRONMENT]`](#flagsmith-get-environment)
 * [`flagsmith help [COMMANDS]`](#flagsmith-help-commands)
 
+## `flagsmith generate-types PROJECT`
+
+Fetch Flagsmith feature flags as JSON. By default pipes to stdout, allowing use with other tools; or write to a file with -o.
+
+```
+USAGE
+  $ flagsmith generate-types PROJECT [-a <value>] [-o <value>] [-e <value>] [-p]
+
+ARGUMENTS
+  PROJECT  Flagsmith project ID
+
+FLAGS
+  -a, --api=<value>      [default: https://api.flagsmith.com] The API endpoint (if self-hosted)
+  -e, --exclude=<value>  Comma-separated list of feature names to exclude
+  -o, --output=<value>   Write the fetched JSON to a file instead of stdout
+  -p, --parseObjects     (experimental) Include full object values when fetching features
+
+DESCRIPTION
+  Fetch Flagsmith feature flags as JSON. By default pipes to stdout, allowing use with other tools; or write to a file
+  with -o.
+
+EXAMPLES
+  export FLAGSMITH_API_KEY=YOUR_KEY flagsmith generate-types PROJECT_ID | npx quicktype \
+        --src-lang json \
+        --lang typescript \
+        --just-types \
+        --explicit-unions \
+        --acronym-style camel \
+        --top-level FlagsmithTypes \
+        -o FlagsmithTypes.ts
+
+  export FLAGSMITH_API_KEY=YOUR_KEY flagsmith generate-types PROJECT_ID -o features.json
+```
+
+_See code: [src/commands/generate-types/index.ts](https://github.com/Flagsmith/flagsmith-cli/blob/v0.3.0/src/commands/generate-types/index.ts)_
+
 ## `flagsmith get [ENVIRONMENT]`
 
 Retrieve flagsmith features from the Flagsmith API and output them to a file.
 
 ```
 USAGE
-  $ flagsmith get [ENVIRONMENT] [-o <value>] [-a <value>] [-t
-    <value> -i <value>] [-p] [-e flags|environment]
+  $ flagsmith get [ENVIRONMENT] [-o <value>] [-a <value>] [-t <trait_key>=<trait_value>... -i <value>]
+    [-p] [-e flags|environment]
 
 ARGUMENTS
-  ENVIRONMENT  The flagsmith environment key to use, defaults to the environment
-               variable FLAGSMITH_ENVIRONMENT
+  ENVIRONMENT  The flagsmith environment key to use, defaults to the environment variable FLAGSMITH_ENVIRONMENT
 
 FLAGS
-  -a, --api=<value>      [default: https://edge.api.flagsmith.com/api/v1/] The
-                         API URL to fetch the feature flags from
-  -e, --entity=<option>  [default: flags] The entity to fetch, this will either
-                         be the flags or an environment document used for [local
-                         evaluation](https://docs.flagsmith.com/clients/server-s
-                         ide#local-evaluation-mode-network-behaviour).
+  -a, --api=<value>      [default: https://edge.api.flagsmith.com/api/v1/] The API URL to fetch the feature flags from
+  -e, --entity=<option>  [default: flags] The entity to fetch, this will either be the flags or an environment document
+                         used for [local evaluation](https://docs.flagsmith.com/clients/server-side#local-evaluation-mod
+                         e-network-behaviour).
                          <options: flags|environment>
   -o, --output=<value>   [default: ./flagsmith.json] The file path output
   -p, --pretty           Prettify the output JSON
 
 IDENTITY FLAGS
-  -i, --identity=<value>                    The identity for which to fetch
-                                            feature flags
-  -t, --trait=<trait_key>=<trait_value>...  Trait key-value pair, separated by
-                                            an equals sign (=)
+  -i, --identity=<value>                    The identity for which to fetch feature flags
+  -t, --trait=<trait_key>=<trait_value>...  Trait key-value pair, separated by an equals sign (=)
 
 DESCRIPTION
   Retrieve flagsmith features from the Flagsmith API and output them to a file.
@@ -116,46 +148,18 @@ EXAMPLES
   $ flagsmith get -p
 ```
 
-_See code: [dist/commands/get/index.ts](https://github.com/Flagsmith/flagsmith-cli/blob/v0.1.4/dist/commands/get/index.ts)_
-
-## `flagsmith generate-types [ENVIRONMENT]`
-
-Generate a fully typed set of your project's current features. 
-
-Note: This requires an API Key that is either generated for organisation settings or found in your account.
-
-```
-USAGE
-  $ FLAGSMITH_API_KEY=<KEY> flagsmith generate-types [PROJECT_ID]
-
-ARGUMENTS
-  PROJECT_ID  The flagsmith project id you are fetching the types for.
-
-FLAGS
-  -a, --api=<value>      [default: https://edge.api.flagsmith.com/api/v1/] The
-                         API URL to fetch the feature flags from
-  -e, --exclude          [default: null] Exclude any feature you intend to remove, can be a csv e.g feature_a,feature_b.
-  -o, --output=<value>   [default: ./flagsmith.d.ts] The file path output
-  -p, --pretty           Prettify the output JSON
-
-DESCRIPTION
-  Retrieve type definitions for the features and their possible remote configuration values.
-```
-
-
-
-_See code: [dist/commands/get/index.ts](https://github.com/Flagsmith/flagsmith-cli/blob/v0.1.4/dist/commands/get/index.ts)_
+_See code: [src/commands/get/index.ts](https://github.com/Flagsmith/flagsmith-cli/blob/v0.3.0/src/commands/get/index.ts)_
 
 ## `flagsmith help [COMMANDS]`
 
 Display help for flagsmith.
 
 ```
 USAGE
-  $ flagsmith help [COMMANDS] [-n]
+  $ flagsmith help [COMMANDS...] [-n]
 
 ARGUMENTS
-  COMMANDS  Command to show help for.
+  COMMANDS...  Command to show help for.
 
 FLAGS
   -n, --nested-commands  Include all nested commands in the output.
@@ -164,6 +168,8 @@ DESCRIPTION
   Display help for flagsmith.
 ```
 
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
+
 ### Type generation examples
 
 [1 - Adding a remote config.mov](1%20-%20Adding%20a%20remote%20config.mov)

package.json

@@ -21,8 +21,7 @@
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^2.0.1",
     "flagsmith": "^9.0.5",
-    "node-fetch": "^2.6.6",
-    "quicktype": "^23.0.170"
+    "node-fetch": "^2.6.6"
   },
   "devDependencies": {
     "@oclif/test": "^2.1.1",
@@ -38,6 +37,7 @@
     "mocha": "^11.1.0",
     "nodemon": "^3.1.0",
     "oclif": "^4.17.41",
+    "quicktype": "^23.0.170",
     "shx": "^0.3.3",
     "ts-node": "^10.2.1",
     "tslib": "^2.3.1",

src/commands/generate-types/index.ts

@@ -1,49 +1,55 @@
 import {Args, Command, Flags} from '@oclif/core'
-import jsonToTypescript from '../../util/json-to-typescript'
 import getAllFeatures from '../../util/get-all-features'
 import * as fs from 'node:fs'
 
-const api = 'https://api.flagsmith.com'
+const DEFAULT_API = 'https://api.flagsmith.com'
 let apiKey = ''
 
 export default class FlagsmithGenerateTypes extends Command {
-  static description = 'Generate TypeScript types from a Flagsmith Project'
+  static description = 'Fetch Flagsmith feature flags as JSON. By default pipes to stdout, allowing use with other tools; or write to a file with -o.'
+
   static examples = [
-    'export FLAGSMITH_API_KEY=API_KEY flagsmith generate-types PROJECT_ID',
-    'export FLAGSMITH_API_KEY=API_KEY flagsmith generate-types PROJECT_ID -a https://selfhosted-flagsmith.example.com',
-    'export FLAGSMITH_API_KEY=API_KEY flagsmith generate-types PROJECT_ID -o ./my-file.d.ts',
-    'export FLAGSMITH_API_KEY=API_KEY flagsmith generate-types PROJECT_ID -e feature_to_exclude',
+    `export FLAGSMITH_API_KEY=YOUR_KEY flagsmith generate-types PROJECT_ID | npx quicktype \\
+      --src-lang json \\
+      --lang typescript \\
+      --just-types \\
+      --explicit-unions \\
+      --acronym-style camel \\
+      --top-level FlagsmithTypes \\
+      -o FlagsmithTypes.ts`,
+    'export FLAGSMITH_API_KEY=YOUR_KEY flagsmith generate-types PROJECT_ID -o features.json',
   ]
 
   static flags = {
     api: Flags.string({
       char: 'a',
-      description: 'The API to use if you are self hosted',
+      description: 'The API endpoint (if self-hosted)',
       required: false,
-      default: 'https://api.flagsmith.com',
+      default: DEFAULT_API,
     }),
     output: Flags.string({
       char: 'o',
-      description: 'The file path output',
+      description: 'Write the fetched JSON to a file instead of stdout',
       required: false,
-      default: './flagsmith.d.ts',
     }),
     exclude: Flags.string({
       char: 'e',
-      description: 'Comma separated list of feature names to exclude from type generation to test feature removal',
+      description: 'Comma-separated list of feature names to exclude',
+      required: false,
+    }),
+    parseObjects: Flags.boolean({
+      char: 'p',
+      description: '(experimental) Include full object values when fetching features',
       required: false,
+      default: false,
     }),
   }
 
   static args = {
     project: Args.string({
-      description: 'The flagsmith project id to retrieve the features from',
+      description: 'Flagsmith project ID',
       required: true,
     }),
-    output: Args.string({
-      description: 'The flagsmith project id to retrieve the features from',
-      required: false,
-    }),
   }
 
   async run(): Promise<void> {
@@ -55,22 +61,43 @@ export default class FlagsmithGenerateTypes extends Command {
 
     apiKey = process.env.FLAGSMITH_API_KEY
 
-    const features = await getAllFeatures({project: `${args.project}`, apiKey, api})
+    const options: {
+      project: string
+      apiKey: string
+      api: string
+      parseObjects: boolean
+    } = {
+      project: args.project,
+      apiKey,
+      api: flags.api,
+      parseObjects: Boolean(flags.parseObjects),
+    }
+
+    if (flags.parseObjects) {
+      this.warn('⚠️ Experimental: parsing full flag objects')
+    }
+
+    const features = await getAllFeatures(options)
+
+    // Exclude specified flags
     const excludeList = flags.exclude?.split(',').map(name => name.trim())
     if (excludeList?.length) {
-      excludeList.map((feature: any) => {
-        console.log('Excluding flag', feature)
-        features.map(environmentFeature => {
-          delete environmentFeature[feature]
-        })
-      })
+      for (const featureName of excludeList) {
+        this.warn(`Excluding flag ${featureName}`)
+        for (const envFeat of features) {
+          delete envFeat[featureName]
+        }
+      }
     }
 
     const jsonString = JSON.stringify(features)
-    const output = flags.output
 
-    const ts = await jsonToTypescript(jsonString)
-    console.log('Outputting types to', output)
-    fs.writeFileSync(output, ts)
+    if (flags.output) {
+      this.warn(`Writing JSON to ${flags.output}`)
+      fs.writeFileSync(flags.output, jsonString)
+    } else {
+      // Pipe JSON to stdout for further processing
+      process.stdout.write(jsonString)
+    }
   }
 }

src/util/get-all-features.ts

@@ -3,8 +3,8 @@ import {createFlagsmithInstance} from 'flagsmith/isomorphic'
 import {IFlagsmithFeature} from 'flagsmith'
 import doGet from './doGet'
 
-export default async function (data: { apiKey: string, api: string, project: string }) {
-  const {api, apiKey, project} = data
+export default async function (data: { apiKey: string, api: string, project: string, parseObjects: boolean }) {
+  const {api, apiKey, project, parseObjects} = data
   const getReq = doGet(api, apiKey)
   const environments: { api_key: string, id: number }[] = await getReq(`projects/${project}/environments/`)
   return Promise.all(environments.map(v => {
@@ -13,7 +13,7 @@ export default async function (data: { apiKey: string, api: string, project: str
       const features: Record<string, IFlagsmithFeature['value']> = {}
       for (const key of Object.keys(instance.getAllFlags())) {
         let value = instance.getValue(key)
-        if (typeof value === 'string') {
+        if (typeof value === 'string' && parseObjects) {
           try {
             value = JSON.parse(value)
           } catch {}