Giter VIP home page Giter VIP logo

js-inline-loader's Introduction

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.

js-inline-loader's People

Contributors

wavesoft avatar

Watchers

James Cloos avatar  avatar  avatar

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.