@andrestobelem/clone 0.1.0 → 0.1.1

package/README.md

@@ -2,6 +2,8 @@
 
 Run a local issue and project workspace without installing Python.
 
+Website: <https://clone-andrestobelem-prod.web.app>
+
 ```sh
 npx @andrestobelem/clone
 ```
@@ -12,10 +14,24 @@ Clone stores its database, attachments, snapshots, and backups in the operating
 
 ```sh
 npx @andrestobelem/clone start --port 5000
+npx @andrestobelem/clone --local
+npx @andrestobelem/clone --data-dir ./project-data
 npx @andrestobelem/clone teams list --json
 npx @andrestobelem/clone --help
 ```
 
 Use `--no-open` with `start` to keep the browser closed. Set `CLONE_DATA_DIR` to select another data directory.
 
+`--local` stores the workspace in `.clone/` in the current directory. Add `.clone/` to the repository's `.gitignore` unless you have a specific backup workflow. `--data-dir PATH` selects an explicit directory.
+
+## Data locations
+
+| System | Workspace data | Downloaded executable cache |
+| --- | --- | --- |
+| macOS | `~/Library/Application Support/Clone/` | `~/Library/Caches/Clone/` |
+| Linux | `$XDG_DATA_HOME/clone/` or `~/.local/share/clone/` | `$XDG_CACHE_HOME/clone/` or `~/.cache/clone/` |
+| Windows | `%APPDATA%\Clone\` | `%LOCALAPPDATA%\Clone\cache\` |
+
+The workspace data directory contains `workspace.sqlite3`, snapshots, attachments, and backups. Set `CLONE_CACHE_DIR` to select another executable cache.
+
 Clone supports macOS on ARM64 and x64, Linux on ARM64 and x64, and Windows on x64.

package/bin/clone.js

@@ -37,13 +37,39 @@ function cacheDirectory(platform = process.platform, environment = process.env)
   return path.join(environment.XDG_CACHE_HOME || path.join(os.homedir(), ".cache"), "clone");
 }
 
-function dataDirectory(platform = process.platform, environment = process.env) {
+function dataDirectory(platform = process.platform, environment = process.env, override = null) {
+  if (override) return path.resolve(override);
   if (environment.CLONE_DATA_DIR) return path.resolve(environment.CLONE_DATA_DIR);
   if (platform === "darwin") return path.join(os.homedir(), "Library", "Application Support", "Clone");
   if (platform === "win32") return path.join(environment.APPDATA || os.homedir(), "Clone");
   return path.join(environment.XDG_DATA_HOME || path.join(os.homedir(), ".local", "share"), "clone");
 }
 
+function parseLauncherArguments(arguments_, workingDirectory = process.cwd()) {
+  let storage = null;
+  const forwarded = [];
+  for (let index = 0; index < arguments_.length; index += 1) {
+    const value = arguments_[index];
+    if (value === "--local") {
+      if (storage) throw new Error("Use only one data directory option.");
+      storage = path.join(workingDirectory, ".clone");
+    } else if (value === "--data-dir") {
+      if (storage) throw new Error("Use only one data directory option.");
+      const directory = arguments_[++index];
+      if (!directory) throw new Error("--data-dir requires a path.");
+      storage = path.resolve(workingDirectory, directory);
+    } else if (value.startsWith("--data-dir=")) {
+      if (storage) throw new Error("Use only one data directory option.");
+      const directory = value.slice(11);
+      if (!directory) throw new Error("--data-dir requires a path.");
+      storage = path.resolve(workingDirectory, directory);
+    } else {
+      forwarded.push(value);
+    }
+  }
+  return { arguments: forwarded, storage };
+}
+
 async function download(url, destination) {
   const response = await fetch(url, { headers: { "user-agent": `clone/${packageMetadata.version}` } });
   if (!response.ok) throw new Error(`Download failed (${response.status}): ${url}`);
@@ -124,14 +150,14 @@ function initialize(binary, database, storage) {
   if (result.status !== 0) throw new Error(`Clone initialization failed with exit code ${result.status}.`);
 }
 
-async function start(binary, arguments_) {
+async function start(binary, arguments_, environment = process.env) {
   const options = parseStartArguments(arguments_);
-  const storage = dataDirectory();
+  const storage = dataDirectory(process.platform, environment);
   const database = path.join(storage, "workspace.sqlite3");
   initialize(binary, database, storage);
   const url = `http://127.0.0.1:${options.port}`;
   const child = spawn(binary, ["--db", database, "serve"], {
-    env: { ...process.env, CLONE_HOST: "127.0.0.1", PORT: options.port },
+    env: { ...environment, CLONE_HOST: "127.0.0.1", PORT: options.port },
     stdio: "inherit",
   });
   const errorState = { value: null };
@@ -150,34 +176,41 @@ async function start(binary, arguments_) {
   });
 }
 
-function help() {
+function help(storage = null) {
   console.log(`Clone ${packageMetadata.version}
 
 Usage:
-  clone [start] [--port PORT] [--no-open]
-  clone <CLI command> [options]
+  clone [--local | --data-dir PATH] [start] [--port PORT] [--no-open]
+  clone [--local | --data-dir PATH] <CLI command> [options]
 
 Examples:
   npx @andrestobelem/clone
+  npx @andrestobelem/clone --local
+  npx @andrestobelem/clone --data-dir ./project-data
   npx @andrestobelem/clone start --port 5000
   npx @andrestobelem/clone teams list --json
 
-Data: ${dataDirectory()}`);
+Data: ${dataDirectory(process.platform, process.env, storage)}`);
 }
 
 async function main(arguments_ = process.argv.slice(2)) {
+  const launcher = parseLauncherArguments(arguments_);
+  arguments_ = launcher.arguments;
   if (arguments_.includes("--version") || arguments_.includes("-V")) {
     console.log(packageMetadata.version);
     return 0;
   }
   if (arguments_.includes("--help") || arguments_.includes("-h")) {
-    help();
+    help(launcher.storage);
     return 0;
   }
   const binary = await binaryPath();
   const command = arguments_[0];
-  if (!command || command === "start") return start(binary, command ? arguments_.slice(1) : arguments_);
-  const storage = dataDirectory();
+  if (!command || command === "start") {
+    const environment = launcher.storage ? { ...process.env, CLONE_DATA_DIR: launcher.storage } : process.env;
+    return start(binary, command ? arguments_.slice(1) : arguments_, environment);
+  }
+  const storage = dataDirectory(process.platform, process.env, launcher.storage);
   const database = path.join(storage, "workspace.sqlite3");
   initialize(binary, database, storage);
   const result = spawnSync(binary, ["--db", database, ...arguments_], { stdio: "inherit" });
@@ -192,4 +225,4 @@ if (require.main === module) {
   });
 }
 
-module.exports = { cacheDirectory, dataDirectory, parseStartArguments, target };
+module.exports = { cacheDirectory, dataDirectory, parseLauncherArguments, parseStartArguments, target };

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@andrestobelem/clone",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Run the Clone issue and project workspace locally.",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/andrestobelem/clone.git"
   },
-  "homepage": "https://github.com/andrestobelem/clone#readme",
+  "homepage": "https://clone-andrestobelem-prod.web.app",
   "bugs": "https://github.com/andrestobelem/clone/issues",
   "type": "commonjs",
   "bin": {