@myooken/license-output 0.2.0 → 0.2.1

package/README.md

@@ -1,5 +1,11 @@
 # Third-Party License Output for node_modules
 
+[![npm version](https://img.shields.io/npm/v/@myooken/license-output.svg)](https://www.npmjs.com/package/@myooken/license-output)
+[![npm downloads](https://img.shields.io/npm/dm/@myooken/license-output.svg)](https://www.npmjs.com/package/@myooken/license-output)
+[![node](https://img.shields.io/node/v/@myooken/license-output.svg)](https://www.npmjs.com/package/@myooken/license-output)
+
+https://www.npmjs.com/package/@myooken/license-output
+
 ### What is this?
 
 A tool to scan `node_modules` and **output third-party licenses in Markdown**.  
@@ -8,7 +14,7 @@ It generates two files: `THIRD-PARTY-LICENSE.md` (main content) and `THIRD-PARTY
 ### Highlights
 
 - **ESM / Node.js 18+**, zero dependencies
-- **Outputs full license texts** from LICENSE/NOTICE/COPYING files
+- **Outputs full license texts** from LICENSE/NOTICE/THIRD-PARTY-NOTICES/COPYING files
 - **Review file** flags missing Source / license / license files
 - `--fail-on-missing` supports CI enforcement
 
@@ -44,7 +50,7 @@ third-party-license
 | `--license [file]`     | Write main file only; optional filename                                     | `THIRD-PARTY-LICENSE.md`        |
 | `--recreate`           | Regenerate files from current `node_modules` only (drops removed packages)  | `true` (default)                |
 | `--update`             | Merge with existing outputs, keep removed packages, and mark their presence | `false`                        |
-| `--fail-on-missing`    | Exit with code 1 if LICENSE/NOTICE/COPYING are missing                      | `false`                         |
+| `--fail-on-missing`    | Exit with code 1 if LICENSE/NOTICE/THIRD-PARTY-NOTICES/COPYING are missing  | `false`                         |
 | `-h`, `--help`         | Show help                                                                   | -                               |
 
 > If neither `--review` nor `--license` is specified, **both files are generated**.
@@ -98,7 +104,7 @@ Outputs are sorted by package key. Use `mode: "update"` to merge with existing f
 - **THIRD-PARTY-LICENSE.md**
   - List of packages
   - Source / License info
-  - Full LICENSE/NOTICE/COPYING texts
+  - Full LICENSE/NOTICE/THIRD-PARTY-NOTICES/COPYING texts
   - Usage line shows whether the package is present in the current `node_modules`
 - **THIRD-PARTY-LICENSE-REVIEW.md**
   - Review-oriented checklist
@@ -123,3 +129,4 @@ Outputs are sorted by package key. Use `mode: "update"` to merge with existing f
 - Exit code 1: missing license files when `--fail-on-missing` is set, or `node_modules` not found.
 - Throws an error if `node_modules` does not exist.
 - Missing `license` or `repository` fields are flagged in the review file.
+- Paths printed in outputs/logs are shown relative to the current working directory.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myooken/license-output",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Generate third-party-license markdown by scanning licenses in node_modules.",
   "license": "MIT",
   "type": "module",

package/src/cli.js

@@ -4,6 +4,7 @@ import fsp from "node:fs/promises";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { collectThirdPartyLicenses, DEFAULT_OPTIONS } from "./core.js";
+import { LICENSE_FILES_LABEL } from "./constants.js";
 
 // 引数パース: --review / --license は最後に指定されたものを優先し、直後の値があれば出力ファイル名として扱う
 function parseArgs(argv) {
@@ -107,12 +108,18 @@ export async function runCli(argv = process.argv.slice(2)) {
     await Promise.all(writeTasks);
 
     if (result.options.writeMain)
-      console.log(`Generated: ${result.options.outFile}`);
+      console.log(
+        `Generated: ${result.options.outFileDisplay ?? result.options.outFile}`
+      );
     if (result.options.writeReview)
-      console.log(`Review:    ${result.options.reviewFile}`);
+      console.log(
+        `Review:    ${
+          result.options.reviewFileDisplay ?? result.options.reviewFile
+        }`
+      );
     console.log(`Packages:  ${result.stats.packages}`);
     console.log(
-      `Missing LICENSE/NOTICE/COPYING: ${result.stats.missingFiles.length}`
+      `Missing ${LICENSE_FILES_LABEL}: ${result.stats.missingFiles.length}`
     );
 
     if (result.stats.missingFiles.length > 0 && result.options.failOnMissing) {

package/src/constants.js

@@ -9,4 +9,7 @@ export const DEFAULT_OPTIONS = {
 
 // ライセンスらしいファイル名を検出する正規表現
 export const LICENSE_LIKE_RE =
-  /^(LICEN[CS]E|COPYING|NOTICE)(\..*)?$|^(LICEN[CS]E|COPYING|NOTICE)-/i;
+  /^(LICEN[CS]E|COPYING|NOTICE|THIRD[-_. ]?PARTY[-_. ]?NOTICES?)(\..*)?$|^(LICEN[CS]E|COPYING|NOTICE|THIRD[-_. ]?PARTY[-_. ]?NOTICES?)-/i;
+
+export const LICENSE_FILES_LABEL =
+  "LICENSE/NOTICE/THIRD-PARTY-NOTICES/COPYING";

package/src/core.js

@@ -54,12 +54,22 @@ export async function collectThirdPartyLicenses(options = {}) {
 export { DEFAULT_OPTIONS } from "./constants.js";
 
 function normalizeOptions(options) {
+  const cwd = process.cwd();
+  const nodeModules = path.resolve(
+    options.nodeModules ?? DEFAULT_OPTIONS.nodeModules
+  );
+  const outFile = path.resolve(options.outFile ?? DEFAULT_OPTIONS.outFile);
+  const reviewFile = path.resolve(
+    options.reviewFile ?? DEFAULT_OPTIONS.reviewFile
+  );
+
   return {
-    nodeModules: path.resolve(
-      options.nodeModules ?? DEFAULT_OPTIONS.nodeModules
-    ),
-    outFile: path.resolve(options.outFile ?? DEFAULT_OPTIONS.outFile),
-    reviewFile: path.resolve(options.reviewFile ?? DEFAULT_OPTIONS.reviewFile),
+    nodeModules,
+    outFile,
+    reviewFile,
+    nodeModulesDisplay: makeDisplayPath(nodeModules, cwd),
+    outFileDisplay: makeDisplayPath(outFile, cwd),
+    reviewFileDisplay: makeDisplayPath(reviewFile, cwd),
     failOnMissing: Boolean(
       options.failOnMissing ?? DEFAULT_OPTIONS.failOnMissing
     ),
@@ -75,6 +85,11 @@ function normalizeMode(mode) {
   return m === "update" ? "update" : DEFAULT_OPTIONS.mode;
 }
 
+function makeDisplayPath(targetPath, cwd) {
+  const rel = path.relative(cwd, targetPath);
+  return rel || ".";
+}
+
 async function assertNodeModulesExists(dir) {
   const stat = await fsp.stat(dir).catch(() => null);
   if (!stat || !stat.isDirectory()) {

package/src/existing.js

@@ -1,5 +1,6 @@
 import fsp from "node:fs/promises";
 import { makeAnchorId, uniqSorted } from "./fs-utils.js";
+import { LICENSE_FILES_LABEL } from "./constants.js";
 
 export async function parseExistingMainFile(filePath) {
   const content = await readFileSafe(filePath);
@@ -82,7 +83,12 @@ function parseMainBlock(key, body) {
     ) {
       continue;
     }
-    if (val.startsWith("(no LICENSE/NOTICE/COPYING files)")) continue;
+    if (
+      val.startsWith("(no LICENSE/NOTICE/COPYING files)") ||
+      val.startsWith(`(no ${LICENSE_FILES_LABEL} files)`)
+    ) {
+      continue;
+    }
     fileNames.push(val);
   }
 

package/src/render.js

@@ -1,6 +1,7 @@
 import os from "node:os";
 import path from "node:path";
 import { mdSafeText, uniqSorted } from "./fs-utils.js";
+import { LICENSE_FILES_LABEL } from "./constants.js";
 
 // メインのTHIRD-PARTY-LICENSE.mdを描画する
 export function renderMain(packages, opts) {
@@ -9,7 +10,7 @@ export function renderMain(packages, opts) {
 
   push("# Third-Party Licenses");
   push("");
-  push(`Generated from: ${opts.nodeModules}`);
+  push(`Generated from: ${opts.nodeModulesDisplay ?? opts.nodeModules}`);
   push("");
 
   for (const pkg of packages) {
@@ -21,9 +22,9 @@ export function renderMain(packages, opts) {
 
     const fileNames = pkg.fileNames ?? [];
     if (fileNames.length === 0) {
-      push("- (no LICENSE/NOTICE/COPYING files)");
+      push(`- (no ${LICENSE_FILES_LABEL} files)`);
       push("");
-      push("_No LICENSE/NOTICE/COPYING file found in package directory._");
+      push(`_No ${LICENSE_FILES_LABEL} file found in package directory._`);
       push("");
       continue;
     }
@@ -53,17 +54,17 @@ export function renderReview(
 ) {
   const lines = [];
   const push = (s = "") => lines.push(s);
-  const mainBase = path.basename(opts.outFile);
+  const mainPath = makeMainLinkPath(opts);
 
   push("# THIRD-PARTY-LICENSE-REVIEW");
   push("");
-  push(`Generated from: ${opts.nodeModules}`);
-  push(`Main file: ${mainBase}`);
+  push(`Generated from: ${opts.nodeModulesDisplay ?? opts.nodeModules}`);
+  push(`Main file: ${mainPath}`);
   push("");
 
   for (const it of [...packages].sort((a, b) => a.key.localeCompare(b.key))) {
     push(`## ${it.key}`);
-    push(`- Main: ${mainBase}#${it.anchor}`);
+    push(`- Main: ${mainPath}#${it.anchor}`);
     push(`- Source: ${it.source ?? "(missing)"}`);
     push(`- License: ${it.license ?? "(missing)"}`);
 
@@ -107,11 +108,18 @@ export function renderReview(
 
   writeList("Missing Source", missingSource);
   writeList("Missing package.json license field", missingLicenseField);
-  writeList("Missing LICENSE/NOTICE/COPYING files", missingFiles);
+  writeList(`Missing ${LICENSE_FILES_LABEL} files`, missingFiles);
 
   return lines.join(os.EOL) + os.EOL;
 }
 
+function makeMainLinkPath(opts) {
+  const baseDir = path.dirname(opts.reviewFile);
+  const rel = path.relative(baseDir, opts.outFile);
+  const normalized = rel.replace(/\\/g, "/");
+  return normalized || path.basename(opts.outFile);
+}
+
 function describeUsage(usage) {
   if (usage === "missing") {
     return "Not found in node_modules (kept from previous output)";

package/src/scan.js

@@ -8,6 +8,7 @@ import {
   walkForPackageJson,
 } from "./fs-utils.js";
 import { getRepositoryUrl } from "./url.js";
+import { LICENSE_FILES_LABEL } from "./constants.js";
 
 // node_modules を走査してパッケージ情報を集約する
 export async function gatherPackages(opts) {
@@ -57,8 +58,9 @@ export async function gatherPackages(opts) {
 
     if (licFiles.length === 0) {
       missingFiles.push(key);
-      flags.push("Missing LICENSE/NOTICE/COPYING files");
-      opts.warn(`Missing LICENSE/NOTICE/COPYING in ${pkgDir} (${key})`);
+      const missingMsg = `Missing ${LICENSE_FILES_LABEL} files`;
+      flags.push(missingMsg);
+      opts.warn(`Missing ${LICENSE_FILES_LABEL} in ${pkgDir} (${key})`);
     }
 
     const licenseTexts =