Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wavesoft/js-inline-loader
This webpack loader enables inlining functions from other modules
https://github.com/wavesoft/js-inline-loader
Last synced: about 2 months ago
JSON representation
This webpack loader enables inlining functions from other modules
- Host: GitHub
- URL: https://github.com/wavesoft/js-inline-loader
- Owner: wavesoft
- License: apache-2.0
- Created: 2016-11-06T22:35:39.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2016-11-07T02:06:50.000Z (about 8 years ago)
- Last Synced: 2024-10-31T21:04:06.021Z (2 months ago)
- Language: JavaScript
- Size: 30.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# js-inline-loader
[](https://www.npmjs.com/package/js-inline-loader)
A webpack loader than enables inlining functions from other modules
## Usage
Create a node module as you would normally do:
```js
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:
```js
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:
```js
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.
```js
import { otherFunction } from 'path/to/module';
module.exports = {
otherFunction
}
```
### Works
You can use the classic ES6 export syntax:
```js
// 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:
```js
// 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.