# babel-parse-wild-code

> parse a file in a foreign directory with babel, using ambient babel config

Latest version **2.1.5** (published 2023-06-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install babel-parse-wild-code
pnpm add babel-parse-wild-code
yarn add babel-parse-wild-code
bun add babel-parse-wild-code
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.5 |
| Published | 2023-06-12 |
| First published | 2021-04-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 80.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Andy Edwards |
| Maintainers | jedwards1211 |

## Links

- npm: https://www.npmjs.com/package/babel-parse-wild-code
- Repository: https://github.com/codemodsquad/babel-parse-wild-code
- Homepage: https://github.com/codemodsquad/babel-parse-wild-code#readme
- Issues: https://github.com/codemodsquad/babel-parse-wild-code/issues
- npm.io page: https://npm.io/package/babel-parse-wild-code

## Dependencies (4)

- [resolve](https://npm.io/package/resolve.md) ^1.22.1
- [@babel/types](https://npm.io/package/@babel/types.md) ^7.19.0
- [@babel/parser](https://npm.io/package/@babel/parser.md) ^7.19.0
- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.19.0

## Recent versions

- 2.1.5 (latest) — 2023-06-12
- 2.1.4 — 2023-06-11
- 2.1.3 — 2023-05-16
- 2.1.2 — 2022-11-27
- 2.1.1 — 2022-11-17
- 2.1.0 — 2022-11-17
- 2.0.2 — 2022-09-21
- 2.0.1 — 2022-09-21
- 2.0.0 — 2022-09-21
- 1.2.3 — 2022-09-12
- 1.2.2 — 2022-09-10
- 1.2.1 — 2022-09-10
- 1.2.0 — 2022-08-17
- 1.1.1 — 2021-04-09
- 1.1.0 — 2021-04-08
- … 1 more at https://npm.io/package/babel-parse-wild-code/versions

## README

# babel-parse-wild-code

Provides an easy-to-use API for parsing users' js/ts/tsx files using their project's installed Babel version and config.
This way it won't fail if they're using funky features like the smart pipeline operator. This is a big problem for codemod
tools; for example, `jscodeshift` would choke on the smart pipeline operator unless you pass a custom parser. I want my
codemod tools to just work.

Note: only Babel 7 is currently supported.

`babel-parse-wild-code` also improves performance. Until recently, doing `require('@babel/core').loadOptionsAsync` and passing that config
to a bunch of `require('@babel/core').parseAsync` calls didn't improve performance as expected; `parseAsync` was accidentally re-doing
a lot of the work that had already been done by `loadOptionsAsync`. That bug has been fixed since I reported it, but `babel-parse-wild-code`
works around this for older versions of Babel 7 by extracting the options for `@babel/parser` from the user's Babel config.

If `babel-parse-wild-code` fails to load `@babel/core`, `@babel/parser`, or the Babel config from the user's
project, it falls back to parsing with reasonable default options.

# API

## `parseSync(file: string, options?: { encoding?: BufferEncoding } & ParserOptions): File`

```ts
import { parseSync } from 'babel-parse-wild-code'
```

Parses the given file synchronously, returning the `File` node.

`encoding` defaults to `utf8`. The remaining options are passed to `@babel/parser`'s `parse` function.
`options.plugins` will be merged with the resolved options for the file.

## `parseAsync(file: string, options?: { encoding?: BufferEncoding } & ParserOptions): Promise<File>`

```ts
import { parseAsync } from 'babel-parse-wild-code'
```

Parses the given file asynchronously, returning a `Promise` that will resolve to the `File` node.

`encoding` defaults to `utf8`. The remaining options are passed to `@babel/parser`'s `parse` function.
`options.plugins` will be merged with the resolved options for the file.

## `clearCache(): void`

Instances of `@babel/core`, `@babel/parser` and parser options are cached on a per-directory basis.
Calling `clearCache()` clears this cache, and deletes instances of `@babel/core` and `@babel/parser`
from `require.cache`.

You should probably do this before any bulk parsing operation. It would be nice to bust the cache
automatically when the user's Babel version or config changes, but setting up the watchers would be
complicated. Clearing the cache before you parse a bunch of files is simpler and won't have a huge
impact on performance.

## `getParserSync(file: string, options?: ParserOptions): Parser`

```ts
import { getParserSync } from 'babel-parse-wild-code'
```

Gets a fully-configured parser for the given file synchronously.

`options` is additional options for `@babel/parser`'s `parse` function. For example when working
with `jscodeshift` or `recast`, you should pass `{ tokens: true }`.
`options.plugins` will be merged with the resolved options for the file.

## `getParserAsync(file: string, options?: ParserOptions): Promise<Parser>`

```ts
import { getParserSync } from 'babel-parse-wild-code'
```

Gets a fully-configured parser for the given file asynchronously.

`options` is additional options for `@babel/parser`'s `parse` function. For example when working
with `jscodeshift` or `recast`, you should pass `{ tokens: true }`.
`options.plugins` will be merged with the resolved options for the file.

## `class Parser`

```ts
import { Parser } from 'babel-parse-wild-code'
```

Type defs:

```ts
import * as defaultBabelParser from '@babel/parser'

type BabelParser = Pick<typeof defaultBabelParser, 'parse' | 'parseExpression'>

export class Parser {
  readonly babelParser: BabelParser
  readonly parserOpts: ParserOptions

  constructor(babelParser: BabelParser, parserOpts: ParserOptions)
  parse(code: string, parserOpts?: ParserOptions): t.File
  parseExpression(code: string, parserOpts?: ParserOptions): t.Expression
  bindParserOpts(parserOpts: ParserOptions): Parser
}
```

## `tsParser`

```ts
import { tsParser } from 'babel-parse-wild-code'
```

The fallback parser used for `.ts` files.

## `tsxParser`

```ts
import { tsxParser } from 'babel-parse-wild-code'
```

The fallback parser used for `.tsx` files.

## `jsParser`

```ts
import { jsParser } from 'babel-parse-wild-code'
```

The fallback parser used for parsing `.js` files when `babel-parse-wild-code` failed to load Babel modules or config for the file's directory.
Note: this is the same as `jsxParser`, but `jsxParser` is exported for completeness.

## `jsxParser`

```ts
import { jsxParser } from 'babel-parse-wild-code'
```

The fallback parser used for parsing `.jsx` files when `babel-parse-wild-code` failed to load Babel modules or config for the file's directory.

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