# konan

> find all `require` `import` calls by walking the AST

Latest version **2.1.1** (published 2020-07-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install konan
pnpm add konan
yarn add konan
bun add konan
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2020-07-15 |
| First published | 2017-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 53 |
| Author | egoist |
| Maintainers | egoist, rem |

## Links

- npm: https://www.npmjs.com/package/konan
- Repository: https://github.com/egoist/konan
- Homepage: https://github.com/egoist/konan#readme
- Issues: https://github.com/egoist/konan/issues
- npm.io page: https://npm.io/package/konan

## Dependencies (2)

- [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.10.5
- [@babel/traverse](https://npm.io/package/@babel/traverse.md) ^7.10.5

## Recent versions

- 2.1.1 (latest) — 2020-07-15
- 2.1.0 — 2020-07-15
- 2.0.0 — 2020-07-15
- 1.2.1 — 2017-08-17
- 1.2.0 — 2017-08-16
- 1.1.0 — 2017-02-25
- 1.0.0 — 2017-02-22
- 0.1.2 — 2017-02-10
- 0.1.1 — 2017-02-05
- 0.1.0 — 2017-02-05

## README

# konan

[![NPM version](https://img.shields.io/npm/v/konan.svg?style=flat)](https://npmjs.com/package/konan) [![NPM downloads](https://img.shields.io/npm/dm/konan.svg?style=flat)](https://npmjs.com/package/konan) [![Build Status](https://img.shields.io/circleci/project/egoist/konan/master.svg?style=flat)](https://circleci.com/gh/egoist/konan) [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate)

> Like [detective](https://github.com/substack/node-detective) but also supports ES6 `import` and more.

## Install

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

## Supported syntax

- `require` call
- `import/export` ES6 modules
- `import()` [Dynamic import](https://github.com/tc39/proposal-dynamic-import)
- You can use all language features supported by [babel parser](https://github.com/babel/babel/tree/master/packages/babel-parser), including `jsx` syntax by default

## Usage

```js
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`<br>
Required: `true`

Source content as string or AST tree.

#### options

##### dynamicImport

Type: `boolean`<br>
Default: `true`

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

##### parse

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

[babel parser](https://github.com/babel/babel/tree/master/packages/babel-parser) parse [options](https://babeljs.io/docs/en/next/babel-parser.html#options).

## FAQ

### What does konan stand for?

It stands for `Meitantei Konan` (名探偵コナン), the main character in [Detective Conan](https://en.wikipedia.org/wiki/Case_Closed).

## 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](https://github.com/egoist), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by egoist with help from contributors ([list](https://github.com/egoist/konan/contributors)).

> [egoistian.com](https://egoistian.com) · GitHub [@egoist](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)

---
_Source: https://npm.io/package/konan · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._