antfu / local-pkg Goto Github PK

View Code? Open in Web Editor NEW

132.0 2.0 11.0 77 KB

Get information on local packages.

License: MIT License

JavaScript 32.13% TypeScript 67.87%

local-pkg's Introduction

local-pkg

Get information on local packages. Works on both CJS and ESM.

Install

npm i local-pkg

Usage

import {
  getPackageInfo,
  importModule,
  isPackageExists,
  resolveModule,
} from 'local-pkg'

isPackageExists('local-pkg') // true
isPackageExists('foo') // false

await getPackageInfo('local-pkg')
/* {
 *   name: "local-pkg",
 *   version: "0.1.0",
 *   rootPath: "/path/to/node_modules/local-pkg",
 *   packageJson: {
 *     ...
 *   }
 * }
 */

// similar to `require.resolve` but works also in ESM
resolveModule('local-pkg')
// '/path/to/node_modules/local-pkg/dist/index.cjs'

// similar to `await import()` but works also in CJS
const { importModule } = await importModule('local-pkg')

License

local-pkg's People

Contributors

Stargazers

Watchers

Forkers

keuby trapcodeio pietrovismara basixkor niuxinyu joshuakgoldberg jevon617 chizukicn dushenyan dmzhan sxzz

local-pkg's Issues

Node 12 support

Tried using this on Node 12.16.3 but I got the engine error.
I had to use has-pkg which serves for what I want to achieve and has no engine limitation.
Is there a specific reason why the engine required is node >=14?

No matching export in "browser-external:fs" for import "existsSync"

importModule does not work with @vitest/[email protected]

Describe the bug

I'm not sure which repo is ultimately responsible for this issue, so let me report this here.

I suddenly started running into TypeError: coverageModule.getProvider is not a function when trying to generate coverage with vitest. Let me just skip straight to the investigation results.

It seems like importModule only considers an import to be ESM if the exported object has a truthy __esModule property. Reference: https://github.com/antfu/local-pkg/blob/main/index.mjs#L20

When I look at the code and dumped the module object during debugging, the module object was found, but the default export doesn't have that property. Reference: https://unpkg.com/browse/@vitest/[email protected]/dist/index.js

After downgrading @vitest/coverage-c8 to 0.29.7 it works again.

Reproduction

I hope my explanation is enough.

System Info

System:
    OS: macOS 12.6.2
    CPU: (12) x64 Intel(R) Core(TM) i7-9750H CPU @ 2.60GHz
    Memory: 20.13 MB / 16.00 GB
    Shell: 5.8.1 - /bin/zsh
  Binaries:
    Node: 18.15.0 - ~/.asdf/installs/nodejs/18.15.0/bin/node
    npm: 9.5.0 - ~/.asdf/plugins/nodejs/shims/npm
  Browsers:
    Chrome: 111.0.5563.146
    Firefox: 111.0.1
    Safari: 16.3
    Safari Technology Preview: 16.4

Used Package Manager

pnpm

Validations

Follow our Code of Conduct
Read the Contributing Guide.
Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
The provided reproduction is a minimal reproducible of the bug.

Yarn PnP support

I'm trying to use Vitest and I'm running into an issue with Yarn PnP:

.pnp.cjs:101340 Uncaught Error: local-pkg tried to access vite, but it isn't declared in its dependencies; this makes the require call ambiguous and unsound.

Required package: vite (via "vite/package.json")
Required by: local-pkg@npm:0.4.0 (via /Users/minh/dev/project/.yarn/cache/local-pkg-npm-0.4.0-c31827f33b-46964cea4b.zip/node_modules/local-pkg/)

I believe that this package needs to support basedir (similar to resolve), and set the paths option of require.resolve:

local-pkg/index.mjs

Lines 51 to 65 in fc9d06c

    
           function resolvePackage(name, options = {}) { 
        
             try { 
        
               return require.resolve(`${name}/package.json`, options) 
        
             } 
        
             catch { 
        
             } 
        
             try { 
        
               return require.resolve(name, options) 
        
             } 
        
             catch (e) { 
        
               if (e.code !== 'MODULE_NOT_FOUND') 
        
                 console.error(e) 
        
               return false 
        
             } 
        
           }

	function resolvePackage(name, options = {}) {
	try {
	return require.resolve(`${name}/package.json`, options)
	}
	catch {
	}
	try {
	return require.resolve(name, options)
	}
	catch (e) {
	if (e.code !== 'MODULE_NOT_FOUND')
	console.error(e)
	return false
	}
	}