cutline 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Zurab Mujirishvili
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/dist/cli.js CHANGED
@@ -4,6 +4,7 @@
4
4
  * public surface and writes the Markdown snippets, with every setting overridable:
5
5
  * tsx src/cli.ts --entry src/public.ts --out docs/api --fence typescript --no-bare
6
6
  */
7
+ import { realpathSync } from "node:fs";
7
8
  import { fileURLToPath } from "node:url";
8
9
  import { ApiDocGenerator, DEFAULT_CONFIG } from "./index.js";
9
10
  export function parseCliConfig(argv = process.argv.slice(2)) {
@@ -76,8 +77,27 @@ function main() {
76
77
  const names = new ApiDocGenerator(parseCliConfig()).run();
77
78
  console.log(`Generated ${names.length} API snippets: ${names.sort().join(", ")}`);
78
79
  }
80
+ /**
81
+ * True when this module is the process entry point. The argv path is resolved
82
+ * through {@link realpathSync} so the check still holds when cutline is launched
83
+ * via a package-manager bin shim, where `process.argv[1]` is a symlink (pnpm)
84
+ * or junction (npm/Windows) pointing at the real `dist/cli.js`. The earlier
85
+ * raw `=== process.argv[1]` comparison failed for shimmed invocations, so
86
+ * `main()` silently never ran.
87
+ */
88
+ function isProcessEntry() {
89
+ const entry = process.argv[1];
90
+ if (!entry)
91
+ return false;
92
+ try {
93
+ return realpathSync(entry) === fileURLToPath(import.meta.url);
94
+ }
95
+ catch {
96
+ return false;
97
+ }
98
+ }
79
99
  // Run only when executed directly, not when imported (e.g. by tests).
80
- if (process.argv[1] && fileURLToPath(import.meta.url) === process.argv[1]) {
100
+ if (isProcessEntry()) {
81
101
  main();
82
102
  }
83
103
  //# sourceMappingURL=cli.js.map
package/dist/cli.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;GAIG;AACH,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,eAAe,EAAsB,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjF,MAAM,UAAU,cAAc,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACnE,MAAM,SAAS,GAA2B,EAAE,CAAC;IAE7C,MAAM,KAAK,GAAG,CAAC,CAAS,EAAU,EAAE;QAClC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAChB,KAAK,YAAY;gBACf,SAAS,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,SAAS;gBACZ,SAAS,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,OAAO;gBACV,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC9B,MAAM;YACR,KAAK,SAAS;gBACZ,SAAS,CAAC,aAAa,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,QAAQ;gBACX,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC1B,MAAM;YACR,KAAK,WAAW;gBACd,SAAS,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAC3B,MAAM;YACR,KAAK,gBAAgB;gBACnB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC7B,MAAM;YACR,KAAK,mBAAmB;gBACtB,SAAS,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC9B,MAAM;YACR,KAAK,SAAS;gBACZ,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC7B,MAAM;YACR,KAAK,YAAY;gBACf,SAAS,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC9B,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACX,SAAS,EAAE,CAAC;gBACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAChB,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC;;;;;0EAK4D,cAAc,CAAC,gBAAgB;0EAC/B,cAAc,CAAC,SAAS;0EACxB,cAAc,CAAC,MAAM;0EACrB,cAAc,CAAC,aAAa;2EAC3B,cAAc,CAAC,QAAQ;0EACxB,cAAc,CAAC,WAAW;0EAC1B,cAAc,CAAC,WAAW;mDACjD,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,IAAI;IACX,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;IAC1D,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,CAAC,MAAM,kBAAkB,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACpF,CAAC;AAED,sEAAsE;AACtE,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,IAAI,EAAE,CAAC;AACT,CAAC"}
1
+ {"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AACA;;;;GAIG;AACH,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,eAAe,EAAsB,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjF,MAAM,UAAU,cAAc,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACnE,MAAM,SAAS,GAA2B,EAAE,CAAC;IAE7C,MAAM,KAAK,GAAG,CAAC,CAAS,EAAU,EAAE;QAClC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtB,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QAC3F,OAAO,CAAC,CAAC;IACX,CAAC,CAAC;IAEF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,QAAQ,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;YAChB,KAAK,YAAY;gBACf,SAAS,CAAC,gBAAgB,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,SAAS;gBACZ,SAAS,CAAC,SAAS,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBACjC,MAAM;YACR,KAAK,OAAO;gBACV,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBAC9B,MAAM;YACR,KAAK,SAAS;gBACZ,SAAS,CAAC,aAAa,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;gBACrC,MAAM;YACR,KAAK,QAAQ;gBACX,SAAS,CAAC,QAAQ,GAAG,IAAI,CAAC;gBAC1B,MAAM;YACR,KAAK,WAAW;gBACd,SAAS,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAC3B,MAAM;YACR,KAAK,gBAAgB;gBACnB,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC7B,MAAM;YACR,KAAK,mBAAmB;gBACtB,SAAS,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC9B,MAAM;YACR,KAAK,SAAS;gBACZ,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;gBAC7B,MAAM;YACR,KAAK,YAAY;gBACf,SAAS,CAAC,WAAW,GAAG,KAAK,CAAC;gBAC9B,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACX,SAAS,EAAE,CAAC;gBACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;gBAChB,MAAM;YACR;gBACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC;;;;;0EAK4D,cAAc,CAAC,gBAAgB;0EAC/B,cAAc,CAAC,SAAS;0EACxB,cAAc,CAAC,MAAM;0EACrB,cAAc,CAAC,aAAa;2EAC3B,cAAc,CAAC,QAAQ;0EACxB,cAAc,CAAC,WAAW;0EAC1B,cAAc,CAAC,WAAW;mDACjD,CAAC,CAAC;AACrD,CAAC;AAED,SAAS,IAAI;IACX,MAAM,KAAK,GAAG,IAAI,eAAe,CAAC,cAAc,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;IAC1D,OAAO,CAAC,GAAG,CAAC,aAAa,KAAK,CAAC,MAAM,kBAAkB,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACpF,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,cAAc;IACrB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,CAAC,KAAK;QAAE,OAAO,KAAK,CAAC;IACzB,IAAI,CAAC;QACH,OAAO,YAAY,CAAC,KAAK,CAAC,KAAK,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAChE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,sEAAsE;AACtE,IAAI,cAAc,EAAE,EAAE,CAAC;IACrB,IAAI,EAAE,CAAC;AACT,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cutline",
3
- "version": "0.0.1",
3
+ "version": "0.0.2",
4
4
  "type": "module",
5
5
  "description": "Generate Markdown API reference snippets from a TypeScript entry module.",
6
6
  "main": "dist/index.js",