Git Product home page Git Product logo

pre-proc-loader's Introduction

pre-proc-loader

npm GitHub issues David license

preProc loader module for webpack.

The super simple preprocessor for front-end development.
See preProc for options and more information about preProc.

Installation

npm install --save-dev pre-proc-loader pre-proc

Usage

Documentation:

For example:

// app.js

// The line below is removed.
TEST_MODE = true; // [DEBUG/]

// The HTML code for "button A" is picked from buttons.html file, and it inserted to "panel".
var buttonA = require('./buttons.html?tag=BUTTON-A'); // `tag` argument for pickTag method.
document.getElementById('panel').innerHTML = buttonA;
// webpack.config.js
module.exports = {
  entry: './app.js',
  output: {
    filename: 'bundle.js'
  },
  module: {
    rules: [
      {
        test: /\/develop\//,
        loader: 'pre-proc-loader',
        // Remove `DEBUG` contents from all files in `dir1` directory and all JS files.
        options: {removeTag: {tag: 'DEBUG', pathTest: ['/path/to/dir1', /\.js$/]}}
      },
      {
        test: /\.html$/,
        loader: 'pre-proc-loader',
        options: {pickTag: {}} // `tag` is specified via query string
      }
    ]
  }
};

Options

You can specify options via query parameters or an options (or preProcLoader for webpack v1) object in webpack configuration.

removeTag

If removeTag option is specified, call removeTag method with current content.

You can specify an object that has properties as arguments of the method.
Following properties are accepted:

  • tag
  • pathTest

Also, you can specify common values for the arguments into upper layer. That is, the options.pathTest is used when options.removeTag.pathTest is not specified.
And also, you can specify values for tag argument via a query string with the resource file like ?tag=TAG, and it is the first-priority value. An array also can be specified, like ?tag[]=TAG1,tag[]=TAG2, ?{tag:[TAG1,TAG2]} or ?tag=TAG1%2CTAG2 (or ?tag=TAG1%20TAG2, i.e. the values separated by space or comma).

If the pathTest is specified, current source file path is tested with the pathTest.

For example:

// webpack.config.js
// ...
// pre-proc-loader options
{
  tag: 'DEBUG',           // common
  pathTest: '/path/to',   // common

  removeTag: {},                            // tag: 'DEBUG', pathTest: '/path/to'
  replaceTag: {tag: ['SPEC1', 'SPEC2']},    // tag: ['SPEC1', 'SPEC2'], pathTest: '/path/to'
  pickTag: {}                               // tag: 'DEBUG', pathTest: '/path/to'
}
// For `file.html?tag=SPEC3` resource, the `SPEC3` is used for all method.

replaceTag

If replaceTag option is specified, call replaceTag method with current content.

You can specify arguments by the same way as the removeTag.
Following arguments are accepted:

  • tag
  • pathTest
  • replacement (As options.replaceTag.replacement, not options.replacement)

pickTag

If pickTag option is specified, call pickTag method with current content.

You can specify arguments by the same way as the removeTag.
Following arguments are accepted:

  • tag
  • allowErrors (As options.pickTag.allowErrors, not options.allowErrors)

When the tag was not found, this method throws an error by default. If true is specified for allowErrors, it returns null (not a string) without error. It is useful for handling unknown source code.
Also, you can specify options to call multiple methods, and other methods are not called when the tag was not found.

toCode

Type: boolean
Default: false

When the content is not JavaScript code (e.g. HTML, CSS, JSON, etc.), a loader that is specified as a final loader has to convert the content to JavaScript code and output it to allow another code to import the content.
If true is specified for toCode option, the content is converted to JavaScript code.
If the loader is specified as not a final loader, this option is ignored (i.e. the content is not converted, and it is passed to next loader).

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.