Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

get-imported

ganeshkbhat1.2kMIT0.0.7

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

require, cache, uncache, uncached, module, fresh, fetch, all, imports, requires, es imports, cjs import, cjs require, mjs import, cjs import, cjs require, js require, fetch imported packages, fetch required packages, require cache, require-cache, get import cache, get imported cache, get require cache, get required cache, get require modules, get required modules, get import modules, get imported modules, imported modules, imported es modules, imported cjs modules, imported esm modules, imported js modules, import module list, required modules, required es modules, required cjs modules, required esm modules, required js modules, required module list, get import cache, get import cache, get import modules, get import modules, get import modules, get imported modules, require modules, require es modules, require cjs modules, require esm modules, require js modules, require module list, import modules, import es modules, import cjs modules, import esm modules, import js modules, import module list, imported packages, import es packages, import cjs packages, import esm packages, import js packages, import packages list, import package list, require package list, require-cache, import-cache, require cache, import cache, esm, cjs, package.json, module, ecmascript, modules, native, modulesnative, modules native, ecmascript modules, ecmascript, modules, check esm, check, esm, find if esm, find file type, module type, type, package type, file type, .mjs, .cjs, .js, js, mjs, js, cjs, script, module, es, es6, commonjs, module, script, file, package, script, is script, is commonjs, is module, is esm, isesm, is-esm, find file type, find if es file type, check if es file type, find if commonjs file type, check if commonjs file type, find file type, check file type, file type, module type, package type, isesm, find-file-type, find-esm, check-esm, is-file-esm, is-esm, check-esm, check-type, check-module-type, check-module-ext, check module ext, check file ext, find-esm, find-type, find-module-type, find-module-ext, find module ext, find file ext

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

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

License

MIT License