node-modules-tools 0.0.0 → 0.0.1

package/dist/chunks/pnpm.mjs

@@ -34,8 +34,6 @@ async function listPackageDependencies(options) {
     return node;
   }
   function traverse(_node, level, mode, directImporter, nestedImporter) {
-    if (_node.from.startsWith("@types"))
-      return;
     const node = normalize(_node);
     if (directImporter)
       node.dependents.add(directImporter);
@@ -74,6 +72,8 @@ async function listPackageDependencies(options) {
     }
   }
   return {
+    cwd: options.cwd,
+    packageManager: "pnpm",
     packages
   };
 }

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 type PackageModuleTypeSimple = 'cjs' | 'esm';
-type PackageModuleType = 'cjs' | 'esm' | 'dual' | 'faux';
+type PackageModuleType = 'cjs' | 'esm' | 'dual' | 'faux' | 'none';
 interface ListPackageDependenciesOptions {
     /**
      * Current working directory
@@ -19,6 +19,8 @@ interface ListPackageDependenciesOptions {
     traverseFilter?: (node: PackageNode) => boolean;
 }
 interface ListPackageDependenciesResult {
+    cwd: string;
+    packageManager: string;
     packages: PackageNode[];
 }
 interface PackageNode {
@@ -48,22 +50,28 @@ interface PackageNode {
     optional: boolean;
 }
 interface ResolvedPackageNode extends PackageNode {
-    module: PackageModuleType;
+    resolved: {
+        module: PackageModuleType;
+        license?: string;
+        author?: string;
+        repository?: string;
+        engines?: Record<string, string>;
+    };
 }
 
 /**
- * Analyze a package node, and return a resolved package node.
- * This function mutates the input package node.
+ * List dependencies of packages in the current project.
  *
- * - Set `module` to the resolved module type (cjs, esm, dual, faux).
+ * This function will automatically detect the package manager in the current project, and list the dependencies of the packages.
  */
-declare function analyzePackage(pkg: PackageNode): Promise<ResolvedPackageNode>;
+declare function listPackageDependencies(options: ListPackageDependenciesOptions): Promise<ListPackageDependenciesResult>;
 
 /**
- * List dependencies of packages in the current project.
+ * Analyze a package node, and return a resolved package node.
+ * This function mutates the input package node.
  *
- * This function will automatically detect the package manager in the current project, and list the dependencies of the packages.
+ * - Set `module` to the resolved module type (cjs, esm, dual, faux, none).
  */
-declare function listPackageDependencies(options: ListPackageDependenciesOptions): Promise<ListPackageDependenciesResult>;
+declare function resolvePackage(pkg: PackageNode): Promise<ResolvedPackageNode>;
 
-export { type ListPackageDependenciesOptions, type ListPackageDependenciesResult, type PackageModuleType, type PackageModuleTypeSimple, type PackageNode, type ResolvedPackageNode, analyzePackage, listPackageDependencies };
+export { type ListPackageDependenciesOptions, type ListPackageDependenciesResult, type PackageModuleType, type PackageModuleTypeSimple, type PackageNode, type ResolvedPackageNode, listPackageDependencies, resolvePackage };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 type PackageModuleTypeSimple = 'cjs' | 'esm';
-type PackageModuleType = 'cjs' | 'esm' | 'dual' | 'faux';
+type PackageModuleType = 'cjs' | 'esm' | 'dual' | 'faux' | 'none';
 interface ListPackageDependenciesOptions {
     /**
      * Current working directory
@@ -19,6 +19,8 @@ interface ListPackageDependenciesOptions {
     traverseFilter?: (node: PackageNode) => boolean;
 }
 interface ListPackageDependenciesResult {
+    cwd: string;
+    packageManager: string;
     packages: PackageNode[];
 }
 interface PackageNode {
@@ -48,22 +50,28 @@ interface PackageNode {
     optional: boolean;
 }
 interface ResolvedPackageNode extends PackageNode {
-    module: PackageModuleType;
+    resolved: {
+        module: PackageModuleType;
+        license?: string;
+        author?: string;
+        repository?: string;
+        engines?: Record<string, string>;
+    };
 }
 
 /**
- * Analyze a package node, and return a resolved package node.
- * This function mutates the input package node.
+ * List dependencies of packages in the current project.
  *
- * - Set `module` to the resolved module type (cjs, esm, dual, faux).
+ * This function will automatically detect the package manager in the current project, and list the dependencies of the packages.
  */
-declare function analyzePackage(pkg: PackageNode): Promise<ResolvedPackageNode>;
+declare function listPackageDependencies(options: ListPackageDependenciesOptions): Promise<ListPackageDependenciesResult>;
 
 /**
- * List dependencies of packages in the current project.
+ * Analyze a package node, and return a resolved package node.
+ * This function mutates the input package node.
  *
- * This function will automatically detect the package manager in the current project, and list the dependencies of the packages.
+ * - Set `module` to the resolved module type (cjs, esm, dual, faux, none).
  */
-declare function listPackageDependencies(options: ListPackageDependenciesOptions): Promise<ListPackageDependenciesResult>;
+declare function resolvePackage(pkg: PackageNode): Promise<ResolvedPackageNode>;
 
-export { type ListPackageDependenciesOptions, type ListPackageDependenciesResult, type PackageModuleType, type PackageModuleTypeSimple, type PackageNode, type ResolvedPackageNode, analyzePackage, listPackageDependencies };
+export { type ListPackageDependenciesOptions, type ListPackageDependenciesResult, type PackageModuleType, type PackageModuleTypeSimple, type PackageNode, type ResolvedPackageNode, listPackageDependencies, resolvePackage };

package/dist/index.mjs

@@ -1,8 +1,20 @@
+import { detect } from 'package-manager-detector';
 import fs from 'node:fs/promises';
 import { join } from 'node:path';
-import { detect } from 'package-manager-detector';
 
-function analyzePackageJson(pkgJson) {
+async function listPackageDependencies(options) {
+  const manager = await detect({
+    cwd: options.cwd
+  });
+  if (!manager)
+    throw new Error("Cannot detect package manager in the current patch");
+  if (manager.name === "pnpm")
+    return await import('./chunks/pnpm.mjs').then((r) => r.listPackageDependencies(options));
+  else
+    throw new Error(`Package manager ${manager.name} is not yet supported`);
+}
+
+function analyzePackageModuleType(pkgJson) {
   const { exports, main, type } = pkgJson;
   let cjs;
   let esm;
@@ -30,12 +42,19 @@ function analyzePackageJson(pkgJson) {
   if (cjs === undefined && esm === undefined) {
     if (type === "module" || main && /\.mjs$/.test(main)) {
       esm = true;
-    } else {
+    } else if (main) {
       cjs = true;
     }
   }
-  const style = esm && cjs ? "dual" : esm ? "esm" : fauxEsm ? "faux" : "cjs";
-  return style;
+  if (esm && cjs)
+    return "dual";
+  if (esm)
+    return "esm";
+  if (fauxEsm)
+    return "faux";
+  if (!esm && !cjs)
+    return "none";
+  return "cjs";
   function analyzeThing(value, path) {
     if (value && typeof value === "object") {
       if (Array.isArray(value)) {
@@ -100,26 +119,20 @@ function stripBomTag(content) {
   return content;
 }
 
-async function analyzePackage(pkg) {
+async function resolvePackage(pkg) {
   const _pkg = pkg;
-  if (_pkg.module)
+  if (_pkg.resolved)
     return _pkg;
   const content = await fs.readFile(join(pkg.path, "package.json"), "utf-8");
   const json = JSON.parse(stripBomTag(content));
-  _pkg.module = analyzePackageJson(json);
+  _pkg.resolved = {
+    module: analyzePackageModuleType(json),
+    engines: json.engines,
+    license: json.license,
+    author: typeof json.author === "string" ? json.author : json.author?.url,
+    repository: typeof json.repository === "string" ? json.repository : json.repository?.url
+  };
   return _pkg;
 }
 
-async function listPackageDependencies(options) {
-  const manager = await detect({
-    cwd: options.cwd
-  });
-  if (!manager)
-    throw new Error("Cannot detect package manager in the current patch");
-  if (manager.name === "pnpm")
-    return await import('./chunks/pnpm.mjs').then((r) => r.listPackageDependencies(options));
-  else
-    throw new Error(`Package manager ${manager.name} is not yet supported`);
-}
-
-export { analyzePackage, listPackageDependencies };
+export { listPackageDependencies, resolvePackage };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-modules-tools",
   "type": "module",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Tools for inspecting node_modules",
   "author": "Anthony Fu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -44,7 +44,7 @@
   },
   "scripts": {
     "build": "unbuild",
-    "dev": "unbuild --stub",
+    "stub": "unbuild --stub",
     "start": "tsx src/index.ts",
     "test": "vitest"
   }