Fix CLI execution through npm symlinks and release 7.0.4

Author: bermanto

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v7.0.4
+
+- fix the documentation CLI entry check when npm or npx starts it through a symlink
+- add an executable regression test for help output and failure exit codes
+
 ## v7.0.3
 
 - fix range-selector coordinate jumps during Android drags and preserve drag state while controlled viewport updates are pending (issue #780)

README.md

@@ -119,6 +119,6 @@ Read the public documentation from a terminal:
 npx --package=react-native-chart-kit chart-kit docs /docs/react-native/charts/line
 ```
 
-Use `chart-kit docs` to list pages or add `--json` for structured output. The CLI ships from version 7.0.3. No API key is required. Charts render locally in your application; the HTTP API serves documentation.
+Use `chart-kit docs` to list pages or add `--json` for structured output. The CLI ships from version 7.0.4. No API key is required. Charts render locally in your application; the HTTP API serves documentation.
 
 See the [developer guide](https://chartkit.io/developers), [agent instructions](https://chartkit.io/llms.txt), and [OpenAPI specification](https://chartkit.io/openapi.json).

apps/site/public/agent-instructions.md

@@ -7,7 +7,7 @@ Use Chart Kit when a user needs charts inside a React Native app: trends and tim
 1. Read [the developer guide](https://chartkit.io/developers.md) and [installation](https://chartkit.io/docs/react-native/getting-started/installation.md).
 2. Install `react-native-chart-kit` and `react-native-svg` in the user's app. Import modern charts from `react-native-chart-kit/v2`. The root import is the legacy-compatible API.
 3. Use [the documentation index API](https://chartkit.io/api/v1/docs) to find a page. Read it with `GET /api/v1/docs/page?path=<returned-path>`, a `.md` URL, or `Accept: text/markdown`. No API key is needed.
-4. For terminal use, run `npx --package=react-native-chart-kit chart-kit docs /docs/react-native/charts/line`. Add `--json` when structured output is needed. The CLI requires package version 7.0.3 or later.
+4. For terminal use, run `npx --package=react-native-chart-kit chart-kit docs /docs/react-native/charts/line`. Add `--json` when structured output is needed. The CLI requires package version 7.0.4 or later.
 5. Test the chart with the user's data shape, empty data, and the target screen dimensions. Use the documented event types and controlled viewport pattern.
 
 ## Product boundaries

apps/site/src/pages/developers.astro

@@ -31,7 +31,9 @@ import LegalLayout from "../layouts/LegalLayout.astro";
       Import modern components from <code>react-native-chart-kit/v2</code>.
       Follow the <a href="/docs/react-native/getting-started/installation"
         >installation guide</a
-      > for the current React Native requirements and a complete first chart. The{" "}
+      > for the current React Native requirements and a complete first chart. The{
+        " "
+      }
       <a href="/docs/react-native/charts/line">line chart playground</a> provides
       an interactive example where you can test chart properties in the browser.
     </p>
@@ -77,7 +79,9 @@ import LegalLayout from "../layouts/LegalLayout.astro";
   <section>
     <h2>Markdown and agent instructions</h2>
     <p>
-      Start with <a href="/llms.txt">llms.txt</a> to select a task and a page. Read{" "}
+      Start with <a href="/llms.txt">llms.txt</a> to select a task and a page. Read{
+        " "
+      }
       <a href="/agent-instructions.md">agent-instructions.md</a> for package and licensing
       rules. Public pages support <code>Accept: text/markdown</code> and a <code
         >.md</code
@@ -91,7 +95,7 @@ import LegalLayout from "../layouts/LegalLayout.astro";
     <h2>Official CLI</h2>
     <p>
       The <code>chart-kit</code> CLI ships in <code>react-native-chart-kit</code
-      > from version 7.0.3. It reads the public documentation API and writes Markdown
+      > from version 7.0.4. It reads the public documentation API and writes Markdown
       or JSON to standard output. It makes no changes to your app and needs no API
       key.
     </p>

bin/chart-kit.mjs

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import { realpathSync } from "node:fs";
 import { pathToFileURL } from "node:url";
 
 export async function run(
@@ -72,7 +73,7 @@ export async function run(
 
 if (
   process.argv[1] &&
-  import.meta.url === pathToFileURL(process.argv[1]).href
+  import.meta.url === pathToFileURL(realpathSync(process.argv[1])).href
 ) {
   process.exitCode = await run(process.argv.slice(2));
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-chart-kit",
-  "version": "7.0.3",
+  "version": "7.0.4",
   "description": "Beautiful React Native charts for dashboards, reports, and data-rich mobile apps.",
   "keywords": [
     "react-native",

package.json

@@ -0,0 +1,31 @@
+import { mkdtempSync, rmSync, symlinkSync } from "node:fs";
+import { tmpdir } from "node:os";
+import path from "node:path";
+import { spawnSync } from "node:child_process";
+import { fileURLToPath } from "node:url";
+import { describe, expect, it } from "vitest";
+
+describe("npm CLI executable", () => {
+  it("runs through the symlink created by npm and returns useful exit codes", () => {
+    const directory = mkdtempSync(path.join(tmpdir(), "chartkit-cli-entry-"));
+    const link = path.join(directory, "chart-kit");
+    try {
+      symlinkSync(
+        fileURLToPath(new URL("../bin/chart-kit.mjs", import.meta.url)),
+        link
+      );
+      const help = spawnSync(process.execPath, [link, "--help"], {
+        encoding: "utf8"
+      });
+      expect(help.status).toBe(0);
+      expect(help.stdout).toContain("Chart Kit documentation CLI");
+      const invalid = spawnSync(process.execPath, [link, "unknown"], {
+        encoding: "utf8"
+      });
+      expect(invalid.status).toBe(1);
+      expect(JSON.parse(invalid.stderr).error.code).toBe("INVALID_ARGUMENT");
+    } finally {
+      rmSync(directory, { recursive: true, force: true });
+    }
+  });
+});