Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

grunt-bookmarklet-wrapper

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

grunt-bookmarklet-wrapper

Grunt task to urlencode, concatenate and wrap JavaScript files to prepare for execution as a bookmarklet.

  • 1.2.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Build Status npm version

grunt-bookmarklet-wrapper

Grunt task to urlencode, concatenate and wrap JavaScript files to prepare for execution as a bookmarklet.

There is also a grunt plugin grunt-bookmarklet-thingy, but it is has no documentation and I have no idea what it does exactly. Also I needed certain features so I wrote this new plugin.

Getting Started

This plugin requires Grunt ~1.0.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-bookmarklet-wrapper --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-bookmarklet-wrapper');

Although I recommend using load-grunt-tasks

The "bookmarklet_wrapper" task

Overview

In your project's Gruntfile, add a section named bookmarklet_wrapper to the data object passed into grunt.initConfig().

grunt.initConfig({
  bookmarklet_wrapper: {
    options: {
      // Task-specific options go here.
      banner: '\n/*! <%= pkg.name %> by <%= pkg.author.name %> */'
    },
    your_target: {
      // Target-specific file lists and/or options go here.
      files: {
        'foo-bookmarklet.js': ['foo1.js', 'foo2.js']
      }
    },
  },
});

Example output:

javascript:(function(){alert('foo%20bar');})();

Properties

files

A key/value pair is accepted. The key is the path to the output file as a String, the value an array of Strings, the paths of the input files that will be urlencoded and concatenated.

Options

options.banner

Type: String Default value: ''

A string value that is prepended as banner. The banner is prepended to the generated code, and should be a comment with an end-tag or otherwise work well with the generated, escaped bookmarklet.

options.banner_prefix = '/*! Bookmarklet <%= pkg.version %> */'

Example output:

javascript:(function(){/*! Bookmarklet 1.0.0 */alert('foo%20bar');})();
options.asJson

Type: Boolean Default value: false

Generate a JSON file that contains an object with the bookmarklet stored in the attribute href.

Example output:

{"href": "javascript:(function(){alert('foo%20bar');})();"}

Usage Examples

Default Options

In this example, the fixture files are urlencoded and concatenated. Then they are wrapped in an script-targed url IIFE. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be javascript:(function(){Testing1%202%203})();.

grunt.initConfig({
    bookmarklet_wrapper: {
        default_options: {
            files: {
                'tmp/default_options': ['test/fixtures/testing', 'test/fixtures/123']
            }
        }
    }
});
Custom Options

In this example, an option is added to append a banner to the processed code.

grunt.initConfig({
    bookmarklet_wrapper: {
        custom_options: {
            options: {
                banner: '\r\n/*! <%= pkg.name %> by <%= pkg.author.name %> */'
            },
            files: {
                'tmp/custom_options': ['test/fixtures/testing', 'test/fixtures/123']
            }
        }
    }
});

Contributing

Follow the jshintrc settings for the code style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • 2016-04-23 v1.2.0 Merged PR from git-j, updating dependencies and modifying banner to work as a prefix.
  • 2015-04-25 v1.0.0 Extended and successfully ran unit tests. It's not required to remove inline comments (//), code after line breaks is still executed. There doesn't seem to be a way to programmatically test script-targeted urls, but manual tests were successful.
  • 2015-04-25 v0.2.0 Minor fixes, documentation updates
  • 2015-04-25 v0.1.0 Initial release

Keywords

FAQs

Package last updated on 23 Apr 2016

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc