Scaffolding for TypeScript CLI

.github/workflows/build-pr.yml

@@ -65,7 +65,10 @@ jobs:
             [Pull request has been updated, please wait for latest changes to be pushed to npm...]
 
       - name: Install dependencies
-        run: npm install
+        run: |
+          npm install
+          cd cli
+          npm install
 
       - name: Compile
         run: npm run build
@@ -133,7 +136,10 @@ jobs:
           cache: 'npm'
 
       - name: Install dependencies
-        run: npm install
+        run: |
+          npm install
+          cd cli
+          npm install
 
       - name: Compile
         run: npm run build
@@ -142,7 +148,8 @@ jobs:
         run: npm run lint
 
       - name: Test
-        run: npm test
+        run: |
+          npm test
         env:
           XATA_DATABASE_URL: ${{ secrets.INTEGRATION_TEST_DATABASE_URL }}
           XATA_API_KEY: ${{ secrets.INTEGRATION_TEST_API_KEY }}

cli/.eslintignore

@@ -0,0 +1 @@
+/dist

cli/.gitignore

@@ -0,0 +1,10 @@
+*-debug.log
+*-error.log
+/.nyc_output
+/dist
+/lib
+/package-lock.json
+/tmp
+/yarn.lock
+node_modules
+oclif.manifest.json

cli/README.md

@@ -0,0 +1 @@
+# Xata CLI

cli/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

cli/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

cli/bin/mokey-patch-oclif.js

@@ -0,0 +1,68 @@
+/**
+ * Oclif mostly supports ESM, but it doesn't properly support commands
+ * in "index.js" files. It always thinks they are not ESM files.
+ *
+ * This file monkey-patches Oclif with the code
+ * from this PR https://github.com/oclif/core/pull/417 to support them.
+ */
+import { tsPath } from '@oclif/core';
+import ModuleLoader from '@oclif/core/lib/module-loader.js';
+import fs from 'fs';
+import path from 'path';
+
+ModuleLoader.default.resolvePath = (config, modulePath) => {
+  let isESM;
+  let filePath;
+
+  try {
+    // eslint-disable-next-line no-undef
+    filePath = require.resolve(modulePath);
+    isESM = ModuleLoader.default.isPathModule(filePath);
+  } catch {
+    filePath = tsPath(config.root, modulePath);
+
+    let fileExists = false;
+    let isDirectory = false;
+    if (fs.existsSync(filePath)) {
+      fileExists = true;
+      try {
+        if (fs.lstatSync(filePath)?.isDirectory?.()) {
+          fileExists = false;
+          isDirectory = true;
+        }
+      } catch {
+        // ignore
+      }
+    }
+
+    if (!fileExists) {
+      // Try all supported extensions.
+      let foundPath = findFile(filePath);
+      if (!foundPath && isDirectory) {
+        // Since filePath is a directory, try looking for index.js file.
+        foundPath = findFile(path.join(filePath, 'index'));
+      }
+
+      if (foundPath) {
+        filePath = foundPath;
+      }
+    }
+
+    isESM = ModuleLoader.default.isPathModule(filePath);
+  }
+
+  return { isESM, filePath };
+};
+
+function findFile(filePath) {
+  // eslint-disable-next-line camelcase
+  for (const extension of ['.js', '.cjs']) {
+    const testPath = `${filePath}${extension}`;
+
+    if (fs.existsSync(testPath)) {
+      return testPath;
+    }
+  }
+
+  return null;
+}

cli/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

cli/bin/run.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { Errors, flush, run } from '@oclif/core';
+import './mokey-patch-oclif.js';
+
+run(void 0, import.meta.url)
+  .then(flush)
+  .catch(Errors.handle);

cli/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@xata.io/xata",
+  "version": "0.0.0",
+  "description": "Xata.io CLI",
+  "author": "Xata Inc.",
+  "bin": {
+    "xata": "./bin/run"
+  },
+  "homepage": "https://github.com/xataio/client-ts",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "type": "module",
+  "repository": "xataio/client-ts",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^1.8.1",
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.0.1"
+  },
+  "devDependencies": {
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.2",
+    "globby": "^11",
+    "oclif": "^3",
+    "shx": "^0.3.3",
+    "ts-node": "^10.2.1",
+    "tslib": "^2.3.1",
+    "typescript": "^4.4.3"
+  },
+  "oclif": {
+    "bin": "xata",
+    "dirname": "xata",
+    "commands": "./dist/commands",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " ",
+    "topics": {
+      "hello": {
+        "description": "Say hello to the world and others"
+      }
+    }
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "bugs": "https://github.com/xataio/client-ts/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts"
+}

cli/src/commands/branches/create.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+
+export default class BranchesCreate extends Command {
+  static description = 'Create a branch';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    this.error('To be done');
+  }
+}

cli/src/commands/branches/delete.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+
+export default class BranchesDelete extends Command {
+  static description = 'Delete a branch';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    this.error('To be done');
+  }
+}

cli/src/commands/branches/index.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+
+export default class Branches extends Command {
+  static description = 'List, create and delete branches';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    // const { args, flags } = await this.parse(Branches);
+
+    this.error('To be done');
+  }
+}

cli/src/commands/branches/list.test.ts

@@ -0,0 +1,10 @@
+import { Config } from '@oclif/core';
+import { expect, test } from 'vitest';
+import BranchesList from './list.js';
+
+test('branches list', async () => {
+  const config = await Config.load();
+  const list = new BranchesList([], config as Config);
+
+  await expect(list.run()).rejects.toThrow('To be done');
+});

cli/src/commands/branches/list.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+
+export default class BranchesList extends Command {
+  static description = 'List branches';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    this.error('To be done');
+  }
+}

cli/src/commands/browse/index.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+
+export default class Browse extends Command {
+  static description = 'Open the current database in the browser';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    // const { args, flags } = await this.parse(Browse);
+
+    this.error('To be done');
+  }
+}

cli/src/commands/dbs/create.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+
+export default class DatabasesCreate extends Command {
+  static description = 'Create a database';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    this.error('To be done');
+  }
+}

cli/src/commands/dbs/delete.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+
+export default class DatabasesDelete extends Command {
+  static description = 'Delete a database';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    this.error('To be done');
+  }
+}

cli/src/commands/dbs/index.ts

@@ -0,0 +1,17 @@
+import { Command } from '@oclif/core';
+
+export default class Databases extends Command {
+  static description = 'List, create and delete databases';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    // const { args, flags } = await this.parse(Databases);
+
+    this.error('To be done');
+  }
+}

cli/src/commands/dbs/list.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+
+export default class DatabasesList extends Command {
+  static description = 'List your databases';
+
+  static examples = [];
+
+  static flags = {};
+
+  static args = [];
+
+  async run(): Promise<void> {
+    this.error('To be done');
+  }
+}