neonctl 2.21.2 → 2.22.2

package/context.test.js

@@ -0,0 +1,119 @@
+import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync, } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { afterEach, beforeEach, describe, expect, test } from 'vitest';
+import { applyContext, currentContextFile, ensureGitignored, } from './context.js';
+describe('currentContextFile', () => {
+    let workspace;
+    beforeEach(() => {
+        workspace = mkdtempSync(join(tmpdir(), 'neonctl-ctx-'));
+    });
+    afterEach(() => {
+        rmSync(workspace, { recursive: true, force: true });
+    });
+    test('defaults to <cwd>/.neon when no .neon exists anywhere upward', () => {
+        const sub = join(workspace, 'sub');
+        mkdirSync(sub);
+        expect(currentContextFile(sub)).toBe(join(sub, '.neon'));
+    });
+    test('walks up to an existing .neon in a parent directory', () => {
+        writeFileSync(join(workspace, '.neon'), JSON.stringify({ projectId: 'parent-project' }));
+        const sub = join(workspace, 'nested', 'deeper');
+        mkdirSync(sub, { recursive: true });
+        expect(currentContextFile(sub)).toBe(join(workspace, '.neon'));
+    });
+    test('does NOT walk up for unrelated project markers (package.json, .git)', () => {
+        // Regression: previously `currentContextFile` treated `package.json` and
+        // `.git` as project markers and walked up to them, which made
+        // `neonctl link` from a fresh sub-directory inside an existing repo land
+        // its `.neon` at the parent repo's root instead of the cwd.
+        writeFileSync(join(workspace, 'package.json'), '{}');
+        mkdirSync(join(workspace, '.git'));
+        const sub = join(workspace, 'fresh-sub');
+        mkdirSync(sub);
+        expect(currentContextFile(sub)).toBe(join(sub, '.neon'));
+    });
+});
+describe('ensureGitignored', () => {
+    let workspace;
+    beforeEach(() => {
+        workspace = mkdtempSync(join(tmpdir(), 'neonctl-gi-'));
+    });
+    afterEach(() => {
+        rmSync(workspace, { recursive: true, force: true });
+    });
+    test('creates a .gitignore listing .neon when none exists', () => {
+        const contextFile = join(workspace, '.neon');
+        ensureGitignored(contextFile);
+        const gitignore = readFileSync(join(workspace, '.gitignore'), 'utf-8');
+        expect(gitignore).toBe('.neon\n');
+    });
+    test('appends .neon to an existing .gitignore that does not have it', () => {
+        const gi = join(workspace, '.gitignore');
+        writeFileSync(gi, 'node_modules\ndist\n');
+        ensureGitignored(join(workspace, '.neon'));
+        expect(readFileSync(gi, 'utf-8')).toBe('node_modules\ndist\n.neon\n');
+    });
+    test('does not duplicate .neon when already present', () => {
+        const gi = join(workspace, '.gitignore');
+        writeFileSync(gi, 'node_modules\n.neon\ndist\n');
+        ensureGitignored(join(workspace, '.neon'));
+        expect(readFileSync(gi, 'utf-8')).toBe('node_modules\n.neon\ndist\n');
+    });
+    test('tolerates a .gitignore that has no trailing newline', () => {
+        const gi = join(workspace, '.gitignore');
+        writeFileSync(gi, 'node_modules');
+        ensureGitignored(join(workspace, '.neon'));
+        expect(readFileSync(gi, 'utf-8')).toBe('node_modules\n.neon\n');
+    });
+    test('treats surrounding whitespace as part of the line', () => {
+        const gi = join(workspace, '.gitignore');
+        // Trailing spaces around the entry should still count as a match.
+        writeFileSync(gi, '  .neon  \n');
+        ensureGitignored(join(workspace, '.neon'));
+        expect(readFileSync(gi, 'utf-8')).toBe('  .neon  \n');
+    });
+    test('does NOT match partial entries like *.neon or foo/.neon', () => {
+        const gi = join(workspace, '.gitignore');
+        writeFileSync(gi, '*.neon\nfoo/.neon\n');
+        ensureGitignored(join(workspace, '.neon'));
+        expect(readFileSync(gi, 'utf-8')).toBe('*.neon\nfoo/.neon\n.neon\n');
+    });
+});
+describe('applyContext', () => {
+    let workspace;
+    beforeEach(() => {
+        workspace = mkdtempSync(join(tmpdir(), 'neonctl-apply-'));
+    });
+    afterEach(() => {
+        rmSync(workspace, { recursive: true, force: true });
+    });
+    test('scaffolds .gitignore only when the context file is created', () => {
+        const file = join(workspace, '.neon');
+        applyContext(file, {
+            orgId: 'org-x',
+            projectId: 'proj-y',
+            branchId: 'br-z',
+        });
+        expect(JSON.parse(readFileSync(file, 'utf-8'))).toEqual({
+            orgId: 'org-x',
+            projectId: 'proj-y',
+            branchId: 'br-z',
+        });
+        expect(readFileSync(join(workspace, '.gitignore'), 'utf-8')).toBe('.neon\n');
+    });
+    test('does NOT re-add .neon to .gitignore on updates to an existing file', () => {
+        const file = join(workspace, '.neon');
+        // First write creates the file and scaffolds .gitignore.
+        applyContext(file, { projectId: 'proj-y', branchId: 'br-1' });
+        // The user deliberately un-ignores .neon (e.g. to commit shared context).
+        writeFileSync(join(workspace, '.gitignore'), 'node_modules\n');
+        // A subsequent update must NOT re-add the entry.
+        applyContext(file, { projectId: 'proj-y', branchId: 'br-2' });
+        expect(JSON.parse(readFileSync(file, 'utf-8'))).toEqual({
+            projectId: 'proj-y',
+            branchId: 'br-2',
+        });
+        expect(readFileSync(join(workspace, '.gitignore'), 'utf-8')).toBe('node_modules\n');
+    });
+});

package/index.js

@@ -33,7 +33,10 @@ const NO_SUBCOMMANDS_VERBS = [
     // aliases
     'cs',
     'connection-string',
+    'psql',
     'set-context',
+    'checkout',
+    'link',
     'init',
     // aliases
 ];

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "2.21.2",
+  "version": "2.22.2",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -14,62 +14,58 @@
   "engines": {
     "node": ">=18"
   },
+  "packageManager": "pnpm@9.15.9",
   "bin": {
     "neonctl": "cli.js",
     "neon": "cli.js"
   },
   "devDependencies": {
-    "@apidevtools/swagger-parser": "^10.1.0",
-    "@commitlint/cli": "^17.6.5",
-    "@commitlint/config-conventional": "^17.6.5",
-    "@eslint/js": "^9.23.0",
-    "@rollup/plugin-commonjs": "^25.0.2",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.1.0",
-    "@semantic-release/exec": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "@types/bun": "^1.1.4",
-    "@types/cli-table": "^0.3.0",
-    "@types/diff": "^5.2.1",
-    "@types/eslint__js": "^8.42.3",
-    "@types/express": "^4.17.17",
-    "@types/node": "^18.7.13",
+    "@apidevtools/swagger-parser": "10.1.0",
+    "@commitlint/cli": "17.8.1",
+    "@commitlint/config-conventional": "17.8.1",
+    "@eslint/js": "9.29.0",
+    "@rollup/plugin-commonjs": "25.0.8",
+    "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-node-resolve": "15.2.3",
+    "@types/cli-table": "0.3.4",
+    "@types/diff": "5.2.1",
+    "@types/eslint__js": "8.42.3",
+    "@types/express": "4.17.21",
+    "@types/node": "18.19.41",
     "@types/prompts": "2.4.9",
-    "@types/validate-npm-package-name": "4.0.2",
-    "@types/which": "^3.0.0",
-    "@types/yargs": "^17.0.24",
-    "emocks": "^3.0.1",
-    "eslint": "^9.23.0",
-    "express": "^4.18.2",
-    "husky": "^8.0.3",
-    "lint-staged": "^13.0.3",
-    "oauth2-mock-server": "^8.1.0",
-    "prettier": "^3.1.0",
-    "rollup": "^3.26.2",
-    "semantic-release": "^23.0.8",
-    "strip-ansi": "^7.1.0",
-    "typescript": "^4.7.4",
+    "@types/which": "3.0.4",
+    "@types/yargs": "17.0.32",
+    "@yao-pkg/pkg": "6.10.0",
+    "emocks": "3.0.4",
+    "eslint": "9.29.0",
+    "express": "4.19.2",
+    "husky": "8.0.3",
+    "lint-staged": "13.3.0",
+    "oauth2-mock-server": "8.1.0",
+    "prettier": "3.3.3",
+    "rollup": "3.29.4",
+    "strip-ansi": "7.1.0",
+    "tsx": "4.22.3",
+    "typescript": "4.9.5",
     "typescript-eslint": "8.28.0",
-    "vitest": "^1.6.0"
+    "vitest": "1.6.1"
   },
   "dependencies": {
     "@neondatabase/api-client": "2.6.0",
-    "@segment/analytics-node": "^1.0.0-beta.26",
-    "@yao-pkg/pkg": "^6.10.0",
-    "axios": "^1.4.0",
-    "axios-debug-log": "^1.0.0",
-    "chalk": "^5.2.0",
-    "cli-table": "^0.3.11",
-    "crypto-random-string": "^5.0.0",
-    "diff": "^5.2.0",
-    "neon-init": "^0.13.1",
-    "open": "^10.1.0",
-    "openid-client": "^6.8.1",
+    "@segment/analytics-node": "1.3.0",
+    "axios": "1.7.2",
+    "axios-debug-log": "1.0.0",
+    "chalk": "5.3.0",
+    "cli-table": "0.3.11",
+    "cliui": "8.0.1",
+    "diff": "5.2.0",
+    "neon-init": "0.14.0",
+    "open": "10.1.0",
+    "openid-client": "6.8.1",
     "prompts": "2.4.2",
-    "validate-npm-package-name": "5.0.1",
-    "which": "^3.0.1",
-    "yaml": "^2.1.1",
-    "yargs": "^17.7.2"
+    "which": "3.0.1",
+    "yaml": "2.4.5",
+    "yargs": "17.7.2"
   },
   "publishConfig": {
     "access": "public",
@@ -93,13 +89,13 @@
   "scripts": {
     "watch": "tsc --watch",
     "typecheck": "tsc --noEmit",
-    "lint": "npm run typecheck && eslint src && prettier --check .",
-    "lint:fix": "npm run typecheck && eslint src --fix && prettier --w .",
-    "build": "bun generateParams && bun clean && tsc && cp src/*.html package*.json README.md ./dist",
+    "lint": "pnpm typecheck && eslint src && prettier --check .",
+    "lint:fix": "pnpm typecheck && eslint src --fix && prettier --w .",
+    "build": "pnpm generateParams && pnpm clean && tsc && cp src/*.html package*.json README.md ./dist",
     "clean": "rm -rf dist",
-    "generateParams": "bun generateOptionsFromSpec.ts",
-    "start": "bun dist/index.js",
-    "pretest": "bun run build",
+    "generateParams": "tsx generateOptionsFromSpec.ts",
+    "start": "node dist/index.js",
+    "pretest": "pnpm build",
     "test": "vitest run",
     "prepare": "test -d .git && husky install || true"
   },

package/utils/enrichers.js

@@ -40,9 +40,26 @@ export const branchIdFromProps = async (props) => {
     props.branchId = await getBranchIdFromProps(props);
     return props.branchId;
 };
+export const resolveSingleDatabase = async (props) => {
+    const { data } = await props.apiClient.listProjectBranchDatabases(props.projectId, props.branchId);
+    const databases = data.databases;
+    if (props.database !== undefined) {
+        if (!databases.find((d) => d.name === props.database)) {
+            throw new Error(`Database not found: ${props.database}. Available databases on branch ${props.branchId}: ${databases.map((d) => d.name).join(', ')}`);
+        }
+        return props.database;
+    }
+    if (databases.length === 0) {
+        throw new Error(`No databases found for the branch: ${props.branchId}`);
+    }
+    if (databases.length === 1) {
+        return databases[0].name;
+    }
+    throw new Error(`Multiple databases found for the branch, please provide one with the --database option: ${databases.map((d) => d.name).join(', ')}`);
+};
 export const fillSingleProject = async (props) => {
     if (props.projectId) {
-        return props;
+        return { ...props, projectId: props.projectId };
     }
     // If no orgId is provided, try to auto-fill it if there's only one org
     let orgId = props.orgId;

package/utils/middlewares.js

@@ -5,7 +5,7 @@
  */
 export const fillInArgs = (args, currentArgs = args, acc = []) => {
     Object.entries(currentArgs).forEach(([k, v]) => {
-        if (k === '_') {
+        if (k === '_' || k === '--') {
             return;
         }
         // check if the value is an Object