babel-plugin-annotate-pure-calls

This plugins helps with annotating top level functions calls with #__PURE__ comment.

Github stars Tracking Chart

babel-plugin-annotate-pure-calls

npm version
Build Status
npm

This plugins helps with automatic #__PURE__ annotation insertion. It add the comment to
top level call expressions and new expressions in assignment contexts (those are considered by the
plugin as side effect free). This helps UglifyJS to perform dead code
elimination more efficiently and therefore reduces the bundle sizes for the consumers.

NOTE: It might break your code, so the caution is advised. Target audience for the plugin are libraries, which in
vast major of use cases do not introduce side effects in top level calls. That doesn't mean that application bundles
cannot benefit from the plugin.

Pure calls

// pure call
var inc = add(1)

// clearly impure - no assignment context
mutate({ prop: 'value' })

Top level calls

Top level call (in terms of this plugin) is one that gets executed during script initialization. So it is every call
located at the root of a file, but also a call in an IIFE that gets executed at startup (including nested ones).

var a = topLevelCall()

b = function() {
  noTopLevelCall()
}

topLevelIIFEs = (function() {
  var c = (function() {
    var d = (function() {
      var e = topLevelCall()
    })()
  })()
})()

Installation

npm install --save-dev babel-plugin-annotate-pure-calls

Usage

.babelrc

{
  "plugins": ["annotate-pure-calls"]
}

Via CLI

babel --plugins annotate-pure-calls script.js

Via Node API

require('babel-core').transform('var inc = add(1)', {
  plugins: ['annotate-pure-calls'],
})

Usage with babel@6

The plugin works with babel@6, you might see unmet peer dependency warning though. If you want to get rid of it, please
install @babel/core@6.0.0-bridge.1.

Similar projects

Main metrics

Overview
Name With OwnerAndarist/babel-plugin-annotate-pure-calls
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 1)
Platform
License:
所有者活动
Created At2017-09-22 07:16:22
Pushed At2025-01-07 09:38:38
Last Commit At
Release Count9
Last Release Namev0.5.0 (Posted on 2025-01-07 10:37:54)
First Release Namev0.1.0 (Posted on 2017-09-24 01:22:14)
用户参与
Stargazers Count92
Watchers Count1
Fork Count7
Commits Count52
Has Issues Enabled
Issues Count11
Issue Open Count5
Pull Requests Count6
Pull Requests Open Count0
Pull Requests Close Count0
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private