ning5129 / mip-extension-optimizer

MIP Extension Optimizer

mip-extension-optimizer

MIP Extension Optimizer

CLI

install

Install with npm i -g

$ npm i -g mip-extension-optimizer

use

Call mip-extension-optimise command to optimise MIP extensions.

format

mip-extension-optimise <extensions-path> [-o output-path] [extension, extension ...]

example

$ mip-extension-optimise mip-extensions/src -o mip-extensions-dist
$ mip-extension-optimise mip-extensions/src -o mip-extensions-dist mip-fixed

API

This package provides some APIs for MIP extension infomation.

import

$ npm i mip-extension-optimizer --save

load all extensions from directory

var extOptimizer = require('mip-extension-optimizer');

extOptimizer.load('/your/extensions/root/directory').then(
    function (extensions) {
        extensions.forEach(function (extension) {
            // extension.info has some data from package.json and README.md, such as:
            // ================
            // extension.info.name (parse from package.json)
            // extension.info.version (parse from package.json)
            // extension.info.props (parse from README.md)
            // extension.info.examples (parse from README.md)
            // extension.info.deps (parse from README.md)
        });
    }
);

load single extension

var extOptimizer = require('mip-extension-optimizer');
var extension = new extOptimizer.Extension('/your/extension/directory');

// extension.info has some data from package.json and README.md, such as:
// ================
// extension.info.name (parse from package.json)
// extension.info.version (parse from package.json)
// extension.info.props (parse from README.md)
// extension.info.examples (parse from README.md)
// extension.info.deps (parse from README.md)

use build result in program

var extOptimizer = require('mip-extension-optimizer');
var extension = new extOptimizer.Extension('/your/extension/directory');
var builder = extension.createBuilder();

builder.process().then(function () {
    // get all files of extension, and traverse
    var files = getFiles();
    files.forEach(function (file) {
        // ...
    });

    // get file by path (relative)
    var file = builder.getFile('extension-name/main.js');

    // get file content
    file.getData();
});