prettify-bru 1.3.0 → 1.4.0

package/cli.js

@@ -1,24 +1,36 @@
 #!/usr/bin/env node
 
-import yargs from 'yargs';
-import {hideBin} from 'yargs/helpers';
-import {main} from './lib/main.mjs';
+import yargs from 'yargs'
+import {hideBin} from 'yargs/helpers'
+import {main} from './lib/main.mjs'
 
 const argv = yargs(hideBin(process.argv))
-    .command('$0 [path] [-w|--write] [--only "..."]', `Formats all .bru files (including subdirectories)`, (yargs) => {
-        return yargs.positional('path', {
-            describe: 'The root path to search from',
-            type: 'string',
-            demandOption: false,
-            default: '',
-            defaultDescription: 'Current working directory'
-        })
-    })
+    .command(
+        '$0 [path] [-w|--write] [--only "..."]',
+        `Formats all .bru files (including subdirectories)`,
+        yargs => {
+            return yargs.positional('path', {
+                describe: 'The root path to search from',
+                type: 'string',
+                demandOption: false,
+                default: '',
+                defaultDescription: 'Current working directory',
+            })
+        }
+    )
     .options({
         only: {
             describe: 'Limit to only 1 block type',
             type: 'string',
-            choices: ['body:json', 'json', 'script:pre-request', 'pre-request', 'script:post-request', 'post-request', 'tests']
+            choices: [
+                'body:json',
+                'json',
+                'script:pre-request',
+                'pre-request',
+                'script:post-request',
+                'post-request',
+                'tests',
+            ],
         },
         w: {
             describe: 'Write mode (Formats files in place, overwriting contents)',
@@ -29,12 +41,12 @@ const argv = yargs(hideBin(process.argv))
     })
     .boolean(['w', 'h'])
     .alias('h', 'help')
-    .parse();
+    .parse()
 
 if (argv.h) {
-    yargs.showHelp();
+    yargs.showHelp()
 } else {
-    go(argv.path, argv.w, argv.only ?? null);
+    go(argv.path, argv.w, argv.only ?? null)
 }
 
 /**
@@ -44,13 +56,13 @@ if (argv.h) {
  */
 function go(path, write, only) {
     main(console, process.cwd(), path, write, only)
-    .then(changesRequired => {
-        if (changesRequired) {
+        .then(changesRequired => {
+            if (changesRequired) {
+                process.exitCode = 1
+            }
+        })
+        .catch(err => {
+            console.error(err)
             process.exitCode = 1
-        }
-    })
-    .catch((err) => {
-        console.error(err);
-        process.exitCode = 1;
-    });
+        })
 }

package/lib/files.mjs

@@ -1,4 +1,4 @@
-import fs from 'fs';
+import fs from 'fs'
 import path from 'path'
 
 /**
@@ -6,7 +6,7 @@ import path from 'path'
  * @returns {string}
  */
 export function readFile(filePath) {
-    return fs.readFileSync(filePath, "utf8")
+    return fs.readFileSync(filePath, 'utf8')
 }
 
 /**
@@ -15,20 +15,20 @@ export function readFile(filePath) {
  * @returns void
  */
 export function writeFile(filePath, contents) {
-    fs.writeFileSync(filePath, contents, "utf8")
+    fs.writeFileSync(filePath, contents, 'utf8')
 }
 
 export function findFiles(path) {
-    const files = [];
+    const files = []
 
     if (path.match(/\.bru$/) && fs.existsSync(path)) {
         return [path]
     }
 
-    walkDir(path, (p) => {
-        if (p.endsWith(".bru")) files.push(p);
-    });
-    return files;
+    walkDir(path, p => {
+        if (p.endsWith('.bru')) files.push(p)
+    })
+    return files
 }
 
 /**
@@ -42,20 +42,20 @@ export function findFiles(path) {
  */
 function walkDir(dir, onFile) {
     // Skip node_modules by default
-    const skip = new Set(["node_modules", ".git"]);
-    let entries;
+    const skip = new Set(['node_modules', '.git'])
+    let entries
     try {
-        entries = fs.readdirSync(dir, {withFileTypes: true});
+        entries = fs.readdirSync(dir, {withFileTypes: true})
     } catch (e) {
-        return;
+        return
     }
     for (const entry of entries) {
-        const full = path.join(dir, entry.name);
+        const full = path.join(dir, entry.name)
         if (entry.isDirectory()) {
-            if (skip.has(entry.name)) continue;
-            walkDir(full, onFile);
+            if (skip.has(entry.name)) continue
+            walkDir(full, onFile)
         } else if (entry.isFile()) {
-            onFile(full);
+            onFile(full)
         }
     }
 }

package/lib/format.mjs

@@ -7,8 +7,8 @@ const prettierConfig = {
     singleQuote: false,
     useTabs: false,
     bracketSpacing: false,
-    trailingComma: "none",
-    endOfLine: "lf",
+    trailingComma: 'none',
+    endOfLine: 'lf',
 }
 
 const formattableBlocks = [
@@ -19,36 +19,41 @@ const formattableBlocks = [
 ]
 
 /**
- * Uses Prettier to format blocks of JSON/JavaScript
+ * Tidies overall structure of bru lang file and uses Prettier to format blocks of JSON/JavaScript
  *
  * @param {string} originalContents The file contents as loaded from file system
  * @param {?string} only Limit to only the block type with a name containing value
- * @returns {Promise<{newContents: string, blocksSearchedFor: number, changeable: number, error_messages: string[]}>}
+ * @returns {Promise<{newContents: string, blocksSearchedFor: number, changeable: boolean, errorMessages: string[]}>}
  */
-export async function formatBlocks(originalContents, only = null) {
-
+export async function format(originalContents, only = null) {
     let fileOutcome = {
-        newContents: originalContents.replace(/\r\n/g, "\n"),
+        newContents: originalContents.replace(/\r\n/g, '\n'),
         blocksSearchedFor: 0,
-        changeable: 0,
-        error_messages: []
+        changeable: false,
+        errorMessages: [],
     }
 
     let i
     for (i in formattableBlocks) {
         let [blockName, parser] = formattableBlocks[i]
-        if (only !== null && !blockName.includes(only)) continue;
+        if (only !== null && !blockName.includes(only)) continue
 
         const blockOutcome = await formatBlock(fileOutcome.newContents, blockName, parser)
         fileOutcome.blocksSearchedFor++
-        if (blockOutcome.error_message !== null) {
-            fileOutcome.error_messages.push(blockOutcome.error_message)
+        if (blockOutcome.errorMessage !== null) {
+            fileOutcome.errorMessages.push(blockOutcome.errorMessage)
         } else if (blockOutcome.changeable) {
-            fileOutcome.changeable++
+            fileOutcome.changeable = true
             fileOutcome.newContents = blockOutcome.fileContents
         }
     }
 
+    const overallOutcome = formatOverallStructure(fileOutcome.newContents)
+    if (overallOutcome.changeable) {
+        fileOutcome.changeable = true
+        fileOutcome.newContents = overallOutcome.fileContents
+    }
+
     return fileOutcome
 }
 
@@ -56,11 +61,10 @@ export async function formatBlocks(originalContents, only = null) {
  * @param {string} fileContents
  * @param {string} blockName
  * @param {string} parser
- * @returns {Promise<{fileContents: string, changeable: boolean, error_message: ?string}>}
+ * @returns {Promise<{fileContents: string, changeable: boolean, errorMessage: ?string}>}
  */
 async function formatBlock(fileContents, blockName, parser) {
-
-    let outcome = {fileContents, changeable: false, error_message: null}
+    let outcome = {fileContents, changeable: false, errorMessage: null}
 
     const blockBodyRegex = new RegExp('\n' + blockName + ' [{]\\n(.+?)\\n}\\n', 's')
     const match = fileContents.match(blockBodyRegex)
@@ -69,28 +73,31 @@ async function formatBlock(fileContents, blockName, parser) {
     }
     const rawBody = match[1]
 
-    // Remove 2-spaces of indentation, added due to being inside a Bru lang Multimap
-    const unindented = rawBody.replace(/^  /gm, "")
+    // Remove 2-spaces of indentation, added due to being inside a Bru lang block
+    const unindented = rawBody.replace(/^  /gm, '')
 
-    let prettierFormatted;
+    let prettierFormatted
 
     try {
-        prettierFormatted = await prettier.format(unindented, Object.assign(prettierConfig, {parser}));
+        prettierFormatted = await prettier.format(
+            unindented,
+            Object.assign(prettierConfig, {parser})
+        )
     } catch (e) {
-        outcome.error_message = `Prettier could not format ${blockName} because...\n${e.message}`;
+        outcome.errorMessage = `Prettier could not format ${blockName} because...\n${e.message}`
         return outcome
     }
 
-    const bodyLines = prettierFormatted.split("\n");
+    const bodyLines = prettierFormatted.split('\n')
 
     // Remove leading/trailing empty lines
-    while (bodyLines.length && bodyLines[0].trim() === "") bodyLines.shift();
-    while (bodyLines.length && bodyLines[bodyLines.length - 1].trim() === "") bodyLines.pop();
+    while (bodyLines.length && bodyLines[0].trim() === '') bodyLines.shift()
+    while (bodyLines.length && bodyLines[bodyLines.length - 1].trim() === '') bodyLines.pop()
 
     // Indent the whole body by 2 spaces so it sits inside the Bru lang Multimap
-    const indentedLines = bodyLines.map((l) => "  " + l)
+    const indentedLines = bodyLines.map(l => '  ' + l)
 
-    const formattedBody = indentedLines.join("\n");
+    const formattedBody = indentedLines.join('\n')
 
     if (formattedBody === rawBody) {
         // Nothing has changed after formatting, so this block is not changeable
@@ -99,5 +106,20 @@ async function formatBlock(fileContents, blockName, parser) {
 
     outcome.fileContents = fileContents.replace(rawBody, formattedBody)
     outcome.changeable = true
-    return outcome;
+    return outcome
+}
+
+/**
+ * @param {string} fileContents
+ * @returns {fileContents: string, changeable: boolean}
+ */
+function formatOverallStructure(fileContents) {
+    if (fileContents.match(/\n[}]\n[\s]+\n\w+/s) === null) {
+        return {fileContents, changeable: false}
+    }
+
+    return {
+        fileContents: fileContents.replaceAll(/(\n[}]\n)([\s]+)(\n\w+)/gs, '$1$3'),
+        changeable: true,
+    }
 }

package/lib/main.mjs

@@ -1,5 +1,5 @@
-import {findFiles, readFile, writeFile} from './files.mjs';
-import {formatBlocks} from './format.mjs'
+import {findFiles, readFile, writeFile} from './files.mjs'
+import {format} from './format.mjs'
 
 /**
  * Finds all .bru files and formats contents
@@ -12,7 +12,6 @@ import {formatBlocks} from './format.mjs'
  * @returns {Promise<boolean>} True means some files contained errors or needed reformatting
  */
 export async function main(console, cwd, path, write, only = null) {
-
     if (path === '') {
         path = cwd
     } else {
@@ -20,56 +19,60 @@ export async function main(console, cwd, path, write, only = null) {
         path = cwd + '/' + path
     }
 
-    const files = findFiles(path);
+    const files = findFiles(path)
 
     if (files.length === 0) {
-        console.log("No .bru files found.");
-        return;
+        console.log('No .bru files found.')
+        return
     }
 
-    console.log(`Found ${files.length} .bru file(s)\n`);
+    console.log(`Found ${files.length} .bru file(s)\n`)
 
-    let changeableFiles = [];
-    let erroredFiles = [];
+    let changeableFiles = []
+    let erroredFiles = []
 
     for (const filePath of files) {
-        const outcome = await processFile(filePath, write, only);
+        const outcome = await processFile(filePath, write, only)
 
-        let displayFilePath = filePath.replace(new RegExp('^' + cwd + '/'), "");
+        let displayFilePath = filePath.replace(new RegExp('^' + cwd + '/'), '')
 
         if (outcome.changeable) {
-            changeableFiles.push({displayFilePath, outcome});
-        } else if (outcome.error_messages.length) {
-            erroredFiles.push({displayFilePath, outcome});
+            changeableFiles.push({displayFilePath, outcome})
+        } else if (outcome.errorMessages.length) {
+            erroredFiles.push({displayFilePath, outcome})
         }
     }
 
-    const changeablePrefix = write ? 'Reformatted blocks' : 'Found blocks that need reformatting';
+    const changeablePrefix = write ? 'Reformatted lines' : 'Found lines that need reformatting'
 
     if (changeableFiles.length) {
-        const emoji = write ? '✏️' : '🔍';
-        console.log(`\x1b[4m\x1b[32m${changeablePrefix} in ${changeableFiles.length} file(s):\x1b[0m\n`);
-        changeableFiles.forEach((r) => console.log(`${emoji}  \x1b[32m${r.displayFilePath}\x1b[0m`));
-        console.log(" ")
+        const emoji = write ? '✏️' : '🔍'
+        console.log(
+            `\x1b[4m\x1b[32m${changeablePrefix} in ${changeableFiles.length} file(s):\x1b[0m\n`
+        )
+        changeableFiles.forEach(r => console.log(`${emoji}  \x1b[32m${r.displayFilePath}\x1b[0m`))
+        console.log(' ')
     }
 
     if (erroredFiles.length) {
-        console.warn(`\x1b[4m\x1b[33mEncountered errors in ${erroredFiles.length} file(s):\x1b[0m\n`);
+        console.warn(
+            `\x1b[4m\x1b[33mEncountered errors in ${erroredFiles.length} file(s):\x1b[0m\n`
+        )
         erroredFiles.forEach((r, i) => {
             console.warn(`${i + 1}) ${r.displayFilePath}\n`)
-            r.outcome.error_messages.forEach((err) => {
+            r.outcome.errorMessages.forEach(err => {
                 console.warn(`⚠️  \x1b[33m${err}\x1b[0m\n`)
             })
         })
     }
 
-    const requireNothing = files.length - changeableFiles.length - erroredFiles.length;
+    const requireNothing = files.length - changeableFiles.length - erroredFiles.length
     console.log(
-        `\x1b[35mProcessed ${files.length} .bru file(s):\x1b[0m ${changeablePrefix} in ${changeableFiles.length}. `
-        + `Encountered errors in ${erroredFiles.length}. ${requireNothing} file(s) did not require any changes.`
-    );
+        `\x1b[35mProcessed ${files.length} .bru file(s):\x1b[0m ${changeablePrefix} in ${changeableFiles.length}. ` +
+            `Encountered errors in ${erroredFiles.length}. ${requireNothing} file(s) did not require any changes.`
+    )
 
-    return (erroredFiles.length > 0 || changeableFiles.length > 0)
+    return erroredFiles.length > 0 || changeableFiles.length > 0
 }
 
 /**
@@ -79,13 +82,13 @@ export async function main(console, cwd, path, write, only = null) {
  * @returns {Promise<void>}
  */
 async function processFile(filePath, write, only) {
-    const original = readFile(filePath);
+    const original = readFile(filePath)
 
-    const fileOutcome = await formatBlocks(original, only);
+    const fileOutcome = await format(original, only)
 
-    if (write && fileOutcome.changeable > 0) {
-        writeFile(filePath, fileOutcome.newContents);
+    if (write && fileOutcome.changeable) {
+        writeFile(filePath, fileOutcome.newContents)
     }
 
-    return fileOutcome;
+    return fileOutcome
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prettify-bru",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Prettifies JSON and JavaScript blocks in Bruno .bru files",
   "keywords": [
     "bruno",
@@ -32,7 +32,9 @@
     "yargs": "18.0.0"
   },
   "scripts": {
-    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --verbose"
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --verbose",
+    "prettier:check": "npx prettier --check --parser babel '**/*.mjs' '**/*.js'",
+    "prettier:fix": "npx prettier --write --parser babel '**/*.mjs' '**/*.js'"
   },
   "devDependencies": {
     "@jest/globals": "^30.2.0",