npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@fenixengine/rollup-plugin-jscc

v2.2.0

Published

Conditional comments and variable replacement for rollup, based on jscc

Downloads

53

Readme

rollup-plugin-jscc

npm Version Build Status AppVeyor Status Maintainability Test coverage License

Conditional compilation and compile-time variable replacement for Rollup.

rollup-plugin-jscc is not a transpiler, it is a wrapper of jscc, a tiny and powerful, language agnostic file preprocessor that uses JavaScript to transform text based on expressions at compile time.

With jscc, you have:

  • Conditional inclusion/exclusion of blocks, based on compile-time variables*
  • Compile-time variables with all the power of JavaScript expressions
  • Replacement of variables in the sources, by its value at compile-time
  • Sourcemap support, useful for JavaScript sources.
  • TypeScript v3 definitions

* This feature allows you the conditional declaration of ES6 imports (See the example).

Since jscc is a preprocessor, rollup-plugin-jscc is implemented as a file loader, so it runs before any transpiler and is invisible to them. This behavior allows you to use it in a wide range of file types but, if necessary, it can be used as a Rollup transformer instead of a loader.

NOTE

The removal of non-jscc comments is not included, but you can use rollup-plugin-cleanup, which brings compaction and normalization of lines in addition to the conditional removal of JS comments.

Support my Work

I'm a full-stack developer with more than 20 year of experience and I try to share most of my work for free and help others, but this takes a significant amount of time, effort and coffee so, if you like my work, please consider...

Of course, feedback, PRs, and stars are also welcome 🙃

Thanks for your support!

Install

npm i rollup-plugin-jscc -D
# or
yarn add rollup-plugin-jscc -D

rollup-plugin-jscc requires rollup v2.0 and node.js v10.12 or later.

Usage

rollup.config.js

import { rollup } from 'rollup'
import jscc from 'rollup-plugin-jscc'

export default {
  input: 'src/main.js',
  plugins: [
    jscc({
      values: { _APPNAME: 'My App', _DEBUG: 1 },
    }),
  ],
  //...other options
}

in your source:

/*#if _DEBUG
import mylib from 'mylib-debug';
//#else */
import mylib from 'mylib'
//#endif

mylib.log('Starting $_APPNAME v$_VERSION...')

output:

import mylib from 'mylib-debug'

mylib.log('Starting My App v1.0.0...')

That's it.

* jscc has two predefined memvars: _FILE and _VERSION, in addition to giving access to the environment variables through the nodejs proccess.env object.

Options

Plain JavaScript object, with all properties optional.

| Name | Type | Description | | --- | --- | --- | | asloader | boolean | If false, run the plugin as a transformer, otherwise run as loader (the default). | | escapeQuotes | string | String with the type of quotes to escape in the output of strings: 'single', 'double' or 'both'.Default nothing. | | keepLines | boolean | Preserves the empty lines of directives and blocks that were removed.Use this option with sourceMap:false if you are interested only in keeping the line numbering.Default false | | mapHires | boolean | Make a hi-res source-map, if sourceMap:true (the default).Default true | | prefixes | string | RegExp |Array<string|RegExp> | The start of a directive. That is the characters before the '#', usually the start of comments.Default ['//', '/*', '<!--'] (with one optional space after them). | | sourcemap | boolean | Must include a sourcemap?Should be the same value as the property sourcemap of the Rollup output.Default true | | mapContent | boolean | Include the original source in the sourcemap, if sourceMap:true (the default).Default true | | values | object | Plain object defining the variables used by jscc during the preprocessing.Default {} | | extensions | string | Array<string> | Array of strings that specifies the file extensions to process.Default ['js', 'jsx', 'ts', 'tsx', 'mjs', 'tag'] | | include | string | Array<string> | minimatch or array of minimatch patterns for paths that must be included in the processing. | | exclude | string | Array<string> | minimatch or array of minimatch patterns for paths that should be ignored. |

Directives

Please see the jscc wiki to know about directives used by jscc.

What's New

Please see the CHANGELOG.

License

The MIT License