Merge pull request #108 from zanerock/work-liquid-labs/cloudsite/107

Rework user output and remove dependency on process.stdout

DEVELOPER_NOTES.md

@@ -48,7 +48,7 @@ All the CLI dependencies are noted as peer dependencies. This is so that if the
 See also the [Known limitations section in the README.md](./README.md#known-limitations).
 
 - The current implementation deals exclusively with apex domains. It would make a lot of sense to support sub-domains as well.
-- Reporting progress through `process.stdout` isn't ideal, especial for the _lib_ components. We think using something like the Winston logger might be useful.[^1]
+- We want to move to a more flexible and consistent output protocol. All actions should support 'quiet'-ing intermediate output and a single, formatable output object.[^1]
 
 [^1: We did a survey of "top javascript log libraries" and determined that Winston seemed to fit best. It had all the feataures we needed and is very well supported.]
 

package.json

@@ -62,7 +62,8 @@
   "devDependencies": {
     "@liquid-labs/sdlc-resource-babel-and-rollup": "^1.0.0-alpha.8",
     "@liquid-labs/sdlc-resource-eslint": "^1.0.0-alpha.11",
-    "@liquid-labs/sdlc-resource-jest": "^1.0.0-alpha.7"
+    "@liquid-labs/sdlc-resource-jest": "^1.0.0-alpha.7",
+    "magic-print": "^1.0.0-alpha.4"
   },
   "_comply": {
     "orgKey": "@liquid-labs"
@@ -72,6 +73,7 @@
     "command-line-documentation": "^1.0.0-alpha.3",
     "json-to-plain-text": "^1.1.4",
     "lodash": "^4.17.21",
+    "magic-print": "^1.0.0-alpha.4",
     "question-and-answer": "^1.0.0-alpha.16"
   }
 }

src/cli/cloudsite.mjs

@@ -6,6 +6,7 @@ import isEqual from 'lodash/isEqual'
 
 import { cliSpec, DB_PATH } from './constants'
 import { checkReminders } from './lib/check-reminders'
+import { configureLogger } from '../lib/shared/progress-logger'
 import { handleCleanup } from './lib/handle-cleanup'
 import { handleConfiguration } from './lib/handle-configuration'
 import { handleCreate } from './lib/handle-create'
@@ -37,6 +38,8 @@ const cloudsite = async () => {
     db = { account : { settings : {} }, sites : {}, toCleanup : {}, reminders : [] }
   }
 
+  configureLogger(db?.account?.settings?.terminal)
+
   checkReminders({ reminders : db.reminders })
 
   const origDB = structuredClone(db)

src/cli/lib/check-reminders.mjs

@@ -1,3 +1,5 @@
+import { progressLogger } from '../../lib/shared/progress-logger'
+
 const checkReminders = ({ reminders }) => {
   const now = new Date().getTime()
   const currentReminders = reminders.filter(({ remindAfter }) => {
@@ -6,18 +8,15 @@ const checkReminders = ({ reminders }) => {
   })
 
   if (currentReminders.length > 0) {
-    const columnWidth = process.stdout.columns || 40
-    const opener = '-- Reminder' + (currentReminders.lengith > 1 ? 's ' : ' ')
-    process.stdout.write(opener + '-'.repeat(columnWidth - opener.length))
+    const columnWidth = progressLogger.write.width
+    const opener = '-- <yellow>Reminder<rst>' + (currentReminders.lengith > 1 ? 's ' : ' ')
+    progressLogger.write(opener + '-'.repeat(columnWidth - opener.length + '<yellow>'.length + '<rst>'.length) + '\n')
 
     currentReminders.forEach(({ todo }, i) => {
-      if (currentReminders.length > 1) {
-        process.stdout.write(i + '.')
-      }
-      process.stdout.write(todo + '\n')
+      progressLogger.write((currentReminders.length > 1 ? i + '.' : '') + todo + '\n')
     })
 
-    process.stdout.write('-'.repeat(columnWidth) + '\n')
+    progressLogger.write('-'.repeat(columnWidth) + '\n')
   }
 }
 

src/cli/lib/configuration/handle-configuration-show.mjs

@@ -1,8 +1,7 @@
 import commandLineArgs from 'command-line-args'
 
-import { formatOutput } from '../format-output'
-
 import { cliSpec } from '../../constants'
+import { progressLogger } from '../../../lib/shared/progress-logger'
 
 const handleConfigurationShow = async ({ argv, db }) => {
   const showConfigurationCLISpec = cliSpec
@@ -13,7 +12,7 @@ const handleConfigurationShow = async ({ argv, db }) => {
   const { format } = showConfigurationOptions
 
   const accountSettings = db.account.settings || {}
-  process.stdout.write(formatOutput({ format, output : accountSettings }))
+  progressLogger.write(accountSettings, '', { format })
 }
 
 export { handleConfigurationShow }

src/cli/lib/configuration/test/handle-configuration-show.test.mjs

@@ -1,25 +1,23 @@
+import { StringOut } from 'magic-print'
+
+import { configureLogger } from '../../../../lib/shared/progress-logger'
 import { handleConfigurationShow } from '../handle-configuration-show'
 
-const expectedOutput = 'hi'
+const settingsVal = 'hi'
 
 jest.mock('node:fs/promises', () => ({
-  readFile : () => expectedOutput
+  readFile : () => settingsVal
 }))
 
 describe('handleConfigurationShow', () => {
-  let output
-  let origWrite
-  beforeAll(() => {
-    origWrite = process.stdout.write
-    process.stdout.write = (chunk) => { output = chunk }
-  })
-
-  afterAll(() => {
-    process.stdout.write = origWrite
+  let stringOut
+  beforeEach(() => {
+    stringOut = new StringOut()
+    configureLogger({ out : stringOut })
   })
 
   test('prints the file contents', async () => {
-    await handleConfigurationShow({ argv : [], db : { account : { settings : expectedOutput } } })
-    expect(output).toBe(expectedOutput + '\n')
+    await handleConfigurationShow({ argv : [], db : { account : { settings : settingsVal } } })
+    expect(stringOut.string).toBe(settingsVal + '\n')
   })
 })