egoist / konan

find all require/import calls by walking the AST

konan

Like detective but also supports ES6 import and more.

Install

yarn add konan
# or hey old school
npm install --save konan

Supported syntax

• require call
• import/export ES6 modules
• import() Dynamic import
• You can use all language features supported by babel parser, including jsx syntax by default

Usage

const konan = require('konan')

konan(`
import React, {Component} from 'react'
const vue = require('vue/dist/vue')
import('./my-async-module').then()
require(path.resolve('./'))
`)
/*
result =>
{
  strings: ['react', 'vue/dist/vue', './my-async-module'],
  expressions: ['path.resolve(\'./\')']
}
*/

API

konan(input, [options])

input

Type: string object
Required: true

Source content as string or AST tree.

options

dynamicImport

Type: boolean
Default: true

You can disable detecting dynamic import()-ed modules.

parse

Type: object
Default: {sourceType: 'module', plugins: ['jsx', 'typescript', 'dynamicImport']}

babel parser parse options.

FAQ

What does konan stand for?

It stands for Meitantei Konan (名探偵コナン), the main character in Detective Conan.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

konan © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

egoistian.com · GitHub @egoist · Twitter @_egoistlily

konan's Issues

Get raw imports

konan.raw(code)

//=> 
[
  'import { foo } from "foo"',
  'import bar from "bar"'
]

weird behaviour while processing file with strings in objects

This piece of code produces the expected output, however some other variant, that i attached below, don't work as expected.

import Backbone from 'backbone';
import revalidator from 'revalidator';
import URI from 'urijs';
import m from 'moment-timezone';

var schema = {
    properties: {
        x: {
            type: 'string',
            required: true,
            allowEmpty: false
        },
        y: {
            type: 'string',
            required: false,
            allowEmpty: false
        },
        z: {
            type: 'string',
            require: true
        }
    }
}

This produces:

[ 'backbone', 'revalidator', 'urijs', 'moment-timezone' ]

However, doing this:

import Backbone from 'backbone';
import revalidator from 'revalidator';
import URI from 'urijs';
import m from 'moment-timezone';

var schema = {
    properties: {
        x: {
            type: 'string',
            required: true,
            allowEmpty: false
        },
        y: {
            type: 'string',
            required: false,
            allowEmpty: false
        },
        z: {
            type: 'string',
            require: true
        },
        xo: {
            type: 'string',
            require: true
        },
    }
}

Produces this:

[ 'backbone', 'revalidator', 'urijs', 'moment-timezone', 'string' ]

And this:

import Backbone from 'backbone';
import revalidator from 'revalidator';
import URI from 'urijs';
import m from 'moment-timezone';

var schema = {
    properties: {
        x: {
            type: 'string',
            required: true,
            allowEmpty: false
        },
        y: {
            type: 'string',
            required: false,
            allowEmpty: false
        },
        z: {
            type: 'string',
            require: true
        },
        xo: {
            type: 'string',
            require: true
        },
        xp: {
            type: 'hey',
            require: true
        },
    }
}

Produces this:

[ 'backbone', 'revalidator', 'urijs', 'moment-timezone', 'string', 'hey' ]

handle `export ... from ...` imports

As part of our usage of konan in clojurescript, we tripped over this issue when trying to process material-components-web, e.g. with https://unpkg.com/@material/[email protected]/index.js

Issue on the cljs tracker: https://dev.clojure.org/jira/browse/CLJS-2325

Please, provide a more descriptive example in the Usage section.

It's not clear how to actually use this. The example strings are out of context, so it's hard to 'guess' what to actually pass to the module.

Can it be used like this?:

let result = konan( 'path/to/script_to_traverse.js' );

Create typescript declaration file