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

@foxitsoftware/gulp-merge-addon

v0.7.7

Published

A gulp plugin for merge multiple UIExtension addons into single JS file

Downloads

888

Readme

gulp-merge-addon plugin

You can use this plugin to merge UIExtension addons in a project without webpack and then import them like modules.

Import Example

import TextObjectAddon from '@addons/text-object/addon.info.json';

Getting started

To begin, you'll need to install gulp and this plugin:

npm i -D gulp @foxitsoftware/gulp-merge-addon

Configuration

gulfile.js

Add gulpfile.js in the root directory of your project if it has not been created:

const gulp = require('gulp');
const mergeAddon = require('@foxitsoftware/gulp-merge-addon');

const libPath = 'path/to/the/sdk/lib';

gulp.task('merge-addon', () => {
    return gulp.src([libPath + 'uix-addons/*/addon.info.json'])
    .pipe(mergeAddon({
        library: 'UIExtensionAddons',
        filename: 'merged-addons.js'
    }))
    .pipe(gulp.dest('./dist/'));
});

package.json

Add the following command in your package.json

{
    "scripts": {
        "merge-addon": "gulp merge-addon"
    }
}

Merge Addons

Now, you can merge UIExtension's addons by this command in the root directory of your project:

npm run merge-addon

Once done, the file /dist/merged-addons.js will be created.

Import merged addons

Now you can import addons like using normal modules:

import addons from './dist/merged-addons';

var pdfui = new UIExtension.PDFUI({
    addons: addons
    // ignored other irrelevant options
});

Options

  • options.library Type: string default: UIExtensionAddons All addons will be merged into a single UMD format bundle, and the value exports from the entry point(addons.js) will be assigned into the global scope via the name provided from this option. For more details, refer to webpack documentation https://webpack.js.org/configuration/output/#outputlibrary
  • options.filename Type: string default: merged-addons.js The file name of the bundle generated from this plugin;
  • progress Type: boolean default: true Report the progress information in your terminal.
  • watch Type: boolean default: false Turn on/off the watch mode. This mean that after the first time merge, this plugin will continue to watch for the changes in any of the resolved addon files.
  • watchOptions Type: object default: null Please refer to the webpack's documentation https://webpack.js.org/configuration/watch/#watchoptions
  • lazyInit Type: boolean default: false Setting this option value to true will generate a bundle that supports lazy initialization. This bundle exports a function instead of an array of addon classes, so that all addon classes can be initialized inside the PDFUI regardless of the loading order.