syncodemayo 1.0.8 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,81 @@
+# Changelog
+
+## 2.0.0
+
+A modernized SyncoDeMayo: ESM, Node.js built-ins in place of most dependencies, FTPS support,
+and fixes for v1 bugs. Some behavior changes; read the migration notes below before upgrading.
+
+### Migration from 1.x
+
+**Before your first 2.0 sync, run `syncodemayo diff [target]`** and read the list of changes.
+2.0 now syncs dotfiles and builds remote paths differently (see below), so the first sync may
+upload files v1 never did. This matters most with `deleteRemoteFiles: true`: check that nothing
+you want kept on the server is listed for deletion, and that nothing private (such as `.env`) is
+listed for upload.
+
+#### Requirements and packaging
+
+- Node.js 22.17 or later is required (`engines.node` is `>=22.17`).
+- The package is ESM. The CLI is `dist/cli.js`; the library entry is `dist/index.js`, with
+  types in `dist/index.d.ts`. CommonJS callers can still `require()` the library on Node.js
+  22.12 and later.
+- Runtime dependencies drop from ten to one (`basic-ftp`).
+- The library no longer exports the joi schemas `localSchema`, `targetSchema`, and
+  `configSchema`.
+
+#### CLI
+
+- An unknown command, extra positional arguments, and `-f` on any command other than `sync`
+  now exit 1 with an error. v1 printed the help or ignored them.
+- `-c` now requires a value (`-c <file>`).
+- The help text is reworded but lists the same commands and options.
+- `--version` / `-V` prints the real package version.
+
+#### Config
+
+- Config validation errors keep the `Config Schema Error:` prefix, but the detail after it is
+  new.
+- `local`, `targets`, or `exclude` given as a JSON *string* is now rejected.
+- `.syncodemayo.json` and `sync-config.json` are now found when `syncodemayo.json` is absent.
+- With no config, `init` creates `syncodemayo.json`, and `verify` / `ls` report that the folder
+  is not configured instead of throwing "Local config not found."
+- Configs created by `init` exclude `**/.env*` by default. Existing configs are not changed:
+  if you have a `.env` under `local.path`, add `"**/.env*"` to your `exclude` list yourself.
+
+#### File list
+
+- Dotfiles and files inside dot-directories (such as `.htaccess` or `.well-known/`) are now
+  synced. v1 skipped them.
+- `**/.git*` excludes `.gitignore` but not the files inside a `.git/` directory. Add
+  `**/.git/**` to keep one off the server.
+- On macOS and Windows, `files` and `exclude` patterns match case-insensitively.
+- Exclude patterns that start with `!` are matched literally, not as negations.
+- `*.md` and `**/*.md` no longer match a file named exactly `.md`.
+- Symlinked directories are walked for every `files` pattern, the way v1's default `**/**`
+  walked them: in full, without entering a symlinked directory inside one. Dangling symlinks
+  and symlink loops are skipped.
+
+#### Remote and sync
+
+- `init` no longer creates a missing remote `path`. It fails and tells you to create the
+  folder. `sync` still creates subfolders under the target path.
+- A missing or unreadable remote file list is now a normal error (still exit code 1) instead
+  of a `process.exit` from inside the library.
+- Remote paths are correct when `local.path` has a trailing or repeated slash, or
+  `target.path` has a trailing slash. v1 glued names together (`www` + `a.html` →
+  `wwwa.html`) or doubled slashes.
+
+### Added
+
+- FTPS support through two new target fields:
+  - `secure`: `false` (default, plain FTP), `true` (explicit FTPS, `AUTH TLS`), or
+    `"implicit"` (implicit FTPS, default port 990).
+  - `rejectUnauthorized`: `true` (default) requires a trusted server certificate; `false`
+    accepts a self-signed one and prints a warning naming the target on every connection.
+
+  See the FTPS section of the [README](README.md#ftps-ftp-over-tls).
+
+### Unchanged
+
+- A remote `.synco-filelist` written by v1 still diffs correctly: 2.0 uses the same keys and
+  CRCs, so upgrading does not re-upload everything.

package/README.md

@@ -7,6 +7,11 @@ It's pretty simple. SyncoDeMayo caches a list of known files, and their CRCs, on
 
 ---
 
+Requirements: Node.js 22.17 or later.
+
+Upgrading from 1.x? Version 2.0 changes some behavior. Read the migration notes in
+[CHANGELOG.md](CHANGELOG.md) before your first 2.0 sync.
+
 Install globally:
 ```
 $ npm install -g syncodemayo
@@ -21,7 +26,7 @@ Suggested usage as NPM script:
 ```js
 {
   // ... OTHER NPM FIELDS ...
-  "script": {
+  "scripts": {
     "sync": "syncodemayo sync staging",
     "sync:production": "syncodemayo sync production"
   }
@@ -31,38 +36,39 @@ Suggested usage as NPM script:
 ---
 
 ```
-$ syncodemayo
-
-  Usage: syncodemayo [options] [command]
-
-
-  Options:
-
-    -V, --version        output the version number
-    -c, --config [file]  Specify local config [file]
-    -h, --help           output usage information
-
-
-  Commands:
-
-    init [target]            Configure local folder and/or server to sync
-    changes|diff [target]    Perform sync dry run and display the changes
-    verify [target]          Verify server is configured
-    sync [options] [target]  Perform sync to server
-    ls                       List defined targets in config
+$ syncodemayo --help
+Usage: syncodemayo [options] [command]
+
+Options:
+  -c, --config <file>  Specify local config <file>
+  -v, --verbose        Verbose logging
+  -q, --quiet          Minimal logging
+  -V, --version        Output the version number
+  -h, --help           Output usage information
+
+Commands:
+  init [target]          Configure local folder and/or server to sync
+  changes|diff [target]  Perform sync dry run and display the changes
+  verify [target]        Verify server is configured
+  sync [options] [target]
+                         Perform sync to server
+    -f, --force          Don't prompt before uploading.
+  ls                     List defined targets in config
+
+With no command, shows this help.
 ```
 
 
 Example `syncodemayo.json` config:
 
-```json
+```js
 {
   "local": {
-    "path": "public",
-    "files": "**/**",
-    "exclude": ["**/*.map", "**/.DS_Store", "**/.git*"],
-    "defaultTarget": "staging",
-    "deleteRemoteFiles": true // Defaults to false
+    "path": "public", // Required, local path to sync
+    "files": "**/**", // Optional, default='**/**', file glob pattern
+    "exclude": ["**/*.map", "**/.DS_Store", "**/.git*", "**/.env*"], // Optional, default=[] (init writes this list), glob patterns to ignore
+    "defaultTarget": "staging", // Optional, default='staging', target to use if not specified on cmd line
+    "deleteRemoteFiles": true // Optional, default=false - for now...
   },
 
   "targets": {
@@ -71,9 +77,12 @@ Example `syncodemayo.json` config:
       "path": "MyApp/www/stage", // Required
       "user": "USERNAME", // Required
       "pass": "PASSWORD", // Optional, NOT RECOMMENDED! See note below for better way...
-      "port": 21, // Default
-      "cache": ".synco-filelist", // Default
-      "prompt": false // Default is true, false will upload w/o confirming
+      "port": 21, // Optional, default=21 (990 when secure is "implicit")
+      "secure": false, // Optional, default=false. FTPS: false, true (explicit) or "implicit". See below.
+      "rejectUnauthorized": true, // Optional, default=true. false accepts self-signed certificates. See below.
+      "cache": ".synco-filelist", // Optional, default='.synco-filelist'
+      "prompt": false, // Optional, default=true, false will upload w/o confirming
+      "enabled": false // Optional, default=true
     },
 
     "production": {
@@ -83,11 +92,32 @@ Example `syncodemayo.json` config:
       "prompt": "This is for PRODUCTION! Do you really mean it?"
     }
   }
+
+  /*
+    Note: Yes, comments are allowed in config files.
+    SyncoDeMayo will strip them before parsing the JSON.
+  */
 }
 ```
 
+### Dotfiles
+
+Dotfiles and dot-directories sync like any other file: `.htaccess`, for example, is uploaded.
+(1.x skipped them.) Exclude anything that must not reach the server, such as `**/.env*` for
+environment files and `**/.git/**` for a git directory. Note that `**/.git*` excludes
+`.gitignore` but not the files inside a `.git/` directory.
+
+On macOS and Windows, `files` and `exclude` patterns match case-insensitively.
+
+### Passwords and `.env`
+
 You can put the FTP password in the config, but if you're adding it to source control I wouldn't. Instead, add the password to an `.env` file that you set to ignored in your SCM.
 
+SyncoDeMayo reads `.env` from the current working directory (where you run `syncodemayo`).
+Variables already set in the environment win over the ones in `.env`. When a target has no
+`pass`, its password is looked up as `<TARGET NAME UPPERCASED>_PWD`: `STAGING_PWD` for the
+`staging` target.
+
 Example `.env` for above config:
 
 ```bash
@@ -95,4 +125,43 @@ STAGING_PWD=ftpPasswordHere
 PRODUCTION_PWD="Other password here"
 ```
 
-SyncoDeMayo will automatically look in your `.env` for passwords if they aren't in your config.
+**Warning:** a `.env` inside `local.path` is a dotfile like any other, so it would be uploaded
+unless excluded. Configs created by `init` exclude `**/.env*`; if your config predates 2.0, add
+`"**/.env*"` to its `exclude` list.
+
+### FTPS (FTP over TLS)
+
+If your host requires FTPS, set `secure` on the target:
+
+| `secure` | Connection | Default `port` |
+| --- | --- | --- |
+| `false` (default) | Plain FTP | 21 |
+| `true` | Explicit FTPS: connects in plain text, then upgrades with `AUTH TLS` | 21 |
+| `"implicit"` | Implicit FTPS: TLS from the start | 990 |
+
+An explicit `port` always wins over these defaults. `secure` takes exactly `true`, `false` or
+`"implicit"` (not the strings `"true"`/`"false"`).
+
+`rejectUnauthorized` (`true` or `false`, default `true`) controls whether the server's TLS
+certificate must be trusted. With the default, a self-signed, expired or mismatched certificate
+stops the command with an error that names the host. If you trust the server anyway, set
+`"rejectUnauthorized": false` on the target: the connection then accepts the certificate, and
+SyncoDeMayo prints a warning naming the target every time it makes such a connection (even
+with `-q`).
+
+```js
+"targets": {
+  "production": {
+    "host": "ftp.myapp.com",
+    "path": "MyApp/www",
+    "user": "USERNAME",
+    "secure": true,
+    "rejectUnauthorized": false // only for a server you trust with a self-signed certificate
+  }
+}
+```
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for what changed in each release, including the migration
+notes for upgrading from 1.x.

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './env.js';

package/dist/cli.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+// Must be the first import: loads .env before any other module reads process.env.
+import './env.js';
+import { readFileSync } from 'node:fs';
+import * as CLI from './lib/Cli.js';
+import * as Log from './lib/Log.js';
+import { CliArgsError, HELP, parseCliArgs } from './lib/Args.js';
+let args;
+try {
+    args = parseCliArgs(process.argv.slice(2));
+}
+catch (err) {
+    if (!(err instanceof CliArgsError))
+        throw err;
+    process.stderr.write(`error: ${err.message}\n\nRun 'syncodemayo --help' for usage.\n`);
+    process.exit(1);
+}
+CLI.setFlags({ logLevel: args.logLevel });
+const { config, target } = args;
+switch (args.command) {
+    case "changes":
+        Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}...\n`);
+        CLI.changes(config, target).then(showDone).catch(showError);
+        break;
+    case "check":
+        Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}...\n`);
+        CLI.check(config, target).then(showDone).catch(showError);
+        break;
+    case "init":
+        Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}...\n`);
+        CLI.init(config, target).then(showDone).catch(showError);
+        break;
+    case "ls":
+        Log.debug(`Performing '${args.command}'...\n`);
+        CLI.ls(config).then(showDone).catch(showError);
+        break;
+    case "sync":
+        if (args.force) {
+            Log.debug(`Performing (forced) 'sync' on target: ${target || '(default)'}\n...`);
+        }
+        else {
+            Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}\n...`);
+        }
+        CLI.sync(config, target, args.force).then(showDone).catch(showError);
+        break;
+    case "version":
+        process.stdout.write(readPackageVersion() + "\n");
+        break;
+    case "help":
+    default:
+        process.stdout.write(HELP);
+}
+// The version of this package, read from its package.json (one level above dist/).
+function readPackageVersion() {
+    const pkg = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'));
+    return String(pkg.version);
+}
+function showDone() {
+    Log.log("\nDone.");
+    process.exit(0);
+}
+function showError(err) {
+    console.error("\n(!)", err.message, "\n\n", err);
+    process.exit(1);
+}
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"./","sources":["cli.ts"],"names":[],"mappings":";AAEA,kFAAkF;AAClF,OAAO,UAAU,CAAA;AAEjB,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAA;AACnC,OAAO,KAAK,GAAG,MAAM,cAAc,CAAA;AACnC,OAAO,EAAW,YAAY,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEzE,IAAI,IAAa,CAAA;AACjB,IAAI,CAAC;IACH,IAAI,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;AAC5C,CAAC;AACD,OAAO,GAAG,EAAE,CAAC;IACX,IAAI,CAAC,CAAC,GAAG,YAAY,YAAY,CAAC;QAAE,MAAM,GAAG,CAAA;IAC7C,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,GAAG,CAAC,OAAO,2CAA2C,CAAC,CAAA;IACtF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC;AAED,GAAG,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAA;AAEzC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;AAE/B,QAAQ,IAAI,CAAC,OAAO,EAAE,CAAC;IAErB,KAAK,SAAS;QACZ,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,OAAO,gBAAgB,MAAM,IAAI,WAAW,OAAO,CAAC,CAAA;QAClF,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC3D,MAAK;IAEP,KAAK,OAAO;QACV,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,OAAO,gBAAgB,MAAM,IAAI,WAAW,OAAO,CAAC,CAAA;QAClF,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACzD,MAAK;IAEP,KAAK,MAAM;QACT,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,OAAO,gBAAgB,MAAM,IAAI,WAAW,OAAO,CAAC,CAAA;QAClF,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACxD,MAAK;IAEP,KAAK,IAAI;QACP,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,OAAO,QAAQ,CAAC,CAAA;QAC9C,GAAG,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QAC9C,MAAK;IAEP,KAAK,MAAM;QACT,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,KAAK,CAAC,yCAAyC,MAAM,IAAI,WAAW,OAAO,CAAC,CAAA;QAClF,CAAC;aACI,CAAC;YACJ,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,OAAO,gBAAgB,MAAM,IAAI,WAAW,OAAO,CAAC,CAAA;QACpF,CAAC;QACD,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAA;QACpE,MAAK;IAEP,KAAK,SAAS;QACZ,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,GAAG,IAAI,CAAC,CAAA;QACjD,MAAK;IAEP,KAAK,MAAM,CAAC;IACZ;QACE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;AAC9B,CAAC;AAED,mFAAmF;AACnF,SAAS,kBAAkB;IACzB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,CAAA;IACzF,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,QAAQ;IACf,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC;AAED,SAAS,SAAS,CAAC,GAAQ;IACzB,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,CAAC,CAAA;IAChD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AACjB,CAAC","sourcesContent":["#!/usr/bin/env node\n\n// Must be the first import: loads .env before any other module reads process.env.\nimport './env.js'\n\nimport { readFileSync } from 'node:fs'\nimport * as CLI from './lib/Cli.js'\nimport * as Log from './lib/Log.js'\nimport { CliArgs, CliArgsError, HELP, parseCliArgs } from './lib/Args.js'\n\nlet args: CliArgs\ntry {\n  args = parseCliArgs(process.argv.slice(2))\n}\ncatch (err) {\n  if (!(err instanceof CliArgsError)) throw err\n  process.stderr.write(`error: ${err.message}\\n\\nRun 'syncodemayo --help' for usage.\\n`)\n  process.exit(1)\n}\n\nCLI.setFlags({ logLevel: args.logLevel })\n\nconst { config, target } = args\n\nswitch (args.command) {\n\n  case \"changes\":\n    Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}...\\n`)\n    CLI.changes(config, target).then(showDone).catch(showError)\n    break\n\n  case \"check\":\n    Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}...\\n`)\n    CLI.check(config, target).then(showDone).catch(showError)\n    break\n\n  case \"init\":\n    Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}...\\n`)\n    CLI.init(config, target).then(showDone).catch(showError)\n    break\n\n  case \"ls\":\n    Log.debug(`Performing '${args.command}'...\\n`)\n    CLI.ls(config).then(showDone).catch(showError)\n    break\n\n  case \"sync\":\n    if (args.force) {\n      Log.debug(`Performing (forced) 'sync' on target: ${target || '(default)'}\\n...`)\n    }\n    else {\n      Log.debug(`Performing '${args.command}' on target: ${target || '(default)'}\\n...`)\n    }\n    CLI.sync(config, target, args.force).then(showDone).catch(showError)\n    break\n\n  case \"version\":\n    process.stdout.write(readPackageVersion() + \"\\n\")\n    break\n\n  case \"help\":\n  default:\n    process.stdout.write(HELP)\n}\n\n// The version of this package, read from its package.json (one level above dist/).\nfunction readPackageVersion(): string {\n  const pkg = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf8'))\n  return String(pkg.version)\n}\n\nfunction showDone() {\n  Log.log(\"\\nDone.\")\n  process.exit(0)\n}\n\nfunction showError(err: any) {\n  console.error(\"\\n(!)\", err.message, \"\\n\\n\", err)\n  process.exit(1)\n}\n"]}

package/dist/env.d.ts

@@ -0,0 +1 @@
+export declare function loadDotEnv(path?: string): boolean;

package/dist/env.js

@@ -0,0 +1,17 @@
+// Loads `.env` from the working directory into process.env, as v1 did with dotenv.
+// cli.ts imports this module first, so the variables are set before any other module
+// reads process.env. Variables already in the environment are not overridden.
+// Only a missing `.env` is ignored; any other read or parse error surfaces.
+export function loadDotEnv(path = '.env') {
+    try {
+        process.loadEnvFile(path);
+        return true;
+    }
+    catch (err) {
+        if (err?.code === 'ENOENT')
+            return false;
+        throw err;
+    }
+}
+loadDotEnv();
+//# sourceMappingURL=env.js.map

package/dist/env.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env.js","sourceRoot":"./","sources":["env.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,qFAAqF;AACrF,8EAA8E;AAC9E,4EAA4E;AAE5E,MAAM,UAAU,UAAU,CAAC,IAAI,GAAG,MAAM;IACtC,IAAI,CAAC;QACH,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAA;QACzB,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,IAAK,GAA6B,EAAE,IAAI,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAA;QACnE,MAAM,GAAG,CAAA;IACX,CAAC;AACH,CAAC;AAED,UAAU,EAAE,CAAA","sourcesContent":["// Loads `.env` from the working directory into process.env, as v1 did with dotenv.\n// cli.ts imports this module first, so the variables are set before any other module\n// reads process.env. Variables already in the environment are not overridden.\n// Only a missing `.env` is ignored; any other read or parse error surfaces.\n\nexport function loadDotEnv(path = '.env'): boolean {\n  try {\n    process.loadEnvFile(path)\n    return true\n  }\n  catch (err) {\n    if ((err as NodeJS.ErrnoException)?.code === 'ENOENT') return false\n    throw err\n  }\n}\n\nloadDotEnv()\n"]}

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './lib/index.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from './lib/index.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"./","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAA","sourcesContent":["export * from './lib/index.js'"]}

package/dist/lib/Args.d.ts

@@ -0,0 +1,21 @@
+import { LogLevel } from './Log.js';
+/** What the CLI was asked to do. `check` is the `verify` command, as in v1. */
+export type CliCommand = 'init' | 'changes' | 'check' | 'sync' | 'ls' | 'help' | 'version';
+export interface CliArgs {
+    command: CliCommand;
+    target?: string;
+    config?: string;
+    logLevel: LogLevel;
+    /** `sync -f/--force`: don't prompt before uploading. */
+    force: boolean;
+}
+/** Thrown for a command line the CLI can't run (unknown option or command, extra arguments). */
+export declare class CliArgsError extends Error {
+    constructor(message: string);
+}
+export declare const HELP = "Usage: syncodemayo [options] [command]\n\nOptions:\n  -c, --config <file>  Specify local config <file>\n  -v, --verbose        Verbose logging\n  -q, --quiet          Minimal logging\n  -V, --version        Output the version number\n  -h, --help           Output usage information\n\nCommands:\n  init [target]          Configure local folder and/or server to sync\n  changes|diff [target]  Perform sync dry run and display the changes\n  verify [target]        Verify server is configured\n  sync [options] [target]\n                         Perform sync to server\n    -f, --force          Don't prompt before uploading.\n  ls                     List defined targets in config\n\nWith no command, shows this help.\n";
+/**
+ * Parses the CLI arguments (without the node and script paths) into what to run.
+ * Pure: it reads nothing and prints nothing. Throws CliArgsError for a command line it can't run.
+ */
+export declare function parseCliArgs(argv: string[]): CliArgs;

package/dist/lib/Args.js

@@ -0,0 +1,99 @@
+import { parseArgs } from 'node:util';
+import { LogLevel } from './Log.js';
+/** Thrown for a command line the CLI can't run (unknown option or command, extra arguments). */
+export class CliArgsError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'CliArgsError';
+    }
+}
+// Command name (and alias) -> what it runs, and whether it takes a [target].
+const COMMANDS = {
+    init: { command: 'init', takesTarget: true },
+    changes: { command: 'changes', takesTarget: true },
+    diff: { command: 'changes', takesTarget: true },
+    verify: { command: 'check', takesTarget: true },
+    sync: { command: 'sync', takesTarget: true },
+    ls: { command: 'ls', takesTarget: false },
+};
+export const HELP = `Usage: syncodemayo [options] [command]
+
+Options:
+  -c, --config <file>  Specify local config <file>
+  -v, --verbose        Verbose logging
+  -q, --quiet          Minimal logging
+  -V, --version        Output the version number
+  -h, --help           Output usage information
+
+Commands:
+  init [target]          Configure local folder and/or server to sync
+  changes|diff [target]  Perform sync dry run and display the changes
+  verify [target]        Verify server is configured
+  sync [options] [target]
+                         Perform sync to server
+    -f, --force          Don't prompt before uploading.
+  ls                     List defined targets in config
+
+With no command, shows this help.
+`;
+/**
+ * Parses the CLI arguments (without the node and script paths) into what to run.
+ * Pure: it reads nothing and prints nothing. Throws CliArgsError for a command line it can't run.
+ */
+export function parseCliArgs(argv) {
+    let parsed;
+    try {
+        parsed = parseArgs({
+            args: argv,
+            allowPositionals: true,
+            strict: true,
+            options: {
+                config: { type: 'string', short: 'c' },
+                verbose: { type: 'boolean', short: 'v' },
+                quiet: { type: 'boolean', short: 'q' },
+                version: { type: 'boolean', short: 'V' },
+                help: { type: 'boolean', short: 'h' },
+                force: { type: 'boolean', short: 'f' },
+            },
+        });
+    }
+    catch (err) {
+        throw new CliArgsError(err.message);
+    }
+    const { values, positionals } = parsed;
+    const force = values.force === true;
+    const logLevel = values.verbose
+        ? LogLevel.Debug
+        : values.quiet
+            ? LogLevel.Info
+            : LogLevel.Default;
+    // Only the keys that are set, so a result compares equal to a plain literal.
+    const result = (command, target) => {
+        const args = { command, logLevel, force };
+        if (values.config !== undefined)
+            args.config = values.config;
+        if (target)
+            args.target = target;
+        return args;
+    };
+    if (values.help)
+        return result('help');
+    if (values.version)
+        return result('version');
+    if (positionals.length === 0) {
+        if (force)
+            throw new CliArgsError("Unknown option '-f, --force': it applies only to the sync command");
+        return result('help');
+    }
+    const [name, ...rest] = positionals;
+    const spec = Object.hasOwn(COMMANDS, name) ? COMMANDS[name] : undefined;
+    if (!spec)
+        throw new CliArgsError(`Unknown command '${name}'`);
+    if (force && spec.command !== 'sync')
+        throw new CliArgsError(`Unknown option '-f, --force' for the ${name} command: it applies only to sync`);
+    const maxArgs = spec.takesTarget ? 1 : 0;
+    if (rest.length > maxArgs)
+        throw new CliArgsError(`Too many arguments for the ${name} command: ${rest.join(' ')}`);
+    return result(spec.command, rest[0]);
+}
+//# sourceMappingURL=Args.js.map

package/dist/lib/Args.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Args.js","sourceRoot":"./","sources":["lib/Args.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AACrC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAcnC,gGAAgG;AAChG,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,cAAc,CAAA;IAC5B,CAAC;CACF;AAED,6EAA6E;AAC7E,MAAM,QAAQ,GAAsE;IAClF,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE;IAC5C,OAAO,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE;IAClD,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,IAAI,EAAE;IAC/C,MAAM,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE;IAC/C,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE;IAC5C,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE;CAC1C,CAAA;AAED,MAAM,CAAC,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;CAmBnB,CAAA;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAc;IACzC,IAAI,MAAM,CAAA;IACV,IAAI,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;YACjB,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,MAAM,EAAE,IAAI;YACZ,OAAO,EAAE;gBACP,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;gBACtC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;gBACxC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;gBACtC,OAAO,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;gBACxC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;gBACrC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE;aACvC;SACF,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,IAAI,YAAY,CAAE,GAAa,CAAC,OAAO,CAAC,CAAA;IAChD,CAAC;IAED,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAA;IACtC,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,KAAK,IAAI,CAAA;IACnC,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO;QAC7B,CAAC,CAAC,QAAQ,CAAC,KAAK;QAChB,CAAC,CAAC,MAAM,CAAC,KAAK;YACZ,CAAC,CAAC,QAAQ,CAAC,IAAI;YACf,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAA;IACtB,6EAA6E;IAC7E,MAAM,MAAM,GAAG,CAAC,OAAmB,EAAE,MAAe,EAAW,EAAE;QAC/D,MAAM,IAAI,GAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAA;QAClD,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5D,IAAI,MAAM;YAAE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAChC,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;IAED,IAAI,MAAM,CAAC,IAAI;QAAE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAA;IACtC,IAAI,MAAM,CAAC,OAAO;QAAE,OAAO,MAAM,CAAC,SAAS,CAAC,CAAA;IAC5C,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,IAAI,KAAK;YAAE,MAAM,IAAI,YAAY,CAAC,mEAAmE,CAAC,CAAA;QACtG,OAAO,MAAM,CAAC,MAAM,CAAC,CAAA;IACvB,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,WAAW,CAAA;IACnC,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IACvE,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,YAAY,CAAC,oBAAoB,IAAI,GAAG,CAAC,CAAA;IAE9D,IAAI,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,MAAM;QAClC,MAAM,IAAI,YAAY,CAAC,wCAAwC,IAAI,mCAAmC,CAAC,CAAA;IAEzG,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACxC,IAAI,IAAI,CAAC,MAAM,GAAG,OAAO;QACvB,MAAM,IAAI,YAAY,CAAC,8BAA8B,IAAI,aAAa,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;IAEzF,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;AACtC,CAAC","sourcesContent":["import { parseArgs } from 'node:util'\nimport { LogLevel } from './Log.js'\n\n/** What the CLI was asked to do. `check` is the `verify` command, as in v1. */\nexport type CliCommand = 'init' | 'changes' | 'check' | 'sync' | 'ls' | 'help' | 'version'\n\nexport interface CliArgs {\n  command: CliCommand\n  target?: string\n  config?: string\n  logLevel: LogLevel\n  /** `sync -f/--force`: don't prompt before uploading. */\n  force: boolean\n}\n\n/** Thrown for a command line the CLI can't run (unknown option or command, extra arguments). */\nexport class CliArgsError extends Error {\n  constructor(message: string) {\n    super(message)\n    this.name = 'CliArgsError'\n  }\n}\n\n// Command name (and alias) -> what it runs, and whether it takes a [target].\nconst COMMANDS: { [name: string]: { command: CliCommand, takesTarget: boolean } } = {\n  init: { command: 'init', takesTarget: true },\n  changes: { command: 'changes', takesTarget: true },\n  diff: { command: 'changes', takesTarget: true },\n  verify: { command: 'check', takesTarget: true },\n  sync: { command: 'sync', takesTarget: true },\n  ls: { command: 'ls', takesTarget: false },\n}\n\nexport const HELP = `Usage: syncodemayo [options] [command]\n\nOptions:\n  -c, --config <file>  Specify local config <file>\n  -v, --verbose        Verbose logging\n  -q, --quiet          Minimal logging\n  -V, --version        Output the version number\n  -h, --help           Output usage information\n\nCommands:\n  init [target]          Configure local folder and/or server to sync\n  changes|diff [target]  Perform sync dry run and display the changes\n  verify [target]        Verify server is configured\n  sync [options] [target]\n                         Perform sync to server\n    -f, --force          Don't prompt before uploading.\n  ls                     List defined targets in config\n\nWith no command, shows this help.\n`\n\n/**\n * Parses the CLI arguments (without the node and script paths) into what to run.\n * Pure: it reads nothing and prints nothing. Throws CliArgsError for a command line it can't run.\n */\nexport function parseCliArgs(argv: string[]): CliArgs {\n  let parsed\n  try {\n    parsed = parseArgs({\n      args: argv,\n      allowPositionals: true,\n      strict: true,\n      options: {\n        config: { type: 'string', short: 'c' },\n        verbose: { type: 'boolean', short: 'v' },\n        quiet: { type: 'boolean', short: 'q' },\n        version: { type: 'boolean', short: 'V' },\n        help: { type: 'boolean', short: 'h' },\n        force: { type: 'boolean', short: 'f' },\n      },\n    })\n  }\n  catch (err) {\n    throw new CliArgsError((err as Error).message)\n  }\n\n  const { values, positionals } = parsed\n  const force = values.force === true\n  const logLevel = values.verbose\n    ? LogLevel.Debug\n    : values.quiet\n      ? LogLevel.Info\n      : LogLevel.Default\n  // Only the keys that are set, so a result compares equal to a plain literal.\n  const result = (command: CliCommand, target?: string): CliArgs => {\n    const args: CliArgs = { command, logLevel, force }\n    if (values.config !== undefined) args.config = values.config\n    if (target) args.target = target\n    return args\n  }\n\n  if (values.help) return result('help')\n  if (values.version) return result('version')\n  if (positionals.length === 0) {\n    if (force) throw new CliArgsError(\"Unknown option '-f, --force': it applies only to the sync command\")\n    return result('help')\n  }\n\n  const [name, ...rest] = positionals\n  const spec = Object.hasOwn(COMMANDS, name) ? COMMANDS[name] : undefined\n  if (!spec) throw new CliArgsError(`Unknown command '${name}'`)\n\n  if (force && spec.command !== 'sync')\n    throw new CliArgsError(`Unknown option '-f, --force' for the ${name} command: it applies only to sync`)\n\n  const maxArgs = spec.takesTarget ? 1 : 0\n  if (rest.length > maxArgs)\n    throw new CliArgsError(`Too many arguments for the ${name} command: ${rest.join(' ')}`)\n\n  return result(spec.command, rest[0])\n}\n"]}

package/{lib → dist/lib}/Cli.d.ts

@@ -1,3 +1,8 @@
+import * as Log from './Log.js';
+export interface CLIFlags {
+    logLevel: Log.LogLevel;
+}
+export declare function setFlags(flags: CLIFlags): void;
 export declare function changes(configPath?: string, target?: string): Promise<boolean>;
 export declare function check(configPath?: string, target?: string): Promise<boolean>;
 export declare function init(configPath?: string, target?: string): Promise<boolean>;

package/dist/lib/Cli.js

@@ -0,0 +1,104 @@
+import * as Log from './Log.js';
+import { Client } from './Client.js';
+export function setFlags(flags) {
+    Log.setLogLevel(flags.logLevel);
+}
+export async function changes(configPath, target) {
+    const client = await Client.create(configPath);
+    const changeset = await client.getTargetServer(target).sync(true);
+    if (changeset == null)
+        throw new Error("Change detection failed.");
+    const added = changeset.added.length;
+    const changed = changeset.changed.length;
+    const removed = changeset.removed.length;
+    if (added + changed + removed === 0) {
+        Log.log("\nNo changes detected.");
+        return true;
+    }
+    if (added > 0) {
+        Log.info("\nNew Local Files: (%s)", added);
+        changeset.added.forEach(f => Log.log(" -", f));
+    }
+    if (changed > 0) {
+        Log.info("\nChanged Local Files: (%s)", changeset.changed.length);
+        changeset.changed.forEach(f => Log.log(" -", f));
+    }
+    if (removed > 0) {
+        Log.info(`\nRemoved Local Files${client.config.local.deleteRemoteFiles ? '' : ' (disabled)'}: (%s)`, changeset.removed.length);
+        changeset.removed.forEach(f => Log.log(" -", f));
+    }
+    return true;
+}
+export async function check(configPath, target) {
+    const client = await Client.create(configPath);
+    if (client.hasError) {
+        throw client.loadError || client.parseError;
+    }
+    if (!client.hasConfig && !client.hasError) {
+        Log.urgent("This directory isn't configured for SyncoDeMayo!");
+        return false;
+    }
+    const targetServer = client.getTargetServer(target);
+    const isServerConfigured = await targetServer.verify();
+    if (isServerConfigured) {
+        Log.info("Target", JSON.stringify(targetServer.name), "is ready for syncing.");
+    }
+    else {
+        Log.urgent("Target", JSON.stringify(targetServer.name), "isn't configured, run init.");
+        return false;
+    }
+    return true;
+}
+export async function init(configPath, target) {
+    const client = await Client.create(configPath);
+    if (!client.hasConfig && client.hasError) {
+        throw client.loadError || client.parseError;
+    }
+    if (!client.hasConfig) {
+        await client.createConfig(configPath);
+        Log.info("Created local config at", configPath);
+        return true;
+    }
+    const targetServer = client.getTargetServer(target);
+    const isServerConfigured = await targetServer.verify();
+    if (!isServerConfigured) {
+        await targetServer.prepare();
+        Log.info("Created", targetServer.config.cache, "on server target", targetServer.config._name);
+        return true;
+    }
+    Log.info("Everything seems to be configured correctly.");
+    return false;
+}
+export async function ls(configPath) {
+    const client = await Client.create(configPath);
+    const targets = await client.getTargetNames();
+    Log.urgent("Defined server targets:");
+    targets.forEach(name => {
+        const target = client.config.targets[name];
+        const bullet = client.config.local.defaultTarget === target._name
+            ? " *"
+            : " -";
+        Log.urgent(bullet, name, `\t(${target.user}@${target.host}:${target.path})`);
+    });
+    return true;
+}
+export async function sync(configPath, target, forceConfirmation = false) {
+    const client = await Client.create(configPath);
+    if (!client.hasConfig) {
+        if (client.hasError)
+            throw client.loadError || client.parseError;
+        else
+            throw new Error("This directory isn't configured for SyncoDeMayo!");
+    }
+    const changes = await client.getTargetServer(target).sync(false, forceConfirmation);
+    if (changes != null) {
+        Log.info("\nSummary:");
+        Log.info(" %s files uploaded.", changes.added.length + changes.changed.length);
+        changes.added.forEach(path => Log.log("  +", path));
+        changes.changed.forEach(path => Log.log("  -", path));
+        Log.info(` %s files removed. ${client.config.local.deleteRemoteFiles ? '' : '(disabled)'}`, changes.removed.length);
+        changes.removed.forEach(path => Log.log("  x", path));
+    }
+    return true;
+}
+//# sourceMappingURL=Cli.js.map