Better output support

- Support 'json', 'table', 'yaml', 'tsv' formats
- Support JSONPATH property filtering
- Support excluding empty results

Author: BuriedStPatrick

Dockerfile

@@ -1,14 +1,14 @@
 ARG DOCKER_USER=bun
 
-FROM oven/bun:1 as base
+FROM oven/bun:1 AS base
 ARG DOCKER_USER
 RUN apt-get update && apt-get install -y wget
 RUN mkdir -p /tmp && chown ${DOCKER_USER} -R /tmp
 RUN mkdir -p /build && chown ${DOCKER_USER} -R /build
 RUN mkdir -p /src && chown ${DOCKER_USER} -R /src
 USER ${DOCKER_USER}
 
-FROM base as source
+FROM base AS source
 ARG DOCKER_USER
 WORKDIR /src
 COPY package.json bun.lockb ./
@@ -17,10 +17,10 @@ RUN bun install \
   --production
 COPY . .
 
-FROM source as build
+FROM source AS build
 ARG DOCKER_USER
 ENTRYPOINT ["bun", "build", "--compile", "--file", "./index.ts", "--outfile", "./bin/dotnetman"]
 
-FROM source as run
+FROM source AS run
 ARG DOCKER_USER
 ENTRYPOINT ["bun", "run", "index.ts"]

bun.lockb

@@ -1,47 +1,80 @@
-import yargs, { ArgumentsCamelCase, Argv, CommandBuilder, CommandModule } from 'yargs'
+import type { Arguments, Argv, CommandModule } from 'yargs'
 import { getInstalledRuntimeVersions, getInstalledSdkVersions } from '../util/dotnet'
-import { getListPreference, outputList } from '../util/lists'
-import chalk from 'chalk'
+import { output, toPropertyOptions, type OutputArgs } from '../util/output'
+
+export type ListCommandArgs = {
+}
+  & OutputArgs
+  & Arguments
 
 export const listCommand: CommandModule = {
   command: 'list',
   describe: 'List .NET software',
   aliases: ['ls', 'get'],
-  builder: (command: CommandBuilder) => command
-    .option('with-lifecycle', {
-      type: 'boolean'
+  builder: (args: Argv<{}>) => args
+    .option('output', {
+      alias: 'o',
+      type: 'string',
+      describe: 'Output format.'
+    })
+    .option('property', {
+      alias: 'p',
+      type: 'array',
+      describe: 'Filter properties using JSON path.'
+    })
+    .option('exclude-empty', {
+      type: 'boolean',
+      describe: 'Exclude empty values from result.'
     })
     .command(getSdkCommand)
     .command(getRuntimeCommand),
-  handler: async (argv: Argv) => {
-    console.log(`${chalk.bold.bgBlue.white('Installed sdks')}`)
+  handler: async (args: ListCommandArgs) => {
     const installedSdks = await getInstalledSdkVersions()
-    outputList(
-      installedSdks,
-      getListPreference(argv))
 
-    console.log(`${chalk.bold.bgBlue.white('Installed runtimes')}`)
     const installedRuntimes = await getInstalledRuntimeVersions()
-    outputList(installedRuntimes, getListPreference(argv))
+
+    output(
+      {
+        'sdks': installedSdks,
+        'runtimes': installedRuntimes
+      },
+      args.output,
+      toPropertyOptions(args))
   }
 }
 
+export type GetSdkCommandArgs = {
+}
+  & ListCommandArgs
+  & Arguments
+
 const getSdkCommand: CommandModule = {
   command: 'sdk',
   describe: 'Get installed SDKs',
-  handler: async (argv: Argv) => {
+  handler: async (args: GetSdkCommandArgs) => {
     const installedSdks = await getInstalledSdkVersions()
 
-    outputList(installedSdks, getListPreference(argv))
+    output(
+      installedSdks,
+      args.output,
+      toPropertyOptions(args))
   }
 }
 
+export type GetRuntimeCommandArgs = {
+}
+  & ListCommandArgs
+  & Arguments
+
 const getRuntimeCommand: CommandModule = {
   command: 'runtime',
   describe: 'Get installed runtimes',
-  handler: async (argv: Argv) => {
+  handler: async (args: GetRuntimeCommandArgs) => {
     const installedRuntimes = await getInstalledRuntimeVersions()
 
-    outputList(installedRuntimes, getListPreference(argv))
+    output(
+      installedRuntimes,
+      args.output,
+      toPropertyOptions(args))
   }
 }

commands/list.ts

@@ -1,12 +1,17 @@
-import yargs, { ArgumentsCamelCase, Argv, CommandBuilder, CommandModule } from 'yargs'
+import type { Arguments, Argv, CommandModule } from 'yargs'
 import { getChannelFromVersion, getInstalledRuntimeVersions, getInstalledSdkVersions, syncRuntimeChannel, syncSdkChannel, type DotnetVersionConfig, syncVersionConfig } from '../util/dotnet'
-import { exists } from 'node:fs'
+
+export type SyncCommandArgs = {
+  target?: 'all' | 'sdk' | 'runtime'
+  file?: string
+}
+  & Arguments
 
 export const syncCommand: CommandModule = {
   command: 'sync [target]',
   describe: 'Synchronize .NET software',
   aliases: ['s'],
-  builder: (command: CommandBuilder) => command
+  builder: (command: Argv<{}>) => command
     .positional('target', {
       type: 'string',
       describe: 'The target to sync.',
@@ -26,7 +31,7 @@ export const syncCommand: CommandModule = {
       type: 'string',
       describe: 'Channel to sync.'
     }),
-  handler: async (argv: Argv) => {
+  handler: async (argv: SyncCommandArgs) => {
     if (argv.file) {
       const file = Bun.file(argv.file)
       if (!(await file.exists())) {

commands/sync.ts

@@ -8,14 +8,35 @@
   },
   "devDependencies": {
     "@types/bun": "latest",
+    "@types/js-yaml": "^4.0.9",
+    "@types/json-pointer": "^1.0.34",
+    "@types/lodash": "^4.17.20",
     "@types/node": "^20.11.17",
-    "@types/yargs": "^17.0.32"
+    "@types/yargs": "^17.0.34",
+    "eslint": "^9.39.1",
+    "typescript-eslint": "^8.46.4"
   },
   "peerDependencies": {
     "typescript": "^5.0.0"
   },
   "dependencies": {
     "chalk": "^5.3.0",
+    "js-yaml": "^4.1.1",
+    "json-pointer": "^0.6.2",
+    "lodash": "^4.17.21",
     "yargs": "^17.7.2"
+  },
+  "signale": {
+    "displayScope": false,
+    "displayBadge": true,
+    "displayDate": false,
+    "displayFilename": false,
+    "displayLabel": false,
+    "displayTimestamp": false,
+    "underlineLabel": false,
+    "underlineMessage": false,
+    "underlinePrefix": false,
+    "underlineSuffix": false,
+    "uppercaseLabel": true
   }
 }