ADD: node/config/Output: get|toRawText|Buffer

Author: dr-js

SPEC.md

@@ -58,7 +58,7 @@
 + 📄 [source/node/cache/staleCheck.js](source/node/cache/staleCheck.js)
   - `describeStaleReport`, `loadStatFile`, `saveStatFile`, `staleCheckCalcReport`, `staleCheckMark`, `staleCheckSetup`
 + 📄 [source/node/config/Output.js](source/node/config/Output.js)
-  - `outputConfig`, `outputConfigMap`
+  - `getRawBuffer`, `getRawText`, `outputConfig`, `outputConfigMap`, `toRawBuffer`, `toRawText`
 + 📄 [source/node/config/YAML.js](source/node/config/YAML.js)
   - `GET_YAML`, `USE_YAML`, `parseYAML`, `readYAML`, `readYAMLSync`, `stringifyYAML`, `writeYAML`, `writeYAMLSync`
 + 📄 [source/node/export/generate.js](source/node/export/generate.js)

source/node/config/Output.js

@@ -1,21 +1,30 @@
 import { resolve, dirname } from 'node:path'
 import { binary } from '@dr-js/core/module/common/format.js'
+import { isString } from '@dr-js/core/module/common/check.js'
 import { writeBuffer } from '@dr-js/core/module/node/fs/File.js'
 import { createDirectory } from '@dr-js/core/module/node/fs/Directory.js'
 
 import { stringifyYAML } from './YAML.js'
 import { stringifyNginxConf } from 'source/common/config/Nginx.js'
 
+const __RAW = Symbol('CFG:RAW') // mark raw config
+const getRawText = (config) => config.__RAW === __RAW && isString(config.text) ? config.text : undefined
+const toRawText = (text) => ({ __RAW, text })
+const getRawBuffer = (config) => config.__RAW === __RAW && Buffer.isBuffer(config.buffer) ? config.buffer : undefined
+const toRawBuffer = (buffer) => ({ __RAW, buffer })
+
 const outputConfig = async (
   pathCombo = '', // 'file-path.json|file-path.yml|file-path.yaml'
   config = {},
   { fromRoot, onOutput }
 ) => {
   for (const path of pathCombo.split('|')) {
-    const buffer = (path.endsWith('.yml') || path.endsWith('.yaml')) ? Buffer.from(stringifyYAML(config))
-      : path.endsWith('.json') ? Buffer.from(JSON.stringify(config, null, 2))
-        : path.endsWith('.nginx.conf') ? Buffer.from(stringifyNginxConf(config))
-          : null
+    const buffer = getRawText(config) !== undefined ? Buffer.from(getRawText(config))
+      : getRawBuffer(config) !== undefined ? getRawBuffer(config)
+        : (path.endsWith('.yml') || path.endsWith('.yaml')) ? Buffer.from(stringifyYAML(config))
+          : path.endsWith('.json') ? Buffer.from(JSON.stringify(config, null, 2))
+            : path.endsWith('.nginx.conf') ? Buffer.from(stringifyNginxConf(config))
+              : null
     if (!buffer) throw new Error(`invalid output path: ${path}`)
     await createDirectory(dirname(fromRoot(path)))
     await writeBuffer(fromRoot(path), buffer)
@@ -40,6 +49,8 @@ const outputConfigMap = async (
 }
 
 export {
+  getRawText, toRawText,
+  getRawBuffer, toRawBuffer,
   outputConfig,
   outputConfigMap
 }

source/node/config/Output.test.js

@@ -4,6 +4,8 @@ import { readText } from '@dr-js/core/module/node/fs/File.js'
 import { deleteDirectory, resetDirectory } from '@dr-js/core/module/node/fs/Directory.js'
 
 import {
+  toRawText,
+  toRawBuffer,
   // outputConfig,
   outputConfigMap
 } from './Output.js'
@@ -21,9 +23,12 @@ const verifyFile = async (file, expectString) => strictEqual(
   expectString.trim()
 )
 
+const TEST_TEXT = '\r\n\t'
 const TEST_OBJECT = { a: 1, b: 2, c: { d: 42 } }
 
 const TEST_OUTPUT_CONFIG = {
+  'rawT.txt|rawT.json': toRawText(TEST_TEXT),
+  'rawB.txt|rawB.json': toRawBuffer(Buffer.from(TEST_TEXT)),
   'basic.json': TEST_OBJECT,
   'combo.json|combo.yml|combo.yaml|combo.nginx.conf': TEST_OBJECT
 }
@@ -53,6 +58,10 @@ describe('Node.Config.Output', () => {
   it('outputConfigMap()', async () => {
     await outputConfigMap(TEST_OUTPUT_CONFIG, { outputRoot: TEST_ROOT, log: info })
 
+    await verifyFile(fromRoot('rawT.txt'), TEST_TEXT)
+    await verifyFile(fromRoot('rawT.txt'), TEST_TEXT)
+    await verifyFile(fromRoot('rawB.txt'), TEST_TEXT)
+    await verifyFile(fromRoot('rawB.txt'), TEST_TEXT)
     await verifyFile(fromRoot('basic.json'), TEST_OUTPUT_JSON)
     await verifyFile(fromRoot('combo.json'), TEST_OUTPUT_JSON)
     await verifyFile(fromRoot('combo.yml'), TEST_OUTPUT_YAML)