npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jscodeshift-find-imports

v2.0.5

Published

find imported/required identifiers with jscodeshift

Downloads

136,147

Readme

jscodeshift-find-imports

CircleCI Coverage Status semantic-release Commitizen friendly npm version

find imported/required identifiers with jscodeshift

Usage

npm i jscodeshift-find-imports
const findImports = require('jscodeshift-find-imports')
const j = require('jscodeshift')
const { statement } = j.template

const code = `
import bar from 'foo'
`

const imports = findImports(j(code), statement`import foo from 'foo'`)

console.log(imports) // {foo: {type: 'Identifier', name: 'bar'}}

Compatibility

Currently tested and working with [email protected] and the following parsers:

  • 'babel'
  • 'babylon'
  • 'ts'
  • 'flow'

It won't likely work with other custom parsers unless they output nodes in the same format as Babel for import declarations, variable declarations, require calls, and object patterns.

findImports(root, statements)

Arguments

root

The jscodeshift-wrapped AST of source code

statements

The AST of an ImportDeclaration or VariableDeclaration containing require calls to search for (e.g. const foo = require('foo')), or an array of them.

Returns

An object where each key is an identifier from your search statement(s) that was found, and the corresponding value is the AST for the local binding for that import (either an Identifier or MemberExpression node). For example, if you search for const {bar} = require('bar') but the source code has const foo = require('bar').bar, the result will have bar: { type: 'Identifier', name: 'bar' }.

The local binding will be a MemberExpression in cases like this:

const code = `
import React from 'react'
`
const imports = findImports(
  j(code),
  statement`import { Component } from 'react'`
)

In this case imports would be

{
  Component: {
    type: 'MemberExpression',
    object: {
      type: 'Identifier',
      name: 'React',
    },
    property: {
      type: 'Identifier',
      name: 'Component',
    },
  },
}