Code Monkey home page Code Monkey logo

babel-plugin-undebug's Introduction

babel-plugin-undebug

Build Coverage Downloads Size

Babel plugin to remove debug from code.

Contents

What is this?

This package is a Babel plugin to remove debug from code.

When should I use this?

This package is useful when debug is used to debug development code but can be stripped in production. An example is micromark, which is a complex state machine that can be plugged into with extensions but it’s also supposed to be small in browsers.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install babel-plugin-undebug

In Deno with esm.sh:

import babelPluginUndebug from 'https://esm.sh/babel-plugin-undebug@2'

In browsers with esm.sh:

<script type="module">
  import babelPluginUndebug from 'https://esm.sh/babel-plugin-undebug@2?bundle'
</script>

Use

example.js:

const debug = require('debug')('math')

let value = 1
debug('Value was %d', value)
value++
debug('Now we have %d', value)

Then (with @babel/cli and @babel/core installed):

babel example.js --plugins babel-plugin-undebug

Yields:

let value = 1;
value++;

API

This package exports no identifiers. The default export is babelPluginUndebug.

babelPluginUndebug

Plugin to remove debug from code. See Babel’s documentation on how to use Babel plugins.

Syntax tree

This package operates on the Babel (JavaScript) AST.

  • looks for ESM (import) and CJS (require) loading 'debug'
  • looks for code calling that function and assigning it, whether createDebug (const createDebug = require('debug'), d = createDebug('math')) or direct use (const d = require('debug')('math'))
  • looks for calls of those assigned identifiers and remove whole debug calls, so side effects (d(value++)) will be dropped

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer

babel-plugin-undebug's People

Contributors

wooorm avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.