find-entry-point

Find the entry point of a Node module via the command line or programmatically.




---

Quick start

``sh
npx find-entry-point
`




---

Install

`sh
npm install find-entry-point -g
`




---

Usage

$3

`shell
$> find-entry-point
`

$3

`javascript
const {findPackageEntryPoint} = require("find-entry-point")
`

`javascript
import {findPackageEntryPoint} from "find-entry-point"
`




---

Examples

#### For Js code

`javascript
const entryPoint = findPackageEntryPoint("to-ansi")
console.log(entryPoint)
// C:\path\to\node_modules\to-ansi\index.cjs
`

`javascript
const entryPoint = findPackageEntryPoint("to-ansi", "some-dir/")
`




#### For command line

`shell
$> find-entry-point --name strip-comments-strings
/projects/find-entry-point/node_modules/strip-comments-strings/index.mjs

$> find-entry-point --name to-ansi --path /projects/some-project-path
/projects/to-esm/node_modules/to-ansi/index.mjs

$> find-entry-point --name to-ansi --path /projects/some-project-path --target cjs
/projects/to-esm/node_modules/to-ansi/index.cjs

$> find-entry-point --name to-ansi --path /projects/some-project-path --target esm
/projects/to-esm/node_modules/to-ansi/index.mjs

$> find-entry-point --name my-module --path /projects/some-project-path --target browser
/projects/to-esm/node_modules/my-module/index.js


$> find-entry-point --name to-ansi
$> find-entry-point to-ansi
$> find-entry-point node_modules/to-ansi
$> find-entry-point which
$> find-entry-point node_modules/which
$> find-entry-point ../clonefile/node_modules/rimraf
$> find-entry-point --name which --path ../clonefile
$> find-entry-point --name ./
$> find-entry-point --name ./ --target esm
$> find-entry-point --name ./ --target browser
`

---

Options

#### For Js code




| Options | Description | Expect | default |
|-------------|----------------------------------------------------------------------------------|-------------|---------|
| silent | _For hiding messages_ | boolean | false |
| exception | _For hiding errors_ | boolean | false |
| isBrowser | _To detect entry point for browser environment_ (takes precedence over isModule) | boolean | false |
| isModule | _To detect entry point for ESM environment_ | boolean | true |
| isCjs | _To detect entry point for CommonJs environment_ | boolean | false |
| noAnsi | _To display errors without ansi colors_ | boolean | false |
| noAmbiguous | _To prevent looking for ambiguous/non standard enough entrypoint_ | boolean | false |






#### For command line


| Options | Description | Expect | default |
|---------------|-----------------------------------|---------------------|---------|
| --silent | _For hiding messages_ | boolean | false |
| --exception | _For hiding errors_ | boolean | false |
| --target | _To force environment_ | browser,esm,cjs | browser |
| --noAnsi | _To disable ANSI symbols_ | boolean | false |
| --noAmbiguous | _To prevent ambiguous entrypoint_ | boolean | false |





---

License

find-entry-point by Patrice Thimothee is marked with CC0 1.0

---

$3

`
📁 package
│
└───📁 cjs
│ │
│ │─ 📝 find-entry-point.cjs ⇽ CJS version - Node (8.93k unminified)
│ │
└───📁 esm
│ │
│ │─ 📝 find-entry-point.mjs ⇽ ESM version - Node (8.94k unminified)
│ │
└───📁 build
│ │
│ │─ 📝 find-entry-point.min.cjs ⇽ CJS version - Node (9.36k minified)
│ │─ 📝 find-entry-point.min.mjs ⇽ ESM version - Node (8.74k minified)

``





---

Changelog

* Add a --noAmbiguous option for skipping ambiguous entrypoint
* Fix undefined variable js error

---