pkgscan

pkgscan

pkgscan is a simple and efficient tool to get detailed information about the packages installed in your project. With support from popular package managers such as npm, pnpm, and yarn, you can easily retrieve information about package versions, dependencies, and other relevant information related to installed packages.

If you find this package useful for your projects, please consider supporting me by Buy Me a Coffee. It's a great way to help me maintain and improve this package in the future. Your support is truly appreciated!

Installation

npm

# Try with npx
npx pkgscan [options]

# Locally in your project.
npm install pkgscan

# Or globally (use as cli)
npm install -g pkgscan

CLI

Usage

pkgscan [options]

Options:
  -p, --pkg    The name of the package to retrieve information for.
  -c, --cwd    The current working directory of the project.
  -h, --help   Show help

Examples

# Get details about the installed package with automatic package manager detection.
pkgscan --pkg typescript

# Get details about the installed package with a user-specified package manager.
pkgscan --pkg typescript --cwd ./project-directory-path

API

import { getInstalledPackageDetails } from 'pkgscan';

// Get details about the installed package with automatic package manager detection.
const installedPackage = await getInstalledPackageDetails('typescript');
console.log(installedPackage);
/*
[
  {
    name: 'typescript',
    version: '5.1.3',
    isDirectProjectDependency: true,
    dev: true,
    license: 'Apache-2.0',
    engines: { node: '>=14.17' }
  }
]
*/

// Get details about the installed package with a user-specified package manager.
const cwd = __dirname;
const installedPackage = await getInstalledPackageDetails('typescript', cwd);
console.log(installedPackage);
/*
[
  {
    name: 'typescript',
    version: '5.1.3',
    isDirectProjectDependency: true,
    dev: true,
    license: 'Apache-2.0',
    engines: { node: '>=14.17' }
  }
]
*/

isDirectProjectDependency used to determine whether a package is a direct dependency of a project or not. By using this variable, you can check whether a package is directly listed in the dependencies section of the project's package.json file or not.

Supported package managers:

• npm (lock file versions 1, 2, 3)
• pnpm (all versions of lock files)
• yarn (all versions of lock files)

Feedback

If you discover a bug, or have a suggestion for a feature request, please submit an issue.

LICENSE

This extension is licensed under the MIT License

Changelog

1.0.1

Patch Changes

• db0da5d: Release stable version and public source code