@frakjs/frak 0.3.0 → 0.5.0

package/.prettierrc

@@ -1,5 +1,5 @@
 {
-    "tabSize": 4,
+    "tabWidth": 4,
     "singleQuote": true,
     "semi": true,
     "trailingComma": "es5",

package/bin/frak.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 
 import { execSync, spawn } from 'node:child_process';
-import { writeFileSync, existsSync } from 'node:fs';
+import { readFileSync, writeFileSync, existsSync } from 'node:fs';
 import path from 'node:path';
+import { fileURLToPath } from 'node:url';
 import * as ansi from '../src/ansi.js';
 import * as cli from '../src/cli.js';
 import config, { load as loadConfig } from '../src/config.js';
@@ -14,6 +15,9 @@ import * as rsync from '../src/rsync.js';
 import * as ssh from '../src/ssh.js';
 import * as date from '../src/date.js';
 
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
 /**
  * Try to load config. If it fails, print error message in red.
  *
@@ -39,6 +43,19 @@ function usage() {
     console.log('  pull          Download the remote file(s)');
     console.log('  push          Deploy website via rsync');
     console.log('  backups:list  List backups on the server');
+    console.log('');
+    console.log('Options:');
+    console.log('  --help        Display the command usage');
+    console.log('  --version     Show the current version');
+}
+
+/**
+ * Print the current version
+ */
+function version() {
+    const { version } = JSON.parse(readFileSync(path.join(__dirname, '../package.json')));
+
+    console.log('Version:', version);
 }
 
 /**
@@ -82,6 +99,8 @@ async function main(args) {
             });
         } catch (e) {
             debug(e);
+
+            process.exit(e.status || 1);
         }
     } else if (command === 'diff') {
         // Show the differences between local files and remote server
@@ -183,7 +202,7 @@ async function main(args) {
             additions: `grep -e '^+' "$NAME"/*.patch | grep -v '^+++' | wc -l`,
             deletions: `grep -e '^-' "$NAME"/*.patch | grep -v '^---' | wc -l`,
         };
-        const ls = `stat --format='%Y %n' .backups/* | sort -r`;
+        const ls = `stat -c '%Y %n' .backups/* | sort -r`;
 
         const list = ssh.exec(
             `${ls} | xargs -I {} sh -c 'TIMESTAMP=$(echo {} | cut -d" " -f1); NAME=$(echo {} | cut -d" " -f2-); echo $TIMESTAMP${delimeter}$NAME${delimeter}$(${grep.additions})${delimeter}$(${grep.deletions})'`,
@@ -215,6 +234,7 @@ async function main(args) {
             .split(/\n/)
             .forEach((backup) => {
                 const [timestamp, name, additions, deletions] = backup.split(delimeter);
+                debug(backup);
                 table.row([
                     name.replace(/^.backups\//, ''),
                     date.relative(timestamp * 1000),
@@ -225,6 +245,8 @@ async function main(args) {
             });
 
         table.print();
+    } else if (command === '--version' || command === 'version') {
+        version();
     } else {
         usage();
 

package/package.json

@@ -1,40 +1,40 @@
 {
-  "name": "@frakjs/frak",
-  "version": "0.3.0",
-  "description": "A commandline deployment tool for syncing files to remote servers.",
-  "main": "index.js",
-  "engines": {
-    "node": ">=12"
-  },
-  "bin": {
-    "frak": "bin/frak.js"
-  },
-  "type": "module",
-  "scripts": {
-    "eslint": "eslint",
-    "test": "node --experimental-test-coverage tests/index.test.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/frakjs/frak.git"
-  },
-  "keywords": [
-    "rsync",
-    "deployment",
-    "ssh"
-  ],
-  "author": "Frank Strube <contact@frakjs.com>",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/frakjs/frak/issues"
-  },
-  "homepage": "https://github.com/frakjs/frak#readme",
-  "devDependencies": {
-    "@eslint/js": "^9.33.0",
-    "eslint": "^9.33.0",
-    "globals": "^16.3.0"
-  },
-  "dependencies": {
-    "yaml": "^1.10.0"
-  }
+    "name": "@frakjs/frak",
+    "version": "0.5.0",
+    "description": "A commandline deployment tool for syncing files to remote servers.",
+    "main": "index.js",
+    "engines": {
+        "node": ">=12"
+    },
+    "bin": {
+        "frak": "bin/frak.js"
+    },
+    "type": "module",
+    "scripts": {
+        "eslint": "eslint",
+        "test": "node --experimental-test-coverage tests/index.test.js"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/frakjs/frak.git"
+    },
+    "keywords": [
+        "rsync",
+        "deployment",
+        "ssh"
+    ],
+    "author": "Frank Strube <contact@frakjs.com>",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/frakjs/frak/issues"
+    },
+    "homepage": "https://github.com/frakjs/frak#readme",
+    "devDependencies": {
+        "@eslint/js": "^9.33.0",
+        "eslint": "^9.33.0",
+        "globals": "^16.3.0"
+    },
+    "dependencies": {
+        "yaml": "^1.10.0"
+    }
 }

package/src/config.js

@@ -1,6 +1,6 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import * as yaml from 'yaml';
+import yaml from 'yaml';
 
 // Cached config object. The config is stored in here so it can
 // be loaded once and imported across all modules.

package/src/crypto.js

@@ -1,5 +1,9 @@
 import crypto from 'node:crypto';
 
 export function sha256(text) {
+    if (typeof text === 'number') {
+        text = `${text}`;
+    }
+
     return crypto.createHash('sha256').update(text).digest('hex');
 }

package/src/diff.js

@@ -1,7 +1,8 @@
 import { spawn } from 'node:child_process';
-import { statSync } from 'node:fs';
+import { existsSync, statSync, unlinkSync, writeFileSync } from 'node:fs';
 import * as ansi from './ansi.js';
 import * as cli from './cli.js';
+import * as crypto from './crypto.js';
 import config from './config.js';
 import debug from './debug.js';
 
@@ -16,6 +17,8 @@ export default async function diff(dryRunOutput, options) {
     const changes = dryRunOutput
         .split(/\r?\n/)
         .filter(Boolean)
+        .filter((line) => !/^created directory .*/.test(line))
+        .filter((line) => !/^cannot delete non-empty directory:.*/.test(line))
         .map((line) => {
             // Split line into action and file, preserving whitespace for filenames
             const [action, ...parts] = line.split(/\s+/);
@@ -52,7 +55,7 @@ export default async function diff(dryRunOutput, options) {
         return Promise.reject('Process canceled by user');
     }
 
-    const files = changes.map(([, file]) => file);
+    const files = changes.map(([, file]) => file).filter((file) => existsSync(file));
 
     const diffs = changes
         .sort((a, b) => a[1].localeCompare(b[1]))
@@ -109,18 +112,47 @@ export default async function diff(dryRunOutput, options) {
     if (diffs.length > 0) {
         debug({ diffs, files });
 
+        const diffsScriptFilename = `.frak-diffs-${crypto.sha256(Date.now())}.sh`;
+
+        writeFileSync(`/tmp/${diffsScriptFilename}`, diffs.join(';'));
+
         // Tarball the local files up to the server
-        const tar = spawn('tar', ['cz', ...files]);
+        const tar = spawn('tar', ['cz', ...files, `/tmp/${diffsScriptFilename}`]);
+
+        // Handle tar errors
+        tar.on('error', (error) => {
+            throw error;
+        });
+
+        // Cleanup the diffs script
+        tar.on('exit', () => {
+            unlinkSync(`/tmp/${diffsScriptFilename}`);
+        });
+
+        // Run ssh, it takes the tarball through stdin, and expands it inline to generate diffs.
+        // Don't forget, each command after the -- needs to end in a semicolon (;).
         const ssh = spawn('ssh', [
             config.server,
             '--',
-            'tarball=$(mktemp /tmp/frak-diff-tarball.XXXXXX);',
+            // Save the incoming tarball to /tmp
+            'export tarball=$(mktemp /tmp/frak-diff-tarball.XXXXXX);',
             'cat > $tarball;',
-            `cd ${config.root};`,
-            diffs.join('; '),
-            ';',
-            'rm $tarball',
+            // Save the diffs script to the /tmp folder
+            `tar xzOf $tarball "tmp/${diffsScriptFilename}" > /tmp/${diffsScriptFilename};`,
+            process.env.DEBUG ? 'tar tf $tarball;' : '',
+            // Fixes missing root directory by jumping to an empty /tmp folder
+            `if [ -d "${config.root}" ] ; then cd "${config.root}"; else fakeroot=$(mktemp -d /tmp/frak-fake-root.XXXXXX); cd $fakeroot; fi ;`,
+            // Run the diffs script
+            `sh /tmp/${diffsScriptFilename};`,
+            // Clean up diffs script
+            `rm /tmp/${diffsScriptFilename};`,
+            // Clean up the tarball
+            'rm $tarball;',
+            // Clean up the fake root fix
+            'if [ -d "$fakeroot" ] ; then rmdir "$fakeroot" ; fi;',
         ]);
+
+        // Pipe the tar output to SSH
         tar.stdout.pipe(ssh.stdin);
 
         let less;
@@ -182,7 +214,7 @@ export default async function diff(dryRunOutput, options) {
             });
         } else {
             /* node:coverage disable */
-            return await new Promise((resolve) => {
+            return await new Promise((resolve, reject) => {
                 let diff = '';
 
                 ssh.stdout.on('data', (data) => (diff += data));
@@ -192,6 +224,10 @@ export default async function diff(dryRunOutput, options) {
                 ssh.on('exit', () => {
                     resolve(diff);
                 });
+
+                ssh.on('error', (error) => {
+                    reject(error);
+                });
             });
             /* node:coverage enable */
         }

package/src/humanize.js

@@ -2,6 +2,8 @@ import * as ansi from './ansi.js';
 
 export default function humanize(changes) {
     return changes
+        .replace(/(^|\n)created directory .*\n/g, '$1')
+        .replace(/(^|\n)cannot delete non-empty directory: .*\n/g, '$1')
         .replace(/cL\+\+\+\+\+\+\+\+\+/g,   ansi.blue('New Link   '))
         .replace(/<f\+\+\+\+\+\+\+\+\+/g,  ansi.green('New File   '))
         .replace(/>f\+\+\+\+\+\+\+\+\+/g,  ansi.green('New File   '))

package/src/rsync.js

@@ -14,16 +14,7 @@ export function filters() {
     const { options } = parse(process.argv.slice(2));
     const filters = [];
     const includes = [];
-    const excludes = [
-        '.frak*',
-        '.git*',
-        '.svn*',
-        '.tags*',
-        'frak.config.js',
-        'Capfile',
-        'Gemfile*',
-        'Vagrantfile*',
-    ];
+    const excludes = ['/.frak', '/.frakignore', '/.git/', '/.svn/', '/frak.config.js'];
 
     // merge excludes via commandline
     if (options.ignore) {