@songmu/mdhq 0.0.5 → 0.0.6

package/README.md

@@ -30,8 +30,8 @@ mdhq root
 ```
 
 `mdhq get` accepts multiple URLs as arguments or one URL per line on standard
-input; both sources are merged. It prints one absolute Markdown path per URL
-to stdout by default. Warnings are written to stderr. `--json` writes one
+input; both sources are merged. It prints one root-relative Markdown path per
+URL to stdout by default. Warnings are written to stderr. `--json` writes one
 compact JSON result object per URL as JSON Lines. Results are written as soon
 as each URL finishes, so parallel requests can produce output in completion
 order rather than input order. If a later request fails, results already

package/dist/cli.js

@@ -26,6 +26,13 @@ function parseHeaders(values) {
         };
     });
 }
+function toRootRelative(root, target) {
+    const relative = path.relative(root, target);
+    if (!relative || relative.startsWith("..") || path.isAbsolute(relative)) {
+        return target;
+    }
+    return relative;
+}
 async function readStdinUrls(stdin) {
     if (!stdin || stdin.isTTY) {
         return [];
@@ -79,6 +86,8 @@ export function createProgram(io = process) {
         if (requestedUrls.length === 0) {
             throw new MdhqError("INVALID_URL", "At least one URL is required");
         }
+        const loaded = await loadConfig();
+        const root = resolveRoot(options.root, loaded.config);
         const scheduler = new RequestScheduler();
         let nextIndex = 0;
         const worker = async () => {
@@ -91,7 +100,7 @@ export function createProgram(io = process) {
                 }
                 const result = await getPage({
                     url,
-                    ...(options.root ? { root: options.root } : {}),
+                    root,
                     ...(options.assets !== undefined ? { assets: options.assets } : {}),
                     update: options.update ?? false,
                     ...(options.userAgent ? { userAgent: options.userAgent } : {}),
@@ -99,7 +108,14 @@ export function createProgram(io = process) {
                     scheduler,
                     onWarning: (warning) => io.stderr.write(`warning: ${warning.message}\n`)
                 });
-                io.stdout.write(`${options.json ? JSON.stringify(result) : result.path}\n`);
+                const relativeResult = {
+                    ...result,
+                    path: toRootRelative(root, result.path),
+                    assets: result.assets.map((asset) => asset.path === undefined
+                        ? asset
+                        : { ...asset, path: toRootRelative(root, asset.path) })
+                };
+                io.stdout.write(`${options.json ? JSON.stringify(relativeResult) : relativeResult.path}\n`);
             }
         };
         const failures = [];

package/docs/specification.md

@@ -39,17 +39,18 @@ input. Both sources are merged, and up to eight URLs are processed in parallel.
 | `--header <header>` | Add an HTTP header. The option is repeatable and uses `Name: value` syntax. |
 | `--json` | Write one result per line as JSON Lines instead of only the Markdown path. |
 
-Without `--json`, stdout receives one absolute Markdown path per requested URL,
-with each path followed by a newline. Each result is written as soon as that
-URL finishes, so parallel requests can produce output in completion order
-rather than input order.
+Without `--json`, stdout receives one Markdown path per requested URL, relative
+to the effective storage root, with each path followed by a newline. Each
+result is written as soon as that URL finishes, so parallel requests can
+produce output in completion order rather than input order.
 Warnings are written to stderr.
 
 With `--json`, stdout contains one compact JSON object per requested URL,
-also written as soon as the URL finishes. Each line has this shape:
+also written as soon as the URL finishes. Markdown and asset paths are relative
+to the effective storage root. Each line has this shape:
 
 ```jsonl
-{"requestedUrl":"https://example.com/start","sourceUrl":"https://example.com/article","path":"/data/mdhq/example.com/article.md","status":"saved","assets":[],"warnings":[]}
+{"requestedUrl":"https://example.com/start","sourceUrl":"https://example.com/article","path":"example.com/article.md","status":"saved","assets":[],"warnings":[]}
 ```
 
 `status` is one of:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@songmu/mdhq",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Save web pages as Markdown in a ghq-inspired filesystem layout.",
   "type": "module",
   "bin": {