Improved argument parsing for the CLI

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v7.0.2 (05/10/2025)
+
+- Improved argument parsing for CLI.
+- Updated dependencies.
+
 ## v7.0.1 (30/09/2025)
 
 - Fixed bug where descriptions were not set for repeated columns.

bin/jsbq

@@ -1,13 +1,15 @@
 #!/usr/bin/env node
 
-const jsbq = (module.exports = {})
-
 const gbq = require('../src/gbq')
 const { get_table_id } = require('../src/utils')
 const converter = require('../src/converter')
 const { logger } = require('../src/log')
 const fs = require('fs')
 const { promisify } = require('util')
+const yargs = require('yargs')
+const hideBin = require('yargs/helpers').hideBin
+
+const jsbq = (module.exports = {})
 
 jsbq.process = async (project, datasetName, jsonSchema, options) => {
   logger.info('Processing JSON schema...')
@@ -47,20 +49,28 @@ jsbq.process = async (project, datasetName, jsonSchema, options) => {
 jsbq.run = async () => {
   const readFile = promisify(fs.readFile)
 
-  const argv = require('yargs')
+  const argv = yargs(hideBin(process.argv))
     .usage(
       'Usage: $0 -p [project] -d [dataset] -j <json schema file> --preventAdditionalObjectProperties --continueOnError',
     )
+    .version(false)
+    .help(false)
     .options({
       j: {
         describe: 'JSON schema file',
         demandOption: true,
+        type: 'string',
+        requiresArg: true,
       },
       p: {
         describe: 'GCP project name',
+        type: 'string',
+        requiresArg: true,
       },
       d: {
         describe: 'BigQuery dataset name',
+        type: 'string',
+        requiresArg: true,
       },
       preventAdditionalObjectProperties: {
         describe: 'boolean, check for additional object properties in schemas.',
@@ -78,7 +88,8 @@ jsbq.run = async () => {
         type: 'boolean',
         default: false,
       },
-    }).argv
+    })
+    .parse()
 
   if (argv.debug) {
     logger.level = 'debug'

package.json

@@ -1,11 +1,11 @@
 {
   "name": "jsonschema-bigquery",
-  "version": "7.0.1",
+  "version": "7.0.2",
   "description": "Convert JSON schema to Google BigQuery schema",
   "main": "src/converter.js",
   "scripts": {
     "ci": "npm run lint && npm run coverage",
-    "test": "mocha test/unit test/integration",
+    "test": "mocha test/unit test/integration test/system",
     "coverage": "nyc npm run test",
     "lint:eslint": "eslint .",
     "lint:prettier": "prettier -c .",
@@ -47,7 +47,8 @@
     "eslint-plugin-promise": "^7.0.0",
     "mocha": "^11.0.1",
     "nyc": "^17.0.0",
-    "prettier": "^3.3.3"
+    "prettier": "^3.3.3",
+    "sinon": "^21.0.0"
   },
   "dependencies": {
     "@google-cloud/bigquery": "^8.0.0",

test/system/cli.js

@@ -0,0 +1,24 @@
+const assert = require('assert')
+const execSync = require('child_process').execSync
+
+describe('CLI', () => {
+  context('without args', () => {
+    it('shows help', () => {
+      try {
+        execSync('bin/jsbq')
+      } catch (e) {
+        const output = e.stderr.toString()
+        assert.match(output, /Usage:/)
+      }
+    })
+  })
+
+  context('with a schema', () => {
+    it('shows GBQ output', () => {
+      const output = execSync(
+        'bin/jsbq -j test/integration/samples/allOf/input.json',
+      ).toString()
+      assert.match(output, /RECORD/)
+    })
+  })
+})