Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ganeshkbhat/get-imports
The module has JS functions to check all imports or required modules and check if the file is a ES Module or a CJS/ JS Module or Script
https://github.com/ganeshkbhat/get-imports
cjs es esm iscjscode isescode isesmcode js mjs
Last synced: 13 days ago
JSON representation
The module has JS functions to check all imports or required modules and check if the file is a ES Module or a CJS/ JS Module or Script
- Host: GitHub
- URL: https://github.com/ganeshkbhat/get-imports
- Owner: ganeshkbhat
- License: mit
- Created: 2022-10-29T04:55:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T11:40:40.000Z (10 months ago)
- Last Synced: 2024-10-31T23:42:07.027Z (20 days ago)
- Topics: cjs, es, esm, iscjscode, isescode, isesmcode, js, mjs
- Language: JavaScript
- Homepage:
- Size: 460 KB
- Stars: 4
- Watchers: 1
- Forks: 30
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# get-imported
Module to fetch all required and imported modules in Javascript and NodeJS. The module has JS functions to check all imports or required modules and check if the file is a ES Module or a CJS/ JS Module or Script
Find the demos in the [demos folder](./demos)
# Usage
`CommonJS example`
File example: `demos/parser.imports.regex.js`
```
const parser = require("get-imported");
let example_one = parser._importRegex("./demos/src/parser.imports.regex.js");
let example_two = parser._requiresObject();
let example_three = parser._requireRegex("./demos/src/parser.require.regex.js");
let example_four = parser._importRegexExtended("./demos/src/parser.imports.regex.extended.js");
```
File example: `demos/parser.imports.regex.mjs`
```
import * as parser from "get-imported";
const path = import('path');
const someModuleCJS = import('./parser.demo.require.cache.test.file.cjs');
const someModuleJS = import('./parser.demo.require.cache.test.file.js');
const acorn = import("chai");
let arr = parser._importESRegex("./demos/src/parser.imports.regex.mjs");
console.log(arr);
```
---
### INSTALL
```npm install get-imported --save```
---
### USAGE
ESM Module
`import { _isESCode } from "get-imported";`
CommonJS Script/ Module
```
const checkEsm = require("get-imported");
isESCode("./path/to/file.mjs")
```
---
### Package APIs
There are other script APIs you may wish to explore that includes the following:
#### `.checkModuleImports`
Check if a module can be imported using `import()`
Usage:
`.checkModuleImports(absPath)`
#### `.requiresObject`
Check require.cache list in code - used in your code's process global context.
Usage:
`.requiresObject()`
#### `.requireRegex`
Check to see if there are `require()` syntax in code.
Usage:
`.requireRegex(absPath, basePath = "", useProcessCwd = false)`
`.requireRegex(absPath)`
#### `.importRegex`
Check to see if there are `import()` syntax in code.
Usage:
`.importRegex(absPath, basePath = "", useProcessCwd = false)`
`.importRegex(absPath)`
#### `.importESRegex`
Check to see if there are `import x from ""` syntax in code.
Usage:
`.importESRegex(absPath, basePath = "", useProcessCwd = false)`
`.importESRegex(absPath)`
#### `.importRegexExtended`
Check to see if there are `import()` syntax in code.
Usage:
`.importRegexExtended(absPath, basePath = "", useProcessCwd = false)`
`.importRegexExtended(absPath)`
#### `.isESMFileExtension`
Check to see if the file has `.mjs`/ `.cjs`/ `.js` extension.
Usage:
`.isESMFileExtension(absPath)`
#### `.isNodeCompatibleFileExtension`
Check to see if the file has `.mjs`/ `.cjs`/ `.js` / `.node` / `.wasm` extension.
Usage:
`.isNodeCompatibleFileExtension(absPath)`
#### `.isESMCodeBase`
Check to see if the code is ESM Module.
Usage:
`.isESMCodeBase(absPath)`
#### `isCJSCodeBase`
Check to see if the code is CommonJS Script or Module.
Usage:
`isCJSCodeBase(absPath)`
#### `isModuleInPackageJson`
Checks type key's value in package.json.
Usage:
`getPackageJsonRoot(startdirectory, options)`
#### `isESCode`
Multiple checks to check if the code is ESM Module (other than package.json type key's value check in package.json).
Usage:
`isModuleInPackageJson(absPath, packagejsonPath, returns)`
---
### Contributions
Contributions, Feature Improvements, Bugs, and Issues are invited. [raising an issue](https://github.com/ganeshkbhat/get-imports/issues)
# License
[MIT License](./LICENSE)