neonctl 2.17.1 → 2.18.0

package/commands/branches.js

@@ -10,16 +10,15 @@ import { log } from '../log.js';
 import { parseSchemaDiffParams, schemaDiff } from './schema_diff.js';
 import { getComputeUnits } from '../utils/compute_units.js';
 export const BRANCH_FIELDS = [
-    'id',
     'name',
-    'default',
+    'id',
     'current_state',
     'created_at',
     'expires_at',
 ];
 const BRANCH_FIELDS_RESET = [
-    'id',
     'name',
+    'id',
     'default',
     'current_state',
     'created_at',
@@ -211,11 +210,30 @@ export const handler = (args) => {
     return args;
 };
 const list = async (props) => {
-    const { data } = await props.apiClient.listProjectBranches({
+    const { data: { branches, annotations }, } = await props.apiClient.listProjectBranches({
         projectId: props.projectId,
     });
-    writer(props).end(data.branches, {
+    writer(props).end(branches, {
         fields: BRANCH_FIELDS,
+        renderColumns: {
+            expires_at: (br) => br.expires_at || 'never',
+            name: (br) => {
+                const annotation = annotations[br.id];
+                const isAnon = annotation?.value.anonymized;
+                const result = [];
+                if (br.default) {
+                    result.push('✱');
+                }
+                if (br.protected) {
+                    result.push('⛨');
+                }
+                if (isAnon) {
+                    result.push('[anon]');
+                }
+                result.push(br.name);
+                return result.join(' ');
+            },
+        },
     });
 };
 const create = async (props) => {

package/commands/branches.test.js

@@ -2,9 +2,14 @@ import { describe } from 'vitest';
 import { test } from '../test_utils/fixtures';
 describe('branches', () => {
     /* list */
-    test('list', async ({ testCliCommand }) => {
+    test('list/yaml', async ({ testCliCommand }) => {
         await testCliCommand(['branches', 'list', '--project-id', 'test']);
     });
+    test('list/table output', async ({ testCliCommand }) => {
+        await testCliCommand(['branches', 'list', '--project-id', 'test'], {
+            outputTable: true,
+        });
+    });
     /* create */
     test('create by default with r/w endpoint', async ({ testCliCommand }) => {
         await testCliCommand([

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "2.17.1",
+  "version": "2.18.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",

package/test_utils/fixtures.js

@@ -41,7 +41,7 @@ export const test = originalTest.extend({
                 '--api-host',
                 `http://localhost:${server.address().port}`,
                 '--output',
-                'yaml',
+                options.outputTable ? 'table' : 'yaml',
                 '--api-key',
                 'test-key',
                 '--no-analytics',

package/writer.js

@@ -20,25 +20,28 @@ const writeJson = (chunks) => {
         ])), null, 2);
 };
 const writeTable = (chunks, out) => {
-    chunks.forEach(({ data, config }) => {
+    chunks.forEach(({ data, config: { emptyMessage, fields, title, renderColumns = {} } }) => {
         const arrayData = Array.isArray(data) ? data : [data];
-        if (!arrayData.length && config.emptyMessage) {
-            out.write('\n' + config.emptyMessage + '\n');
+        if (!arrayData.length && emptyMessage) {
+            out.write('\n' + emptyMessage + '\n');
             return;
         }
-        const fields = config.fields.filter((field) => arrayData.some((item) => item[field] !== undefined && item[field] !== ''));
+        const fieldsFiltered = fields.filter((field) => arrayData.some((item) => item[field] !== undefined && item[field] !== ''));
         const table = new Table({
             style: {
                 head: ['green'],
             },
-            head: fields.map((field) => field
+            head: fieldsFiltered.map((field) => field
                 .split('_')
                 .map((word) => word[0].toUpperCase() + word.slice(1))
                 .join(' ')),
         });
         arrayData.forEach((item) => {
-            table.push(fields.map((field) => {
+            table.push(fieldsFiltered.map((field) => {
                 const value = item[field];
+                if (renderColumns[field]) {
+                    return renderColumns[field]?.(item);
+                }
                 return Array.isArray(value)
                     ? value.join('\n')
                     : isObject(value)
@@ -46,8 +49,8 @@ const writeTable = (chunks, out) => {
                         : value;
             }));
         });
-        if (config.title) {
-            out.write((isCi() ? config.title : chalk.bold(config.title)) + '\n');
+        if (title) {
+            out.write((isCi() ? title : chalk.bold(title)) + '\n');
         }
         out.write(table.toString());
         out.write('\n');

package/writer.test.js

@@ -1,86 +1,104 @@
-import { Writable } from 'node:stream';
+import { PassThrough } from 'node:stream';
 import { describe, it, expect } from 'vitest';
 import { writer } from './writer.js';
-class MockWritable extends Writable {
-    constructor() {
-        super(...arguments);
-        this._data = [];
-    }
-    get data() {
-        return this._data.map((chunk) => chunk.toString()).join('');
-    }
-    _write(chunk) {
-        this._data.push(chunk);
-    }
-}
+const getMockWritable = () => {
+    const chunks = [];
+    const stream = new PassThrough();
+    stream.on('data', (chunk) => {
+        chunks.push(chunk.toString());
+    });
+    return {
+        stream,
+        getData: () => {
+            return chunks.join('');
+        },
+    };
+};
 describe('writer', () => {
     describe('outputs yaml', () => {
         it('outputs single data', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'yaml', out: stream });
             out.end({ foo: 'bar' }, { fields: ['foo'] });
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
         it('outputs single data with title', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'yaml', out: stream });
             out.end({ foo: 'bar' }, { fields: ['foo'], title: 'baz' });
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
         it('outputs multiple data', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'yaml', out: stream });
             out
                 .write({ foo: 'bar' }, { fields: ['foo'], title: 'T1' })
                 .write({ baz: 'xyz' }, { fields: ['baz'], title: 'T2' })
                 .end();
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
     });
     describe('outputs json', () => {
         it('outputs single data', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'json', out: stream });
             out.end({ foo: 'bar' }, { fields: ['foo'] });
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
         it('outputs single data with title', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'json', out: stream });
             out.end({ foo: 'bar' }, { fields: ['foo'], title: 'baz' });
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
         it('outputs multiple data', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'json', out: stream });
             out
                 .write({ foo: 'bar' }, { fields: ['foo'], title: 'T1' })
                 .write({ baz: 'xyz' }, { fields: ['baz'], title: 'T2' })
                 .end();
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
     });
     describe('outputs table', () => {
         it('outputs single data', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'table', out: stream });
             out.end({ foo: 'bar', extra: 'extra' }, { fields: ['foo'] });
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
         it('outputs single data with title', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'table', out: stream });
             out.end({ foo: 'bar', extra: 'extra' }, { fields: ['foo'], title: 'baz' });
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
         });
         it('outputs multiple data', () => {
-            const stream = new MockWritable();
+            const { stream, getData } = getMockWritable();
             const out = writer({ output: 'table', out: stream });
             out
                 .write({ foo: 'bar', extra: 'extra' }, { fields: ['foo'], title: 'T1' })
                 .write({ baz: 'xyz', extra: 'extra' }, { fields: ['baz'], title: 'T2' })
                 .end();
-            expect(stream.data).toMatchSnapshot();
+            expect(getData()).toMatchSnapshot();
+        });
+        it('outputs table with custom renderer', () => {
+            const { stream, getData } = getMockWritable();
+            const out = writer({
+                output: 'table',
+                out: stream,
+            });
+            out
+                .write({ foo: 'bar' }, {
+                fields: ['foo'],
+                title: 'T1',
+                renderColumns: {
+                    foo: ({ foo }) => `Here is: ${foo}`,
+                },
+            })
+                .end();
+            expect(getData()).toMatchSnapshot();
         });
     });
 });