Socket
Socket
Sign inDemoInstall

ast-module-types

Package Overview
Dependencies
0
Maintainers
3
Versions
22
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    ast-module-types

Collection of useful helper functions when trying to determine module type (CommonJS or AMD) properties of an AST node.


Version published
Weekly downloads
1.7M
increased by0.24%
Maintainers
3
Install size
11.5 kB
Created
Weekly downloads
 

Readme

Source

ast-module-types

CI npm version npm downloads

Collection of useful helper functions when trying to determine module type (CommonJS or AMD) properties of an AST node.

AST checks are based on the Esprima (Spidermonkey) format

npm install ast-module-types

API

Each of these takes in a single AST node argument and returns a boolean.

  • isDefineAMD: if node matches any form of an AMD define function call
  • isRequire: if node matches a require function all (declaring a dependency)
  • isTopLevelRequire: if node matches a require at the very top of the file.
  • isAMDDriverScriptRequire: if node matches an AMD driver script's require call require([deps], function)
  • isExports: if the node matches CommonJS module.exports or exports (defining a module)

Detecting the various forms of defining an AMD module

  • isNamedForm: if the node is a define call of the form: define('name', [deps], func)
  • isDependencyForm: if the node is a define call of the form: define([deps], func)
  • isFactoryForm: if the node is a define call of the form: define(func(require))
  • isNoDependencyForm: if the node is a define call of the form: define({})
  • isREMForm: if the node matches the form: define(function(require, exports, module){});

ES6 Types

All types abide by the EStree spec

  • isES6Import: if the node is any of the es6 import forms
  • isES6Export: if the node is of any es6 export forms

Usage

const types = require('ast-module-types');

// Assume node is some node of an AST that you parsed using esprima or esprima-fb
// ...

console.log(types.isDefineAMD(node));

License

MIT

Keywords

FAQs

Last updated on 09 Apr 2024

Did you know?

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

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc