Nerds Publishing Monstrosities
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    string-to-jsifypublic

    Synopsis

    string-to-jsify is a browserify transform that allows you to load arbitrary text files as node modules.

    This library uses browserify-transform-tools, so you can also supply the configuration by adding a string-to-jsify field to your project's package.json file.

    stability 3 - stable license - Unlicense Flattr this

    Build Status Coverage Status Dependencies

    NPM status

    Install

    Node.js

    With NPM

    npm install string-to-jsify

    From source

    git clone https://github.com/pluma/string-to-jsify.git
    cd string-to-jsify
    npm install
    make test

    Basic usage example

    example/partial.html

    <blink>wat</blink>

    example/app.js

    var partial = require('./partial.html');
    // ... 

    Usage

    var browserify = require('browserify'),
        str2jsify = require('string-to-jsify'),
        b = browserify('./example/app.js');
     
    b.transform(str2jsify.configure({extensions: '.html'}));
    b.bundle().pipe(require('fs').createWriteStream('bundle.js'));

    Usage with package.json

    package.json

    {
        "name": "my-awesome-project",
        "devDependencies": {
            "browserify": "*",
            "string-to-jsify": "*"
        },
        "string-to-jsify": {
            "extensions": [".html", ".txt"],
            "patterns": ["/^README(\\.[a-z]+)?$/i", "[a-z]+\\.md"]
        }
    }

    Usage (API)

    var browserify = require('browserify'),
        str2jsify = require('string-to-jsify'),
        b = browserify('./example/app.js');
     
    b.transform(str2jsify);
    b.bundle().pipe(require('fs').createWriteStream('bundle.js'));

    Usage (Shell)

    browserify -t string-to-jsify ./example/app.js > bundle.js

    API

    str2jsify.configure(opts)

    Creates a browserify transform that will only be applied to files with names matching any of the given options (if the value is not an array, it will be wrapped in one automatically).

    opts.patterns

    An array of regular expressions or strings representing regular expressions that will be applied to the filename, e.g. /^text-/i, "/^text-/i" or simply "^text-".

    opts.extensions

    An array of file extensions, e.g. .txt or .html.

    opts.filenames

    An array of file names, e.g. README.md.

    Unlicense

    This is free and unencumbered public domain software. For more information, see http://unlicense.org/ or the accompanying UNLICENSE file.

    install

    npm i string-to-jsify

    Downloadslast 7 days

    6

    version

    0.4.0

    license

    none

    repository

    github.com

    last publish

    collaborators

    • avatar