prettify-bru 0.1.10 → 0.1.12

package/README.md

@@ -4,20 +4,26 @@ A simple CLI tool to prettify the contents of `.bru` files.
 
 ## Installation
 
+Requires Node.js 20+
+
 To install in your project, run:
 
 ```
 npm i prettify-bru
 ```
 
-Boom, now you can get a non-destructive report of all the incorrect formatting by running:
+Boom, now you should be ready to go!
+
+## Usage
+
+Get a non-destructive report of all files that could potentially be re-formatted by running:
 
 ```
 npx prettify-bru
 ```
 
-The above command will walk subdirectories, finding all `.bru` files. 
-With each file it will assess the formatting of the JSON/JavsScript inside the following types of block:
+The above command will walk all subdirectories finding `.bru` files. 
+With each file it will assess the formatting of the JSON/JavaScript inside the following types of block:
 
 - `body:json` will be parsed with the JSON parser
 - `script:pre-request` blocks parsed with Babel
@@ -31,3 +37,9 @@ npx prettify-bru --write
 ```
 
 ⚠️ This will modify the files in place, use with caution.
+
+To just do a single subdirectory, provide the path as an argument, so search the folder names "speed-tests":
+
+```
+npx prettify-bru speed-tests
+```

package/cli.js

@@ -5,18 +5,20 @@ import {hideBin} from 'yargs/helpers';
 import {main} from './lib/main.js';
 
 const argv = yargs(hideBin(process.argv))
-    .usage(`
-Usage: $0 [--write|-w] path
-
-Running the command with no arguments will modify all files
-
-`).options({
+    .command('$0 [path] [-w|--write]', `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({
         w: {
+            alias: 'write',
             type: 'boolean',
-            default: false
-        },
-        path: {
-            default: '.',
+            default: false,
         },
     })
     .describe({
@@ -24,15 +26,13 @@ Running the command with no arguments will modify all files
         h: 'Display the help message',
     })
     .boolean(['w', 'h'])
-    .help()
     .alias('h', 'help')
-    .alias('w', 'write')
     .parse();
 
 if (argv.h) {
     yargs.showHelp();
 } else {
-    go(argv._[0], argv.w);
+    go(argv.path, argv.w);
 }
 
 function go(path, write) {

package/lib/format.js

@@ -25,7 +25,7 @@ export async function formatBlocks(originalContents) {
 
     let fileOutcome = {
         newContents: originalContents.replace(/\r\n/g, "\n"),
-        changed: false,
+        changeable: false,
         error_messages: []
     }
 
@@ -34,8 +34,8 @@ export async function formatBlocks(originalContents) {
         const blockOutcome = await formatBlock(fileOutcome.newContents, ...formattableBlocks[i])
         if (blockOutcome.error_message !== null) {
             fileOutcome.error_messages.push(blockOutcome.error_message)
-        } else if (blockOutcome.changed) {
-            fileOutcome.changed = true
+        } else if (blockOutcome.changeable) {
+            fileOutcome.changeable = true
             fileOutcome.newContents = blockOutcome.fileContents;
         }
     }
@@ -45,7 +45,7 @@ export async function formatBlocks(originalContents) {
 
 async function formatBlock(fileContents, blockName, parser) {
 
-    let outcome = {fileContents, changed: false, error_message: null};
+    let outcome = {fileContents, changeable: false, error_message: null};
 
     const blockBodyRegex = new RegExp('\n' + blockName + ' [{]\\n(.+?)\\n}\\n', 's')
     const match = fileContents.match(blockBodyRegex)
@@ -81,11 +81,11 @@ async function formatBlock(fileContents, blockName, parser) {
     const formattedBody = indentedLines.join("\n");
 
     if (formattedBody === rawBody) {
-        // Nothing has changed after formatting
+        // Nothing has changed after formatting, so this block is not changeable
         return outcome
     }
 
     outcome.fileContents = fileContents.replace(rawBody, formattedBody)
-    outcome.changed = true
+    outcome.changeable = true
     return outcome;
 }

package/lib/main.js

@@ -15,10 +15,8 @@ import {formatBlocks} from './format.js'
  */
 export async function main(cwd, path, write) {
 
-    if (path === '.') {
+    if (path === '') {
         path = cwd
-    } else if (!/^\//.test(path)) {
-        // Path is absolute, do not modify
     } else {
         // Append the relative path to the current working directory
         path = cwd + '/' + path
@@ -37,24 +35,27 @@ export async function main(cwd, path, write) {
 
     console.log(`Found ${files.length} .bru file(s)\n`);
 
-    let changedFiles = [];
+    let changeableFiles = [];
     let erroredFiles = [];
 
     for (const filePath of files) {
-        const outcome = await processFile(filePath);
+        const outcome = await processFile(filePath, write);
 
-        let displayFilePath = filePath.replace(new RegExp('^' + cwd), "");
+        let displayFilePath = filePath.replace(new RegExp('^' + cwd + '/'), "");
 
-        if (outcome.changed) {
-            changedFiles.push({displayFilePath, outcome});
+        if (outcome.changeable) {
+            changeableFiles.push({displayFilePath, outcome});
         } else if (outcome.error_messages.length) {
             erroredFiles.push({displayFilePath, outcome});
         }
     }
 
-    if (changedFiles.length) {
-        console.log(`\x1b[4m\x1b[32mReformatted blocks in ${changedFiles.length} file(s):\x1b[0m\n`);
-        changedFiles.forEach((r) => console.log(`✏️  \x1b[32m${r.displayFilePath}\x1b[0m`));
+    const changeablePrefix = write ? 'Reformatted blocks' : 'Found blocks 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(" ")
     }
 
@@ -68,8 +69,10 @@ export async function main(cwd, path, write) {
         })
     }
 
+    const requireNothing = files.length - changeableFiles.length - erroredFiles.length;
     console.log(
-        `\x1b[35mProcessed ${files.length} .bru file(s).\x1b[0m Reformatted blocks in ${changedFiles.length}. Encountered errors in ${erroredFiles.length}.`
+        `\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.`
     );
 }
 
@@ -93,16 +96,14 @@ function walkDir(dir, onFile) {
     }
 }
 
-async function processFile(filePath) {
+async function processFile(filePath, write) {
     const original = fs.readFileSync(filePath, "utf8");
 
     const fileOutcome = await formatBlocks(original);
 
-    if (!fileOutcome.changed) {
-        return fileOutcome
+    if (write && fileOutcome.changeable) {
+        fs.writeFileSync(filePath, fileOutcome.newContents, "utf8");
     }
 
-    fs.writeFileSync(filePath, fileOutcome.newContents, "utf8");
-
     return fileOutcome;
 }

package/package.json

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