@frakjs/frak 0.1.1 → 0.2.0

package/README.md

@@ -6,19 +6,18 @@
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 [![MIT][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
 
 <!-- PROJECT LOGO -->
 <br />
 <div align="center">
   <a href="https://github.com/frakjs/frak">
-    <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="lucide lucide-cloud-upload-icon lucide-cloud-upload"><path d="M12 13v8"/><path d="M4 14.899A7 7 0 1 1 15.71 8h1.79a4.5 4.5 0 0 1 2.5 8.242"/><path d="m8 17 4-4 4 4"/></svg>
+    <img src="images/logos/Frak Logo - Green - 256.png" width="112" />
   </a>
 
   <h3 align="center">frak</h3>
 
   <p align="center">
-    Quick deployment tool using Rsync and SSH.
+    Deploy from point A → point B, without the drama.
     <br />
     <br />
     <a href="https://github.com/frakjs/frak/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
@@ -38,7 +37,6 @@
       <a href="#getting-started">Getting Started</a>
       <ul>
         <li><a href="#prerequisites">Prerequisites</a></li>
-        <li><a href="#installation">Installation</a></li>
       </ul>
     </li>
     <li><a href="#usage">Usage</a></li>
@@ -46,7 +44,6 @@
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
     <li><a href="#contact">Contact</a></li>
-    <li><a href="#acknowledgments">Acknowledgments</a></li>
   </ol>
 </details>
 
@@ -57,9 +54,9 @@
 
 [![Product Name Screen Shot][product-screenshot]](https://frakjs.com)
 
-**`frak`** is an agentless deployment tool for web apps. It leverages `rsync` over SSH to push files to a remote server, and is able to visualize file changes in a developer-friendly way. **`frak`** has a number of advanced features beyond syncing files to a remote server, such as keeping a history of deployments for easy rollback, showing file differences prior to pushing, and post-deploy hooks.
+**`frak`** is a tiny JavaScript binary for deployments that don’t need containers or repos—just fast, reliable file transfer from point A to point B.
 
-> “Frak it, ship it.”
+It leverages `rsync` over SSH to push files to a remote server, and is able to visualize file changes in a developer-friendly way. **`frak`** has a number of advanced features beyond syncing files to a remote server, such as keeping a history of deployments for easy rollback, showing file differences prior to pushing, and executing post-deploy hooks.
 
 ### 🚀 Features
 
@@ -76,7 +73,7 @@
 <!-- GETTING STARTED -->
 ## Getting Started
 
-Using frak is simple. All you need is a [Node.js](https://nodejs.org) environment with `npx`.
+Using **`frak`** is simple. All you need is a [Node.js](https://nodejs.org) environment with `npx`.
 
 ### Prerequisites
 
@@ -95,7 +92,7 @@ npx --version
 <!-- USAGE EXAMPLES -->
 ## Usage
 
-The recommended way to run `frak` is via the `npx` command.
+The recommended way to run **`frak`** is via the `npx` command.
 
 ```bash
 npx @frakjs/frak --help
@@ -189,7 +186,7 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.
 <!-- CONTACT -->
 ## Contact
 
-Your Name - [@strube](https://twitter.com/strube) - contact@frakjs.com
+Frank Strube - [@strube](https://x.com/strube) - contact@frakjs.com
 
 Project Link: [https://github.com/frakjs/frak](https://github.com/frakjs/frak)
 
@@ -207,8 +204,7 @@ Project Link: [https://github.com/frakjs/frak](https://github.com/frakjs/frak)
 [issues-url]: https://github.com/frakjs/frak/issues
 [license-shield]: https://img.shields.io/github/license/frakjs/frak.svg?style=for-the-badge
 [license-url]: https://github.com/frakjs/frak/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/linkedin_username
-[product-screenshot]: images/screenshot.png
-[prerequisites-screenshot]: images/node-npm-version.png
-[frak-init-screenshot]: images/frak-init-screenshot.png
+[green-logo]: images/logos/Frak%20Logo%20-%20Green%20-%20256.png
+[product-screenshot]: images/screenshots/screenshot.png
+[prerequisites-screenshot]: images/screenshots/node-npm-version.png
+[frak-init-screenshot]: images/screenshots/frak-init-screenshot.png

package/bin/frak.js

@@ -1,8 +1,7 @@
 #!/usr/bin/env node
 
 import { execSync, spawn } from 'node:child_process';
-import { readFileSync, writeFileSync, existsSync, statSync } from 'node:fs';
-import { fileURLToPath } from 'node:url';
+import { writeFileSync, existsSync } from 'node:fs';
 import path from 'node:path';
 import * as ansi from '../src/ansi.js';
 import * as cli from '../src/cli.js';
@@ -15,8 +14,6 @@ import * as rsync from '../src/rsync.js';
 import * as ssh from '../src/ssh.js';
 import * as date from '../src/date.js';
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-
 /**
  * Try to load config. If it fails, print error message in red.
  *
@@ -26,7 +23,7 @@ async function tryLoadConfig(env) {
     try {
         await loadConfig(env);
     } catch (e) {
-        console.log(ansi.red(e.message));
+        console.error(ansi.red(e.message));
 
         process.exit(1);
     }
@@ -58,7 +55,6 @@ async function main(args) {
 
     debug('parsed:', { command, options });
 
-
     // Initialize Frak in the current directory
     if (command === 'init') {
         const configPath = path.join(process.cwd(), 'frak.config.js');
@@ -91,9 +87,17 @@ async function main(args) {
     } else if (command === 'diff') {
         await tryLoadConfig(options.env);
 
-        const { output } = await rsync.exec('--dry-run');
+        try {
+            const { output } = await rsync.exec('--dry-run');
 
-        await diff(output, options);
+            debug({ output });
+
+            await diff(output, options);
+        } catch (e) {
+            debug(e);
+
+            console.error(e.message);
+        }
 
     // Push or pull changes to remote server
     } else if (command === 'push' || command === 'pull') {
@@ -102,10 +106,13 @@ async function main(args) {
         // Execute dry-run
         const { output } = await rsync.exec('--dry-run');
 
+        debug({ output });
+
         console.log(humanize(output));
 
         if (command === 'push' && config.after) {
-            console.log(ansi.blue('Run command:'), config.after, '\n');
+            console.log(ansi.blue('Run command:'), config.after);
+            console.log('');
         }
 
         const proceed = await cli.agree(ansi.yellow('The above actions will be taken. Continue? (This cannot be undone): '));
@@ -115,14 +122,18 @@ async function main(args) {
         }
 
         // Prepare patch file
-        let patch;
+        let patch = '';
 
-        try {
-            patch = await diff(output, { interactive: false });
-        } catch (e) {
-            console.error(e);
+        if (command === 'push') {
+            try {
+                patch = await diff(output, { interactive: false });
+            /* node:coverage disable */
+            } catch (e) {
+                console.error(e);
 
-            process.exit(1);
+                process.exit(1);
+            }
+            /* node:coverage enable */
         }
 
         // Execute actual rsync command
@@ -132,12 +143,14 @@ async function main(args) {
         console.log(humanize(actualOutput));
 
         // Place patch file in backup dir
-        const hash = sha256(patch).slice(0, 7);
-        const copy = spawn('ssh', [config.server, '--', `cat > '${config.root || '.'}/${backupPath}/${hash}.patch'`]);
+        if (command === 'push') {
+            const hash = sha256(patch).slice(0, 7);
+            const copy = spawn('ssh', [config.server, '--', `cat > '${config.root || '.'}/${backupPath}/${hash}.patch'`]);
 
-        copy.stdout.on('data', (data) => debug('' + data));
-        copy.stderr.on('data', (data) => debug('' + data));
-        copy.stdin.write(patch);
+            copy.stdout.on('data', (data) => debug('' + data));
+            copy.stderr.on('data', (data) => debug('' + data));
+            copy.stdin.write(patch);
+        }
 
         // Execute "after" command
         if (command === 'push' && config.after) {
@@ -147,9 +160,11 @@ async function main(args) {
 
             try {
                 await ssh.exec(config.after, { server: config.server, root: config.root });
+            /* node:coverage disable */
             } catch (e) {
                 debug(e);
             }
+            /* node:coverage enable */
         }
 
         // TODO Webhook

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frakjs/frak",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A commandline deployment tool for syncing files to remote servers.",
   "main": "index.js",
   "bin": {
@@ -8,7 +8,8 @@
   },
   "type": "module",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "eslint": "eslint",
+    "test": "node --test --experimental-test-coverage"
   },
   "repository": {
     "type": "git",
@@ -24,5 +25,13 @@
   "bugs": {
     "url": "https://github.com/frakjs/frak/issues"
   },
-  "homepage": "https://github.com/frakjs/frak#readme"
+  "homepage": "https://github.com/frakjs/frak#readme",
+  "devDependencies": {
+    "@eslint/js": "^9.33.0",
+    "eslint": "^9.33.0",
+    "globals": "^16.3.0"
+  },
+  "dependencies": {
+    "yaml": "^2.8.1"
+  }
 }

package/src/ansi.js

@@ -15,7 +15,7 @@ const ansi = {
 };
 
 export function strip(string) {
-    return string
+    return `${string}`
         .replace(new RegExp(ansi.CLEAR.replace('[', '\\['), 'g'), '')
         .replace(new RegExp(ansi.BOLD.replace('[', '\\['), 'g'), '')
         .replace(new RegExp(ansi.UNDERLINE.replace('[', '\\['), 'g'), '')

package/src/cli.js

@@ -13,7 +13,11 @@ export function parse(args) {
     };
 
     for (let arg of args) {
-        if (arg.includes('=')) {
+        if (arg === '--yes' || arg === '-y') {
+            options.interactive = false;
+        } else if (arg === '--no-color') {
+            options.colorize = false;
+        } else if (arg.includes('=')) {
             const [option, value] = arg.split('=', 2);
 
             options[option] = value;
@@ -25,11 +29,14 @@ export function parse(args) {
     return { command, options };
 }
 
-export async function agree(string) {
-    process.stdout.write(string);
+export async function agree(string, { stdin = null, stdout = null } = {}) {
+    stdout = stdout ?? process.stdout;
+    stdin = stdin ?? process.stdin;
 
-    const answer = await new Promise((resolve, reject) => {
-        process.stdin.on('data', data => resolve(data));
+    stdout.write(string);
+
+    const answer = await new Promise((resolve) => {
+        stdin.on('data', data => resolve(data));
     });
 
     return ['y', 'yes'].includes(`${answer}`.trim().toLowerCase());
@@ -67,7 +74,6 @@ export class Table {
                 const width = ansi.strip(cell).length
                 const padding = Math.max(0, this.columns[i].width - width - 2);
                 const paddingString = (new Array(padding + 1)).join(' ');
-                const borderString = (new Array(this.columns[i].width + 1).join('-'));
 
                 return `${row || ''}${ansi.gray('|')} ${cell}${paddingString} ${i === r.length - 1 ? ansi.gray('|') : ''}`
             }, '');

package/src/config.js

@@ -1,5 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
+import { parse } from 'yaml';
 
 // Cached config object. The config is stored in here so it can
 // be loaded once and imported across all modules.
@@ -13,10 +14,15 @@ let config = {};
 export function locate() {
     for (let dir = process.cwd(); dir != '/'; dir = path.dirname(dir)) {
         const configPath = path.join(dir, 'frak.config.js');
+        const yamlPath = path.join(dir, '.frak');
 
         if (fs.existsSync(configPath)) {
             return configPath;
         }
+
+        if (fs.existsSync(yamlPath)) {
+            return yamlPath;
+        }
     }
 
     return null;
@@ -30,21 +36,51 @@ export function locate() {
 export async function load(env = null) {
     const configPath = locate();
 
-    if (fs.existsSync(configPath)) {
+    if (!fs.existsSync(configPath)) {
+        throw new Error('Config file not found! Try running frak init.');
+    }
+
+    if (path.basename(configPath) === 'frak.config.js') {
         Object.assign(config, (await import(configPath)).default);
+    } else if (path.basename(configPath) === '.frak') {
+        Object.assign(config, parse(fs.readFileSync(configPath).toString('utf-8')));
+    }
 
-        if (env in config) {
-            return Object.assign(config, {...config[env]});
-        }
+    if (env in config) {
+        Object.assign(config, {...config[env]});
 
-        if (env) {
-            throw new Error(`Missing configuration for environment "${env}"!`);
-        }
+        delete config[env];
 
         return config;
     }
 
-    throw new Error('Config file not found! Try running frak init.');
+    if (env) {
+        throw new Error(`Missing configuration for environment "${env}"!`);
+    }
+
+    // Support legacy config, remote_path instead of root
+    if ('remote_path' in config) {
+        config.root = config.remote_path;
+
+        delete config.remote_path;
+    }
+
+    return config;
+}
+
+/**
+ * Reset the config, useful when unit testing.
+ *
+ * @returns {Object}
+ */
+export function reset() {
+    const old = { ...config };
+
+    Object.entries(config).forEach(([key]) => {
+        delete config[key];
+    });
+
+    return old;
 }
 
 export default config;

package/src/date.js

@@ -54,7 +54,7 @@ export function relative(date) {
         value = Math.floor(seconds / 60 / 60 / 24 / 30);
         unit = plural('month', value);
     } else {
-        return `${months[datetime.getMonth()]} ${datetime.getDay()}, ${datetime.getFullYear()} @ ${datetime.getHours() % 12}:${`0${datetime.getMinutes()}`.slice(-2)} ${datetime.getHours() >= 12 ? 'pm' : 'am'}`;
+        return `${months[datetime.getMonth()]} ${datetime.getDate()}, ${datetime.getFullYear()} @ ${datetime.getHours() % 12}:${`0${datetime.getMinutes()}`.slice(-2)} ${datetime.getHours() >= 12 ? 'pm' : 'am'}`;
     }
 
     return `${value} ${unit} ${agoOrFromNow}`.trim();

package/src/debug.js

@@ -5,6 +5,6 @@ import * as ansi from '../src/ansi.js';
  */
 export default function debug() {
     if (process.env.DEBUG) {
-        console.log.apply(console, [ansi.bold(ansi.cyan('DEBUG:')), ...arguments]);
+        console.log.apply(console, [ ansi.bold(ansi.cyan('DEBUG:')), ...arguments ]);
     }
 }

package/src/diff.js

@@ -1,6 +1,7 @@
 import { spawn } from 'node:child_process';
 import { statSync } from 'node:fs';
 import * as ansi from './ansi.js';
+import * as cli from './cli.js';
 import config from './config.js';
 import debug from './debug.js';
 
@@ -21,8 +22,8 @@ export default async function diff(dryRunOutput, options) {
 
             let file, target;
 
-            // Links also have a target
-            if (action === 'cL+++++++++' || action === 'cLc.T......') {
+            // Links also have a target, cL+++++++++ or cLc.T......
+            if (action.match(/^cL.+/)) {
                 const index = parts.indexOf('->');
 
                 debug({ parts })
@@ -35,64 +36,68 @@ export default async function diff(dryRunOutput, options) {
 
             return [action, file, target];
         })
-        .filter(([action, file]) => file.slice(-1) !== '/');
+        .filter(([, file]) => file.slice(-1) !== '/');
 
     debug({ changes })
 
     let proceed = true;
 
     if (changes.length >= 50 && options.interactive) {
-        proceed = await cli.agree(ansi.yellow(`${changes.length} file(s) will be compared. Continue?`))
+        proceed = await cli.agree(ansi.yellow(`${changes.length} file(s) will be compared. Continue? `))
     }
 
     if (!proceed) {
         return Promise.reject('Process canceled by user');
     }
 
-    const files = changes.map(([action, file]) => file);
+    const files = changes.map(([, file]) => file);
 
     const diffs = changes.sort((a, b) => a[1].localeCompare(b[1])).map(change => {
         const [action, file] = change;
+
+        // Escape double quotes in file
+        const fileEscaped = file.replace(/"/g, '\\"');
+
         const header = [
-            `diff --git a/${file} b/${file}`,
+            file.match(/"/) ? `diff --git "a/${fileEscaped}" "b/${fileEscaped}"` : `diff --git a/${file} b/${file}`,
         ];
 
-        let diff = [];
+        let diff = '';
 
         if (action === '*deleting') {
             header.push('deleted file mode 100644');
             header.push('index 0000000..0000000');
 
-            diff = ['diff', '-Naurp', `--label=a/${file}`, `--label=/dev/null`, file, '/dev/null'];
-        } else if (action === '<f+++++++++') {
+            diff = `diff -Naurp --label="a/${fileEscaped}" --label=/dev/null "${fileEscaped}" /dev/null`;
+        } else if (action.match(/^<f\++/)) {
             const { mode } = statSync(file);
 
             header.push(`new file mode ${mode.toString(8)}`);
             header.push('index 0000000..0000000');
 
-            diff = ['diff', '-Naurp', `--label=/dev/null`, `--label=b/${file}`, '/dev/null', `<(tar xzOf $tarball --warning=no-unknown-keyword ${file} || cat /dev/null)`];
-        } else if (action === 'cLc.T......') {
+            diff = `diff -Naurp --label=/dev/null --label="b/${fileEscaped}" /dev/null <(tar xzOf $tarball "${fileEscaped}" || cat /dev/null)`;
+        } else if (action.match(/^cL\++/)) {
             const target = change[2];
 
+            header.push('new file mode 120000');
             header.push('index 0000000..0000000');
 
-            diff = ['diff', '-Naurp', `--label=a/${file}`, `--label=b/${file}`, `<(printf %s $(readlink ${file}))`, `<(printf %s ${target})`];
-        } else if (action === 'cL+++++++++') {
+            diff = `diff -Naurp --label=/dev/null --label="b/${fileEscaped}" /dev/null <(printf %s "${target}")`;
+        } else if (action.match(/^cL.+/)) {
             const target = change[2];
 
-            header.push('new file mode 120000');
             header.push('index 0000000..0000000');
 
-            diff = ['diff', '-Naurp', `--label=/dev/null`, `--label=b/${file}`, '/dev/null', `<(printf %s ${target})`];
+            diff = `diff -Naurp --label="a/${fileEscaped}" --label="b/${fileEscaped}" <(printf %s "$(readlink "${fileEscaped}")") <(printf %s "${target}")`;
         } else {
             const { mode } = statSync(file);
 
             header.push(`index 0000000..0000000  ${mode.toString(8)}`);
 
-            diff = ['diff', '-Naurp', `--label=a/${file}`, `--label=b/${file}`, file, `<(tar xzOf $tarball --warning=no-unknown-keyword ${file} || cat /dev/null)`];
+            diff = `diff -Naurp --label="a/${fileEscaped}" --label="b/${fileEscaped}" "${fileEscaped}" <(tar xzOf $tarball "${fileEscaped}" || cat /dev/null)`;
         }
 
-        return [`printf "%s\\n" "${header.join('\n')}"`, ';', ...diff, ';'];
+        return `printf "%s\\n" '${header.join('\n')}'; ${diff}`;
     });
 
     if (diffs.length > 0) {
@@ -103,19 +108,18 @@ export default async function diff(dryRunOutput, options) {
         const ssh = spawn('ssh', [
             config.server,
             '--',
-            'tarball=$(mktemp /tmp/frak-diff-tarball.XXXXXXXX);',
+            'tarball=$(mktemp /tmp/frak-diff-tarball.XXXXXX);',
             'cat > $tarball;',
             `cd ${config.root};`,
-            ...diffs.reduce((commands, diff) => commands.concat(...diff), []),
-            // `${diffs.join(';')};`,
-            // 'rm $tarball',
+            diffs.join('; '), ';',
+            'rm $tarball',
         ])
         tar.stdout.pipe(ssh.stdin);
 
         let less;
 
         if (options.interactive) {
-            less = spawn('less', ['-r'], { stdio: ['pipe', 'inherit', 'inherit'] });
+            less = spawn('less', ['-R'], { stdio: ['pipe', process.stdout, process.stderr] });
         }
 
         if (options.interactive && options.colorize) {
@@ -149,25 +153,31 @@ export default async function diff(dryRunOutput, options) {
                 less.on('exit', (code) => {
                     if (code === 0) {
                         resolve();
+                    /* node:coverage disable */
                     } else {
                         reject(`exited with code ${code}`);
                     }
+                    /* node:coverage enable */
                 });
             });
+        /* node:coverage disable */
         } else {
-            return await new Promise((resolve, reject) => {
+            return await new Promise((resolve) => {
                 let diff = '';
 
                 ssh.stdout.on('data', (data) => diff += data);
 
                 ssh.stderr.pipe(process.stderr);
 
-                ssh.on('exit', (code) => {
+                ssh.on('exit', () => {
                     resolve(diff);
                 });
             });
         }
+        /* node:coverage enable */
     } else if (options.interactive) {
         console.log(ansi.yellow('No changes detected.'));
     }
+
+    return '';
 }

package/src/humanize.js

@@ -9,5 +9,5 @@ export default function humanize(changes) {
         .replace(/<fc..\.\.\.\.\.\./g,    ansi.yellow('Update     '))
         .replace(/>fc..\.\.\.\.\.\./g,    ansi.yellow('Update     '))
         .replace(/cLc\.T\.\.\.\.\.\./g,   ansi.yellow('Update     '))
-        .replace(/\*deleting  /g,            ansi.red('Delete     '))
+        .replace(/\*deleting {2}/g,          ansi.red('Delete     '))
 }

package/src/rsync.js

@@ -19,6 +19,7 @@ export function filters() {
         '.git*',
         '.svn*',
         '.tags*',
+        'frak.config.js',
         'Capfile',
         'Gemfile*',
         'Vagrantfile*',
@@ -31,7 +32,8 @@ export function filters() {
 
     // merge path
     if (options.path) {
-        const paths = options.path.split(/ +/)
+        const paths = options.path.split(/((?<!\\) )+/)
+            .map(p => p.replace(/\\ /g, ' '))
             .map(p => path.resolve(p))
             .map(p => p) // TODO glob // paths.map! { |p| p[/[*?]/] ? Dir.glob(p) : p }
             .flat(Infinity)
@@ -136,9 +138,11 @@ export function exec(...options) {
         output += `${data}`;
     });
 
+    /* node:coverage disable */
     rsync.stderr.on('data', (data) => {
         process.stderr.write(`${data}`); // Print any errors from the child process
     });
+    /* node:coverage enable */
 
     return new Promise((resolve, reject) => {
         rsync.on('exit', (code) => {
@@ -147,9 +151,11 @@ export function exec(...options) {
                     output,
                     backupPath,
                 });
+            /* node:coverage disable */
             } else {
                 reject(`rsync exited with code ${code}`);
             }
+            /* node:coverage enable */
         });
     });
 }

package/src/ssh.js

@@ -31,9 +31,11 @@ export function exec(command, options = {}) {
         ssh.on('exit', (code) => {
             if (code === 0) {
                 resolve();
+            /* node:coverage disable */
             } else {
                 reject(`exited with code ${code}`);
             }
+            /* node:coverage enable */
         });
     });
 

package/eslint.config.js

@@ -1 +0,0 @@
-export default [{}]

package/frak.config.js

@@ -1,10 +0,0 @@
-export default {
-    server: 'franklinstrube.com',
-    root: '/home/ash/frak',
-    after: 'touch deployed; pwd',
-    method: 'rsync',
-
-    production: {
-        root: '/home/ash/frak-production',
-    },
-};