myphp-cli 1.28.0 → 1.30.0

package/README.md

@@ -0,0 +1,40 @@
+# myphp-cli
+
+The `myphp` command of [MyPHP](https://github.com/owner888/myphp) for the
+scripts of a project's package.json, and the types of `myphp.config.ts`.
+
+MyPHP's command line tool is PHP, part of the framework, which the project
+installs with Composer:
+
+```sh
+composer require owner888/myphp
+npm install -D myphp-cli
+```
+
+```json
+{
+  "scripts": {
+    "dev": "myphp dev",
+    "build": "myphp build"
+  }
+}
+```
+
+`myphp` runs, in this order, `$MYPHP_CLI_BINARY` when it is set; bin/myphp
+of the MyPHP checkout the package is part of (a `file:` dependency, as
+`myphp init -template web` writes it); else
+`vendor/owner888/myphp/bin/myphp` in the current directory or the nearest
+directory above it that has one. It needs PHP 8.3 or later with FFI.
+
+`defineConfig` types the configuration of `myphp.config.ts`, which takes
+the place of myphp.json:
+
+```ts
+import { defineConfig } from "myphp-cli";
+
+export default defineConfig({
+  name: "My App",
+  identifier: "com.example.myapp",
+  devUrl: "http://localhost:5173",
+});
+```

package/bin/myphp.js

@@ -3,7 +3,13 @@
 import { spawn } from "node:child_process";
 import { binaryPath } from "../index.js";
 
-const bin = binaryPath();
+let bin;
+try {
+  bin = binaryPath();
+} catch (err) {
+  console.error(err.message);
+  process.exit(1);
+}
 const args = process.argv.slice(2);
 
 if (typeof process.execve === "function") {

package/index.d.ts

@@ -1,8 +1,11 @@
 /**
  * Returns the path of the myphp command to run: $MYPHP_CLI_BINARY when
- * set, else bin/myphp of the MyPHP checkout this package is in.
+ * set; bin/myphp of the MyPHP checkout this package is part of; else
+ * vendor/owner888/myphp/bin/myphp, which Composer installs, in `cwd` (by
+ * default the current directory) or the nearest directory above it that
+ * has one. Throws when there is none.
  */
-export declare function binaryPath(): string;
+export declare function binaryPath(cwd?: string): string;
 
 /**
  * Types the configuration of myphp.config.ts, which takes the place of

package/index.js

@@ -1,17 +1,39 @@
-// myphp-cli runs the myphp command line tool, bin/myphp of the MyPHP
-// checkout it is part of, from the scripts of a project's package.json,
-// and types myphp.config.ts (mygo-cli's index.js, whose binaries are Go's).
+// myphp-cli runs the myphp command line tool, bin/myphp of MyPHP, from the
+// scripts of a project's package.json, and types myphp.config.ts
+// (mygo-cli's index.js, whose binaries are Go's). MyPHP's CLI is PHP, part
+// of the framework: the project's Composer installs it, as
+// vendor/owner888/myphp, or the package is part of a MyPHP checkout
+// (a file: dependency, as `myphp init -template web` writes it).
+import { existsSync } from "node:fs";
 import { dirname, join } from "node:path";
 import { fileURLToPath } from "node:url";
 
 const here = dirname(fileURLToPath(import.meta.url));
 
+/** Whether $dir is a MyPHP checkout: its CLI and its sources. */
+function isCheckout(dir) {
+  return existsSync(join(dir, "bin", "myphp")) && existsSync(join(dir, "src", "App.php"));
+}
+
 /**
  * Returns the path of the myphp command to run: $MYPHP_CLI_BINARY when
- * set, else bin/myphp of the checkout this package is in.
+ * set; bin/myphp of the MyPHP checkout this package is part of; else
+ * vendor/owner888/myphp/bin/myphp, which Composer installs, in $cwd or the
+ * nearest directory above it that has one.
  */
-export function binaryPath() {
-  return process.env.MYPHP_CLI_BINARY || join(here, "..", "..", "bin", "myphp");
+export function binaryPath(cwd = process.cwd()) {
+  if (process.env.MYPHP_CLI_BINARY) return process.env.MYPHP_CLI_BINARY;
+  const checkout = join(here, "..", "..");
+  if (isCheckout(checkout)) return join(checkout, "bin", "myphp");
+  for (let dir = cwd; ; dir = dirname(dir)) {
+    const bin = join(dir, "vendor", "owner888", "myphp", "bin", "myphp");
+    if (existsSync(bin)) return bin;
+    if (dirname(dir) === dir) break;
+  }
+  throw new Error(
+    `myphp-cli: MyPHP is not installed in ${cwd} or above it: install it with Composer, ` +
+      "composer require owner888/myphp, or set MYPHP_CLI_BINARY to its bin/myphp",
+  );
 }
 
 /**

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "myphp-cli",
-  "version": "1.28.0",
+  "version": "1.30.0",
   "description": "The myphp command line tool: create, develop and package MyPHP desktop apps",
   "keywords": ["myphp", "desktop", "webview", "php", "cli"],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/owner888/myphp.git",
+    "directory": "packages/cli"
+  },
   "license": "MIT",
   "type": "module",
   "bin": {