node-modules-tools 0.4.3 → 0.5.0

package/dist/constants.d.mts

@@ -1,3 +1,3 @@
-export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, c as PackageModuleTypes } from './shared/node-modules-tools.CX5_YEVA.mjs';
+export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, c as PackageModuleTypes } from './shared/node-modules-tools.Bnm4jx4C.mjs';
 import 'pkg-types';
 import 'publint';

package/dist/constants.d.ts

@@ -1,3 +1,3 @@
-export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, c as PackageModuleTypes } from './shared/node-modules-tools.CX5_YEVA.js';
+export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, c as PackageModuleTypes } from './shared/node-modules-tools.Bnm4jx4C.js';
 import 'pkg-types';
 import 'publint';

package/dist/index.d.mts

@@ -1,9 +1,9 @@
 import { AgentName } from 'package-manager-detector';
-import { P as PackageNodeRaw, a as PackageNodeBase, b as PackageNode } from './shared/node-modules-tools.CX5_YEVA.mjs';
-export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, F as FileCategory, N as NpmMeta, h as NpmMetaLatest, i as PackageInstallSizeInfo, g as PackageModuleType, f as PackageModuleTypeSimple, c as PackageModuleTypes } from './shared/node-modules-tools.CX5_YEVA.mjs';
+import { P as PackageNodeRaw, a as PackageNodeBase, b as PackageNode } from './shared/node-modules-tools.Bnm4jx4C.mjs';
+export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, F as FileCategory, N as NpmMeta, h as NpmMetaLatest, i as PackageInstallSizeInfo, g as PackageModuleType, f as PackageModuleTypeSimple, c as PackageModuleTypes } from './shared/node-modules-tools.Bnm4jx4C.mjs';
+export { PackageJson } from 'pkg-types';
 export { Message as PublintMessage } from 'publint';
-export { PackageNodeLike, constructPackageFilter, constructPackageFilters } from './utils.mjs';
-import 'pkg-types';
+export { NormalizedFunding, PackageNodeLike, ParsedFunding, constructPackageFilter, constructPackageFilters, normalizePkgAuthor, normalizePkgFundings, normalizePkgRepository, parseAuthor, parseFunding } from './utils.mjs';
 
 interface BaseOptions {
     /**

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import { AgentName } from 'package-manager-detector';
-import { P as PackageNodeRaw, a as PackageNodeBase, b as PackageNode } from './shared/node-modules-tools.CX5_YEVA.js';
-export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, F as FileCategory, N as NpmMeta, h as NpmMetaLatest, i as PackageInstallSizeInfo, g as PackageModuleType, f as PackageModuleTypeSimple, c as PackageModuleTypes } from './shared/node-modules-tools.CX5_YEVA.js';
+import { P as PackageNodeRaw, a as PackageNodeBase, b as PackageNode } from './shared/node-modules-tools.Bnm4jx4C.js';
+export { d as CLUSTER_DEP_DEV, e as CLUSTER_DEP_OPTIONAL, C as CLUSTER_DEP_PROD, F as FileCategory, N as NpmMeta, h as NpmMetaLatest, i as PackageInstallSizeInfo, g as PackageModuleType, f as PackageModuleTypeSimple, c as PackageModuleTypes } from './shared/node-modules-tools.Bnm4jx4C.js';
+export { PackageJson } from 'pkg-types';
 export { Message as PublintMessage } from 'publint';
-export { PackageNodeLike, constructPackageFilter, constructPackageFilters } from './utils.js';
-import 'pkg-types';
+export { NormalizedFunding, PackageNodeLike, ParsedFunding, constructPackageFilter, constructPackageFilters, normalizePkgAuthor, normalizePkgFundings, normalizePkgRepository, parseAuthor, parseFunding } from './utils.js';
 
 interface BaseOptions {
     /**

package/dist/index.mjs

@@ -4,7 +4,7 @@ import { detect } from 'package-manager-detector';
 import fs from 'node:fs/promises';
 import { join as join$1 } from 'pathe';
 import { relative, join } from 'node:path';
-export { c as constructPackageFilter, a as constructPackageFilters } from './shared/node-modules-tools.DT_mm7wI.mjs';
+export { c as constructPackageFilter, a as constructPackageFilters, d as normalizePkgAuthor, n as normalizePkgFundings, e as normalizePkgRepository, b as parseAuthor, p as parseFunding } from './shared/node-modules-tools.D5TyCC_Y.mjs';
 import 'semver';
 
 async function getPackageManager(options) {
@@ -96,6 +96,16 @@ function populateRawResult(input) {
   return result;
 }
 
+function objectPick(obj, keys, omitUndefined = false) {
+  return keys.reduce((n, k) => {
+    if (k in obj) {
+      if (!omitUndefined || obj[k] !== void 0)
+        n[k] = obj[k];
+    }
+    return n;
+  }, {});
+}
+
 function analyzePackageModuleType(pkgJson) {
   if (pkgJson.name?.startsWith("@types/"))
     return "dts";
@@ -285,39 +295,37 @@ function guessFileCategory(file) {
   return "other";
 }
 
+const PACKAGE_JSON_KEYS = [
+  "author",
+  "bin",
+  "bugs",
+  "dependencies",
+  "description",
+  "devDependencies",
+  "engines",
+  "exports",
+  "funding",
+  "homepage",
+  "imports",
+  "keywords",
+  "license",
+  "main",
+  "module",
+  "name",
+  "optionalDependencies",
+  "repository",
+  "types",
+  "version"
+];
 async function resolvePackage(_packageManager, pkg, _options) {
   const _pkg = pkg;
   if (_pkg.resolved)
     return _pkg;
   const content = await fs.readFile(join$1(pkg.filepath, "package.json"), "utf-8");
   const json = JSON.parse(stripBomTag(content));
-  let repository = typeof json.repository === "string" ? json.repository : json.repository?.url;
-  if (repository?.startsWith("git+"))
-    repository = repository.slice(4);
-  if (repository?.endsWith(".git"))
-    repository = repository.slice(0, -4);
-  if (repository?.startsWith("git://"))
-    repository = `https://${repository.slice(6)}`;
-  if (json.repository && typeof json.repository !== "string" && json.repository.directory)
-    repository += `/tree/HEAD/${json.repository.directory}`;
-  const rawFunding = json.funding;
-  let fundings;
-  if (typeof rawFunding === "string") {
-    fundings = [{ url: rawFunding }];
-  } else if (Array.isArray(rawFunding)) {
-    fundings = rawFunding.map((f) => typeof f === "string" ? { url: f } : f);
-  } else {
-    fundings = rawFunding ? [rawFunding] : [];
-  }
   _pkg.resolved = {
     module: analyzePackageModuleType(json),
-    engines: json.engines,
-    license: json.license,
-    author: typeof json.author === "string" ? json.author : json.author?.url,
-    fundings,
-    exports: json.exports,
-    repository,
-    homepage: json.homepage,
+    packageJson: objectPick(json, PACKAGE_JSON_KEYS),
     installSize: await getPackageInstallSize(_pkg)
   };
   return _pkg;

package/dist/shared/{node-modules-tools.CX5_YEVA.d.mts → node-modules-tools.Bnm4jx4C.d.mts}

@@ -1,4 +1,4 @@
-import { PackageJsonExports } from 'pkg-types';
+import { PackageJson } from 'pkg-types';
 import { Message } from 'publint';
 
 interface PackageInstallSizeInfo {
@@ -51,16 +51,7 @@ interface PackageNodeBase extends PackageNodeRaw {
 interface PackageNode extends PackageNodeBase {
     resolved: {
         module: PackageModuleType;
-        license?: string;
-        author?: string;
-        repository?: string;
-        fundings?: {
-            url: string;
-            type?: string;
-        }[];
-        exports?: PackageJsonExports;
-        homepage?: string;
-        engines?: Record<string, string>;
+        packageJson: PackageJson;
         installSize?: PackageInstallSizeInfo;
         npmMeta?: NpmMeta;
         npmMetaLatest?: NpmMetaLatest;

package/dist/shared/{node-modules-tools.CX5_YEVA.d.ts → node-modules-tools.Bnm4jx4C.d.ts}

@@ -1,4 +1,4 @@
-import { PackageJsonExports } from 'pkg-types';
+import { PackageJson } from 'pkg-types';
 import { Message } from 'publint';
 
 interface PackageInstallSizeInfo {
@@ -51,16 +51,7 @@ interface PackageNodeBase extends PackageNodeRaw {
 interface PackageNode extends PackageNodeBase {
     resolved: {
         module: PackageModuleType;
-        license?: string;
-        author?: string;
-        repository?: string;
-        fundings?: {
-            url: string;
-            type?: string;
-        }[];
-        exports?: PackageJsonExports;
-        homepage?: string;
-        engines?: Record<string, string>;
+        packageJson: PackageJson;
         installSize?: PackageInstallSizeInfo;
         npmMeta?: NpmMeta;
         npmMetaLatest?: NpmMetaLatest;

package/dist/shared/node-modules-tools.D5TyCC_Y.mjs

@@ -0,0 +1,111 @@
+import { satisfies } from 'semver';
+
+function constructPackageFilter(range) {
+  const [name, version = "*"] = range.split(/\b@/);
+  const hasWildcard = name?.includes("*");
+  const nameMatch = hasWildcard ? new RegExp(`^${Array.from(name).map((char) => char === "*" ? ".*" : char === "." ? "\\." : char).join("")}$`) : name;
+  return (pkg) => {
+    const isNameMatch = nameMatch instanceof RegExp ? nameMatch.test(pkg.name) : pkg.name === name;
+    const isVersionMatch = version === "*" || pkg.version === version || satisfies(pkg.version, version);
+    return isNameMatch && isVersionMatch;
+  };
+}
+function constructPackageFilters(ranges, mode) {
+  const filters = ranges.map((x) => typeof x === "string" ? constructPackageFilter(x) : x);
+  return (pkg) => mode === "some" ? filters.some((filter) => filter(pkg)) : filters.every((filter) => filter(pkg));
+}
+
+function parseFunding(funding) {
+  const url = funding.url;
+  let name = "";
+  let type = funding.type || "link";
+  let avatar;
+  let match = url.match(/^(?:https?:\/\/)?(?:www\.)?github\.com\/sponsors\/([\w.-]+)/i);
+  if (match) {
+    name = match[1];
+    type = "github";
+  }
+  if (!name) {
+    match = url.match(/^(?:https?:\/\/)?(?:www\.)?github\.com\/([\w.-]+)/i);
+    if (match) {
+      name = match[1];
+      type = "github";
+    }
+  }
+  if (!name) {
+    match = url.match(/^(?:https?:\/\/)?(?:www\.)?opencollective\.com\/([\w.-]+)/i);
+    if (match) {
+      name = match[1];
+      type = "opencollective";
+    }
+  }
+  if (!name)
+    name = url.replace(/^(?:https?:\/\/)?(?:www\.)?/, "").replace(/\/$/, "");
+  if (type === "github" && name)
+    avatar = `https://avatars.antfu.dev/gh/${name}`;
+  if (type === "opencollective" && name)
+    avatar = `https://opencollective.com/${name}/avatar.png`;
+  const entry = `${type}@${name}`;
+  return {
+    url,
+    type,
+    entry,
+    name,
+    avatar
+  };
+}
+function normalizePkgFundings(json) {
+  const rawFunding = json.funding;
+  let fundings;
+  if (typeof rawFunding === "string") {
+    fundings = [{ url: rawFunding }];
+  } else if (Array.isArray(rawFunding)) {
+    fundings = rawFunding.map((f) => typeof f === "string" ? { url: f } : f);
+  } else {
+    fundings = rawFunding ? [rawFunding] : [];
+  }
+  if (fundings.length === 0)
+    return void 0;
+  return fundings.map((f) => parseFunding(f)).filter(Boolean);
+}
+function parseAuthor(author) {
+  if (!author)
+    return void 0;
+}
+function normalizePkgAuthor(json) {
+  const author = json.author;
+  if (!author)
+    return void 0;
+  if (typeof author === "string") {
+    let url;
+    const name = author.replace(/<.*>/, "").replace(/\(.*\)/, "").replace(/^https?:\/\//, "");
+    return {
+      name,
+      url
+    };
+  }
+  return {
+    name: author.name,
+    url: author.url
+  };
+}
+function normalizePkgRepository(json) {
+  if (!json.repository)
+    return void 0;
+  let url = typeof json.repository === "string" ? json.repository : json.repository?.url;
+  if (url?.startsWith("git+"))
+    url = url.slice(4);
+  if (url?.endsWith(".git"))
+    url = url.slice(0, -4);
+  if (url?.startsWith("git://"))
+    url = `https://${url.slice(6)}`;
+  if (json.repository && typeof json.repository !== "string" && json.repository.directory)
+    url += `/tree/HEAD/${json.repository.directory}`;
+  if (/^[a-z0-9]+(?:[-_.][a-z0-9]+)*\/[a-z0-9]+(?:[-_.][a-z0-9]+)*$/i.test(url))
+    url = `https://github.com/${url}`;
+  return {
+    url
+  };
+}
+
+export { constructPackageFilters as a, parseAuthor as b, constructPackageFilter as c, normalizePkgAuthor as d, normalizePkgRepository as e, normalizePkgFundings as n, parseFunding as p };

package/dist/utils.d.mts

@@ -1,3 +1,5 @@
+import { PackageJson } from 'pkg-types';
+
 interface PackageNodeLike {
     name: string;
     version: string;
@@ -14,4 +16,26 @@ interface PackageNodeLike {
 declare function constructPackageFilter(range: string): (pkg: PackageNodeLike) => boolean;
 declare function constructPackageFilters<Node extends PackageNodeLike = PackageNodeLike>(ranges: (string | ((pkg: Node) => boolean))[], mode: 'some' | 'every'): (pkg: Node) => boolean;
 
-export { type PackageNodeLike, constructPackageFilter, constructPackageFilters };
+interface NormalizedFunding {
+    url: string;
+    type?: string;
+}
+interface ParsedFunding {
+    url: string;
+    type: string;
+    name: string;
+    entry: string;
+    avatar?: string;
+}
+declare function parseFunding(funding: NormalizedFunding): ParsedFunding;
+declare function normalizePkgFundings(json: PackageJson): ParsedFunding[] | undefined;
+declare function parseAuthor(author?: string): undefined;
+declare function normalizePkgAuthor(json: PackageJson): {
+    name: string;
+    url: string | undefined;
+} | undefined;
+declare function normalizePkgRepository(json: PackageJson): {
+    url: string;
+} | undefined;
+
+export { type NormalizedFunding, type PackageNodeLike, type ParsedFunding, constructPackageFilter, constructPackageFilters, normalizePkgAuthor, normalizePkgFundings, normalizePkgRepository, parseAuthor, parseFunding };

package/dist/utils.d.ts

@@ -1,3 +1,5 @@
+import { PackageJson } from 'pkg-types';
+
 interface PackageNodeLike {
     name: string;
     version: string;
@@ -14,4 +16,26 @@ interface PackageNodeLike {
 declare function constructPackageFilter(range: string): (pkg: PackageNodeLike) => boolean;
 declare function constructPackageFilters<Node extends PackageNodeLike = PackageNodeLike>(ranges: (string | ((pkg: Node) => boolean))[], mode: 'some' | 'every'): (pkg: Node) => boolean;
 
-export { type PackageNodeLike, constructPackageFilter, constructPackageFilters };
+interface NormalizedFunding {
+    url: string;
+    type?: string;
+}
+interface ParsedFunding {
+    url: string;
+    type: string;
+    name: string;
+    entry: string;
+    avatar?: string;
+}
+declare function parseFunding(funding: NormalizedFunding): ParsedFunding;
+declare function normalizePkgFundings(json: PackageJson): ParsedFunding[] | undefined;
+declare function parseAuthor(author?: string): undefined;
+declare function normalizePkgAuthor(json: PackageJson): {
+    name: string;
+    url: string | undefined;
+} | undefined;
+declare function normalizePkgRepository(json: PackageJson): {
+    url: string;
+} | undefined;
+
+export { type NormalizedFunding, type PackageNodeLike, type ParsedFunding, constructPackageFilter, constructPackageFilters, normalizePkgAuthor, normalizePkgFundings, normalizePkgRepository, parseAuthor, parseFunding };

package/dist/utils.mjs

@@ -1,2 +1,2 @@
-export { c as constructPackageFilter, a as constructPackageFilters } from './shared/node-modules-tools.DT_mm7wI.mjs';
+export { c as constructPackageFilter, a as constructPackageFilters, d as normalizePkgAuthor, n as normalizePkgFundings, e as normalizePkgRepository, b as parseAuthor, p as parseFunding } from './shared/node-modules-tools.D5TyCC_Y.mjs';
 import 'semver';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-modules-tools",
   "type": "module",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "Tools for inspecting node_modules",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",

package/dist/shared/node-modules-tools.DT_mm7wI.mjs

@@ -1,18 +0,0 @@
-import { satisfies } from 'semver';
-
-function constructPackageFilter(range) {
-  const [name, version = "*"] = range.split(/\b@/);
-  const hasWildcard = name?.includes("*");
-  const nameMatch = hasWildcard ? new RegExp(`^${Array.from(name).map((char) => char === "*" ? ".*" : char === "." ? "\\." : char).join("")}$`) : name;
-  return (pkg) => {
-    const isNameMatch = nameMatch instanceof RegExp ? nameMatch.test(pkg.name) : pkg.name === name;
-    const isVersionMatch = version === "*" || pkg.version === version || satisfies(pkg.version, version);
-    return isNameMatch && isVersionMatch;
-  };
-}
-function constructPackageFilters(ranges, mode) {
-  const filters = ranges.map((x) => typeof x === "string" ? constructPackageFilter(x) : x);
-  return (pkg) => mode === "some" ? filters.some((filter) => filter(pkg)) : filters.every((filter) => filter(pkg));
-}
-
-export { constructPackageFilters as a, constructPackageFilter as c };