js-inline-loader

    0.2.2 • Public • Published

    js-inline-loader

    Module Version

    A webpack loader than enables inlining functions from other modules

    Usage

    Create a node module as you would normally do:

    export function staticDefinition() {
      return {a: '1', b: '2'};
    }
     
    export function expensiveCalculations(arg1, arg2) {
      ...
    }

    Then inline the functions instead of calling them, using the %inline macro:

    function doSomeWork() {
     
      // Inline the return statement of a function
      const definitions = %inline('path/to/module').staticDefinition();
     
      ...
     
      // Inline the function body
      %inline('path/to/module').expensiveCalculations(arg1, arg2);
     
      ...
    }

    The webpack loader will automagically expand the contents of the function you are in-lining in the location of the inline macro.

    Installation

    First install the node module:

    npm install --save-dev js-inline-loader
    

    Then install it as a preloader on webpack:

      module: {
        preLoaders: [
          {
            test: /.js$/,
            exclude: /node_modules/,
            loader: 'js-inline-loader'
          }
        ]
      }

    Caveats

    The loader will parse the javascript AST of the refered module and identify all the functions exported by it. However not all expressions are yet supported. Below you can see what is currently supported:

    Will NOT work

    The loader will not detect exported functions that were previously imported by other modules.

    import { otherFunction } from 'path/to/module';
     
    module.exports = {
      otherFunction
    }

    Works

    You can use the classic ES6 export syntax:

    // As an exported function
    export function exportedFunction() {
      ...
    }
     
    // As a static function on the default class
    export default class {
      static exportedFunction2() {
        ...
      }
    }

    Or the regular CommonJs syntax:

    // Function definition
    function exportedFunction() {
     
    }
     
    // Or function expression assigned to a variable
    var exportedFunction2 = function() {
     
    }
     
    // Make sure to export your functions
    module.exports = {
      exportedFunction,
      exportedFunction2,
     
      // You can also define functions in the object you export
      exportedFunction3() {
        ...
      }
    };

    License

    Copyright (C) 2015-2016 Ioannis Charalampidis

    Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

    Install

    npm i js-inline-loader

    DownloadsWeekly Downloads

    6

    Version

    0.2.2

    License

    Apache-2.0

    Last publish

    Collaborators

    • icharala