prettify-bru 1.9.0 → 1.9.2

package/README.md

@@ -14,7 +14,6 @@ Imposes a standard format on all blocks of JSON and JavaScript code across multi
 ## Table of contents
 
 <!-- TOC -->
-
 - [Why use this?](#why-use-this)
 - [Style choices](#style-choices)
 - [Feedback](#feedback)
@@ -24,9 +23,12 @@ Imposes a standard format on all blocks of JSON and JavaScript code across multi
   - [Fixing the files](#fixing-the-files)
   - [Limit to one directory](#limit-to-one-directory)
   - [Limit to one file](#limit-to-one-file)
-  - [Limit to one block type](#limit-to-one-block-type)
+  - [Limit to only a subset of blocks](#limit-to-only-a-subset-of-blocks)
   - [Complex example](#complex-example)
 - [Config file](#config-file)
+  - [Agnostic File Paths](#agnostic-file-paths)
+  - [Shorten Getters](#shorten-getters)
+  - [Prettier](#prettier)
 - [Automatically checking PRs](#automatically-checking-prs)
 <!-- TOC -->
 
@@ -104,14 +106,20 @@ Similar to above example, you can also provide a specific filename:
 npx prettify-bru speed-tests/get-all.bru
 ```
 
-### Limit to one block type
+### Limit to only a subset of blocks
 
-Use the `--only` option to just operate on 1 block type and ignore the rest. For example to only assess the `body:json` blocks do:
+Use the `--only` option to operate on a specific block or subset of blocks. For example to only assess the `body:json` blocks in your files, specify the exact name of the block:
 
 ```
 npx prettify-bru --only body:json
 ```
 
+Some values target groups of blocks:
+
+- "graphql" will operate on `body:graphql` and `body:graphql:vars`
+- "script" will do both `script:pre-request` and `script:post-response`
+- "body" will target all 3 body blocks `body:json`, `body:graphql` and `body:graphql:vars`
+
 ### Complex example
 
 Fix the formatting of just the `body:json` block in 1 specific file:

package/cli.js

@@ -3,6 +3,7 @@
 import yargs from 'yargs'
 import {hideBin} from 'yargs/helpers'
 import {main} from './lib/main.mjs'
+import {onlyParamOptions} from './lib/onlyParam.mjs'
 
 const argv = yargs(hideBin(process.argv))
     .command(
@@ -20,17 +21,9 @@ const argv = yargs(hideBin(process.argv))
     )
     .options({
         only: {
-            describe: 'Limit to only 1 block type',
+            describe: 'Limit to only certain block types',
             type: 'string',
-            choices: [
-                'body:json',
-                'json',
-                'script:pre-request',
-                'pre-request',
-                'script:post-response',
-                'post-request',
-                'tests',
-            ],
+            choices: Object.keys(onlyParamOptions),
         },
         w: {
             describe: 'Write mode (Formats files in place, overwriting contents)',

package/lib/config.mjs

@@ -1,4 +1,5 @@
 import {readIfExists} from './files.mjs'
+import {styleText} from 'node:util'
 
 const configFilename = '.prettifybrurc'
 
@@ -44,17 +45,19 @@ export function parseFile(console, fileContents) {
         fileConfig = JSON.parse(fileContents)
     } catch (e) {
         console.error(
-            `\x1b[31mError parsing JSON in ${configFilename} config file:\n${e.message}\x1b[0m\n`
+            styleText('red', `Error parsing JSON in ${configFilename} config file:\n${e.message}\n`)
         )
         return {}
     }
 
     if (fileConfig instanceof Array || typeof fileConfig !== 'object') {
-        console.error(`\x1b[31m${configFilename} is not valid, the JSON is not an Object\x1b[0m\n`)
+        console.error(
+            styleText('red', `${configFilename} is not valid, the JSON is not an Object\n`)
+        )
         return {}
     }
 
-    console.log(`🔧 \x1b[2mUsing config file ${configFilename}\x1b[0m`)
+    console.log(`🔧 ${styleText('dim', `Using config file ${configFilename}`)}`)
 
     let config = {}
 
@@ -73,11 +76,11 @@ export function parseFile(console, fileContents) {
                 config[key] = fileConfig[key]
             } else {
                 console.warn(
-                    `⚠️  \x1b[33m"${key}" is not correct type, it should be ${validType}\x1b[0m`
+                    `⚠️  ${styleText('yellow', `"${key}" is not correct type, it should be ${validType}`)}`
                 )
             }
         } else {
-            console.warn(`⚠️  \x1b[33mIgnoring unsupported property "${key}"\x1b[0m`)
+            console.warn(`⚠️  ${styleText('yellow', `Ignoring unsupported property "${key}"`)}`)
         }
     })
 

package/lib/format.mjs

@@ -1,5 +1,6 @@
 import prettier from 'prettier'
 import {defaultConfig} from './config.mjs'
+import {onlyParamOptions, validateOnlyParam} from './onlyParam.mjs'
 import {format as jsoncFormat, applyEdits} from 'jsonc-parser'
 
 // This Prettier config should match what the Bruno GUI implements
@@ -24,6 +25,9 @@ const formattableBlocks = [
     'tests',
 ]
 
+const maskPattern = /("(?:\\.|[^"\\])*")|(\{\{.*?\}\})/g
+const unmaskPattern = /"__⇎⇎START__(\{\{.*?\}\})__END⇎⇎__"/g
+
 /**
  * @typedef {Object} FileOutcome
  * @property {string} newContents
@@ -42,6 +46,8 @@ const formattableBlocks = [
  * @returns {Promise<FileOutcome>}
  */
 export async function format(originalContents, only = null, configOverrides = {}) {
+    validateOnlyParam(only)
+
     /** @type {import('./config.mjs').PrettifyBruConfig} */
     const config = {
         ...defaultConfig,
@@ -61,15 +67,7 @@ export async function format(originalContents, only = null, configOverrides = {}
     }
 
     for (const blockName of formattableBlocks) {
-        if (only !== null) {
-            // This is non-documented feature, but is covered with tests.
-            // Specifying only 'json' will match both 'body:json', 'pre-request' will match 'script:pre-request' etc.
-            // However that is causing issue with `body:graphql` and `body:graphql:vars`,
-            // as they both start with 'body:graphql'.
-            // So not to introduce breaking change on non-documented feature, someone may rely on, use this workaround.
-            if (blockName.startsWith('body:graphql') && blockName !== only) continue
-            if (!blockName.includes(only)) continue
-        }
+        if (only !== null && !blockName.match(onlyParamOptions[only])) continue
 
         const blockOutcome = await formatBlock(fileOutcome.newContents, blockName, config)
         fileOutcome.blocksSearchedFor++
@@ -145,8 +143,12 @@ async function formatBlock(fileContents, blockName, config) {
             if (blockName === 'body:graphql') {
                 opts.parser = 'graphql'
                 opts.bracketSpacing = true
+                unindented = wrapNonStringPlaceholdersInDelimiters(unindented)
             }
             reformatted = await prettier.format(unindented, opts)
+            if (blockName === 'body:graphql') {
+                reformatted = unwrapDelimitedPlaceholders(reformatted)
+            }
         } catch (e) {
             outcome.errorMessage = `Prettier could not format ${blockName} because...\n${e.message}`
             return outcome
@@ -194,23 +196,33 @@ function shortenGetters(blockContents) {
 }
 
 /**
- * Turns Bruno variable placeholders into strings with special delimiters, effectively making it valid JSON
+ * Turns Bruno variable placeholders into strings with special delimiters, effectively making it valid JSON,
+ * and for standard cases also valid GraphQL.
  *
- * @param {string} jsonBlock
+ * @param {string} block
  * @returns {string}
  */
-function wrapNonStringPlaceholdersInDelimiters(jsonBlock) {
-    return jsonBlock.replace(/(:[^"]*)([{]{2}[^}]+}})([^"⇎])/g, '$1"⇎$2⇎"$3')
+function wrapNonStringPlaceholdersInDelimiters(block) {
+    return block.replace(maskPattern, (match, group1, group2) => {
+        // If group1 exists, we found a standard JSON string. Return it untouched.
+        if (group1) {
+            return group1
+        }
+
+        // If group2 exists, we found a placeholder outside a string.
+        // Wrap it in a unique dummy string.
+        return `"__⇎⇎START__${group2}__END⇎⇎__"`
+    })
 }
 
 /**
  * Reverts delimited Bruno variable placeholders back to their original form within a JSON block.
  *
- * @param {string} jsonBlock
+ * @param {string} block
  * @returns {string}
  */
-function unwrapDelimitedPlaceholders(jsonBlock) {
-    return jsonBlock.replace(/"⇎({{[^}]+}})⇎"/g, '$1')
+function unwrapDelimitedPlaceholders(block) {
+    return block.replace(unmaskPattern, '$1')
 }
 
 /**

package/lib/main.mjs

@@ -1,6 +1,8 @@
 import {findFiles, readFile, writeFile} from './files.mjs'
 import {format} from './format.mjs'
+import {validateOnlyParam} from './onlyParam.mjs'
 import {loadConfigFile} from './config.mjs'
+import {styleText} from 'node:util'
 
 /**
  * Finds all .bru files and formats contents
@@ -13,6 +15,8 @@ import {loadConfigFile} from './config.mjs'
  * @returns {Promise<boolean>} True means some files contained errors or needed reformatting
  */
 export async function main(console, cwd, path, write, only = null) {
+    validateOnlyParam(only)
+
     if (path === '') {
         path = cwd
     } else {
@@ -46,14 +50,14 @@ export async function main(console, cwd, path, write, only = null) {
 
     const changeableSuffix = write ? 'reformatted' : 'require reformatting'
     let changeableReport = null
+    const changeableColor = write ? 'green' : 'yellow'
     if (changeableFiles.length) {
-        const changeableCol = write ? '\x1b[32m' : '\x1b[33m'
         const emoji = write ? '✏️' : '⚠️'
         const changeableFilesDesc = fileDesc(changeableFiles)
-        changeableReport = `${changeableCol}${changeableFilesDesc} ${changeableSuffix}`
-        console.log(`\x1b[4m${changeableReport}:\x1b[0m\n`)
+        changeableReport = `${changeableFilesDesc} ${changeableSuffix}`
+        console.log(styleText([changeableColor, 'underline'], `${changeableReport}:\n`))
         changeableFiles.forEach(r =>
-            console.log(`${emoji}  ${changeableCol}${r.displayFilePath}\x1b[0m`)
+            console.log(`${emoji}  ${styleText(changeableColor, r.displayFilePath)}`)
         )
         console.log(' ')
     }
@@ -61,12 +65,12 @@ export async function main(console, cwd, path, write, only = null) {
     let erroredReport = null
     if (erroredFiles.length) {
         const erroredFilesDesc = fileDesc(erroredFiles)
-        erroredReport = `\x1b[31m${erroredFilesDesc} causing errors`
-        console.warn(`\x1b[4m${erroredReport}:\x1b[0m\n`)
+        erroredReport = `${erroredFilesDesc} causing errors`
+        console.warn(styleText(['red', 'underline'], `${erroredReport}:\n`))
         erroredFiles.forEach((r, i) => {
             console.warn(`${i + 1}) ${r.displayFilePath}\n`)
             r.outcome.errorMessages.forEach(err => {
-                console.warn(`❌ \x1b[31m${err}\x1b[0m\n`)
+                console.warn(`❌ ${styleText('red', err)}\n`)
             })
         })
     }
@@ -75,15 +79,17 @@ export async function main(console, cwd, path, write, only = null) {
     const filesDesc = fileDesc(files)
     console.log(`Inspected ${filesDesc}:`)
     if (changeableReport) {
-        console.log(`  ${changeableReport}\x1b[0m`)
+        console.log(styleText(changeableColor, `  ${changeableReport}`))
     }
     if (erroredReport) {
-        console.log(`  ${erroredReport}\x1b[0m`)
+        console.log(styleText('red', `  ${erroredReport}`))
     }
     if (requireNothing > 0) {
-        let requireNothingMessage = requireNothing === files.length ? '\x1b[32m' : '\x1b[2m'
-        requireNothingMessage += `${requireNothing} file` + (requireNothing > 1 ? 's' : '')
-        console.log(`  ${requireNothingMessage} did not require any changes\x1b[0m`)
+        const requireNothingColor = requireNothing === files.length ? 'green' : 'dim'
+        const requireNothingMessage = `${requireNothing} file` + (requireNothing > 1 ? 's' : '')
+        console.log(
+            `  ${styleText(requireNothingColor, `${requireNothingMessage} did not require any changes`)}`
+        )
     }
 
     return erroredFiles.length > 0 || changeableFiles.length > 0

package/lib/onlyParam.mjs

@@ -0,0 +1,25 @@
+export const onlyParamOptions = {
+    body: /^body:/,
+    'body:json': /^body:json$/,
+    json: /json$/,
+    'body:graphql': /^body:graphql$/,
+    graphql: /.+graphql/,
+    'body:graphql:vars': /^body:graphql:vars$/,
+    script: /^script:/,
+    'script:pre-request': /^script:pre-request$/,
+    'pre-request': /.+:pre-request$/,
+    'script:post-response': /^script:post-response$/,
+    'post-response': /.+:post-response$/,
+    tests: /^tests$/,
+}
+
+/**
+ * @param {?string} only Value to be validated
+ * @throws Error
+ * @returns void
+ */
+export function validateOnlyParam(only) {
+    if (only !== null && !Object.hasOwn(onlyParamOptions, only)) {
+        throw new Error('Invalid value for only parameter')
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettify-bru",
-  "version": "1.9.0",
+  "version": "1.9.2",
   "description": "Prettifies JSON, JavaScript and GraphQL blocks in Bruno .bru files",
   "keywords": [
     "bruno",