ReviewOS

also looking at this

stacks/ts-audio

chore: enhance logger

#28
Merged cab-mikee wants to merge chore/enhance-logger into main
2 files +12 -4

Review threads live on the whole diff, not on one commit, so none are shown here - a thread's line means something in the branch's final form, and painting it into an intermediate step would put it on code it is not about.

bin/cli.tsmodified+18-16
Changes to bin/cli.ts
@@ -1,12 +1,14 @@
11import type { AudioxOptions } from '../src/types'
22import process from 'node:process'
33import { CLI } from '@stacksjs/clapp'
4import { Logger } from '@stacksjs/clarity'
45import { version } from '../package.json'
56import { audio } from '../src/audio'
67import { audioInfo } from '../src/audio-info'
78import { debugLog } from '../src/utils'
89
910const cli = new CLI('audiox')
11const logger = new Logger('cli')
1012
1113cli
1214 .command('convert <input> [output]', 'Convert audio file to different format/settings')
@@ -68,7 +70,7 @@ cli
6870 debugLog('cli', 'Conversion complete', options.verbose)
6971 }
7072 catch (error: any) {
71 console.error('Error:', error.message)
73 await logger.error('Error:', error.message)
7274 process.exit(1)
7375 }
7476 })
@@ -89,39 +91,39 @@ cli
8991 const info = await audioInfo(input, infoOptions)
9092
9193 // Pretty print the audio information
92 console.log('\nAudio Information:')
93 console.log('----------------')
94 await logger.info('\nAudio Information:')
95 await logger.info('----------------')
9496 for (const stream of info) {
95 console.log(`Codec: ${stream.codec}`)
96 console.log(`Channels: ${stream.channels}`)
97 console.log(`Sample Rate: ${stream.sampleRate} Hz`)
98 console.log(`Bitrate: ${Math.round(Number.parseInt(stream.bitrate) / 1000)}k`)
99 console.log(`Duration: ${Math.round(Number.parseFloat(stream.duration) * 100) / 100}s`)
97 await logger.info(`Codec: ${stream.codec}`)
98 await logger.info(`Channels: ${stream.channels}`)
99 await logger.info(`Sample Rate: ${stream.sampleRate} Hz`)
100 await logger.info(`Bitrate: ${Math.round(Number.parseInt(stream.bitrate) / 1000)}k`)
101 await logger.info(`Duration: ${Math.round(Number.parseFloat(stream.duration) * 100) / 100}s`)
100102
101103 if (stream.metadata && Object.keys(stream.metadata).length > 0) {
102 console.log('\nMetadata:')
104 await logger.info('\nMetadata:')
103105 for (const [key, value] of Object.entries(stream.metadata)) {
104 console.log(`${key}: ${value}`)
106 await logger.info(`${key}: ${value}`)
105107 }
106108 }
107 console.log('----------------')
109 await logger.info('----------------')
108110 }
109111 }
110112 catch (error: any) {
111 console.error('Error:', error.message)
113 await logger.error('Error:', error.message)
112114 process.exit(1)
113115 }
114116 })
115117
116118cli
117119 .command('completion', 'Generate shell completion script')
118 .action(() => {
120 .action(async () => {
119121 // TODO: Implement shell completion generation
120 console.log('Shell completion not implemented yet')
122 await logger.info('Shell completion not implemented yet')
121123 })
122124
123cli.command('version', 'Show the version of the Reverse Proxy CLI').action(() => {
124 console.log(version)
125cli.command('version', 'Show the version of the Reverse Proxy CLI').action(async () => {
126 await logger.info(version)
125127})
126128
127129cli.version(version)
build.tsmodified+4-2
Changes to build.ts
@@ -1,6 +1,8 @@
1import { Logger } from '@stacksjs/clarity'
12import { dts } from 'bun-plugin-dtsx'
23
3console.log('Building...')
4const logger = new Logger('build')
5await logger.info('Building...')
46
57await Bun.build({
68 entrypoints: ['./src/index.ts', './bin/cli.ts'],
@@ -12,4 +14,4 @@ await Bun.build({
1214 plugins: [dts()],
1315})
1416
15console.log('Built')
17await logger.success('Built')
bun.lockmodified+3-0
Changes to bun.lock
@@ -6,6 +6,7 @@
66 "devDependencies": {
77 "@stacksjs/bumpx": "^0.1.17",
88 "@stacksjs/clapp": "^0.1.16",
9 "@stacksjs/clarity": "^0.3.17",
910 "@stacksjs/docs": "^0.70.23",
1011 "@stacksjs/eslint-config": "^3.13.1-beta.2",
1112 "@stacksjs/gitlint": "^0.1.5",
@@ -501,6 +502,8 @@
501502
502503 "@stacksjs/clapp": ["@stacksjs/clapp@0.1.16", "", { "bin": { "clapp": "dist/bin/cli.js", "@stacksjs/clapp": "dist/bin/cli.js" } }, "sha512-BDmYu9Rk/HHIVc4vQjgQO6MzXNMJvPG6ZGiiEAPQT8EAidx3/6S6O7kyY2UdfJSksiCd5SKFK+WYd1uAs88BrQ=="],
503504
505 "@stacksjs/clarity": ["@stacksjs/clarity@0.3.17", "", { "bin": { "clarity": "dist/bin/cli.js" } }, "sha512-uopKQuFzed7y5RvIyYmswjEDbh/vvt8szJpa+BfdLrZyXmmfZH900DuAvWhmrQd1uu1Lq0a7E/aVagP7ocf//A=="],
506
504507 "@stacksjs/docs": ["@stacksjs/docs@0.70.23", "", { "dependencies": { "@iconify-json/carbon": "^1.2.8", "@shikijs/vitepress-twoslash": "^3.2.1", "@vite-pwa/assets-generator": "^1.0.0", "@vite-pwa/vitepress": "^1.0.0", "unocss": "^66.0.0", "unplugin-icons": "^22.1.0", "unplugin-vue-components": "^28.4.1", "vite-plugin-pwa": "^1.0.0", "vitepress": "1.6.3" } }, "sha512-kRk/aza/wQAAgF0fhUhG8bUHhqk3RnjBkZyoRW0fvYs3dLaAArJYX/uVquZixlQnqgizGeGZT986tEFjs5Ly+A=="],
505508
506509 "@stacksjs/dtsx": ["@stacksjs/dtsx@0.8.1", "", { "bin": { "dtsx": "dist/cli.js" } }, "sha512-QjCoPsmxfd3VJA2+G/pa6wA1sYPzC0S9wUuJPRCtWlcGWBTUvz9nFLBxdKWwbvIJBJ9gc7BmIoAo18pvTlvSRg=="],
package.jsonmodified+1-0
Changes to package.json
@@ -70,6 +70,7 @@
7070 "devDependencies": {
7171 "@stacksjs/bumpx": "^0.1.17",
7272 "@stacksjs/clapp": "^0.1.16",
73 "@stacksjs/clarity": "^0.3.17",
7374 "@stacksjs/docs": "^0.70.23",
7475 "@stacksjs/eslint-config": "^3.13.1-beta.2",
7576 "@stacksjs/gitlint": "^0.1.5",
src/utils.tsmodified+8-6
Changes to src/utils.ts
@@ -1,21 +1,24 @@
1import { Logger } from '@stacksjs/clarity'
12import { config } from './config'
23
4const baseLogger = new Logger('audiox')
5
36export function debugLog(category: string, message: string, verbose?: boolean | string[]): void {
47 if (verbose === false) {
58 return
69 }
710
11 const logger = baseLogger.extend(category)
12
813 if (verbose === true || config.verbose === true) {
9 // eslint-disable-next-line no-console
10 console.debug(`[audiox:${category}] ${message}`)
14 logger.debug(message)
1115 }
1216
1317 if (Array.isArray(verbose)) {
1418 // Check if any of the verbose categories match the prefix
1519 const matches = verbose.some(prefix => category.startsWith(prefix))
1620 if (matches) {
17 // eslint-disable-next-line no-console
18 console.log(`[audiox:${category}] ${message}`)
21 logger.info(message)
1922 }
2023 }
2124
@@ -23,8 +26,7 @@ export function debugLog(category: string, message: string, verbose?: boolean |
2326 // Check if any of the verbose categories match the prefix
2427 const matches = config.verbose.some(prefix => category.startsWith(prefix))
2528 if (matches) {
26 // eslint-disable-next-line no-console
27 console.log(`[audiox:${category}] ${message}`)
29 logger.info(message)
2830 }
2931 }
3032}