Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@putout/engine-parser

Package Overview
Dependencies
Maintainers
1
Versions
112
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@putout/engine-parser

🐊Putout parser

  • 8.2.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
22K
increased by17.44%
Maintainers
1
Weekly downloads
 
Created
Source

@putout/engine-parser NPM version

🐊Putout engine that parses input.

Install

npm i @putout/engine-parser

Supported parsers

Any parser should be installed before use, but you can be sure that @babel/parse always installed.

API

By default @putout/printer used. It formats code according to eslint-plugin-putout rules but without using ESLint.

But you can also use recast or babel with:

const ast = parse(source, {
    printer: 'recast',
});

const code = print(ast, {
    printer: 'recast',
});

When you need to pass options, use:

const code = print(ast, {
    printer: ['putout', {
        format: {
            indent: '    ',
        },
    }],
});

print(ast [, options])

Print code from ast

parse(code, [, options])

You can add default options for custom parser you use.

parse.fresh(code)

parse without memoization.

parse.ast(template)

create node using memoization.

parse.ast.fresh(template)

create node without memoization.

Sourcemaps

You have two ways to benefit from source map generation:

  • using Recast print;
  • using Babel generator;
Generate sourcemaps using Recast
const source = `const hello = 'world';`;

const ast = parse(source, {
    printer: 'recast',
    sourceFileName: 'hello.js',
});

print(ast, {
    printer: 'recast',
    sourceMapName: 'hello.map',
});

// returns
`const hello = 'world';
{"version":3,"sources":["hello.js"],"names":[],"mappings":"AAAA...","file":"hello.map","sourcesContent":["const hello = 'world';"]}`;
Generate sourcemaps using Babel

To generate sourcemap using babel generator, you should use babel parser before. This is low level transformation, because Babel doesn't preserve any formatting.

const {generate} = require('@putout/engine-parser');
const babel = require('@putout/engine-parser/babel');

const ast = babel.parse(source, {
    sourceFilename: 'hello.js',
});

generate(ast, {sourceMaps: true}, {
    'hello.js': source,
});

// returns
({
    code,
    map,
});

Example

const {parse} = require('@putout/engine-parser');
const parser = 'acorn';

const code = parse('var t = "hello"', {
    parser,
});

License

MIT

Keywords

FAQs

Package last updated on 14 Aug 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc