0.0.1 • Published 7 years ago

reshape-cli v0.0.1

Weekly downloads
4
License
MIT
Repository
github
Last release
7 years ago

reshape-cli

Simple CLI for reshape

nodeNPM versionTrasiv Build StatusAppVeyor Build StatusCoveralls StatusDependency StatusStandard Code Style

Install

npm install --global reshape-cli

Usage

$ reshape --help

  Usage
  reshape [-o output-file/directory|-r] [-i input-file/directory] [--config|-c path/to/file/config] [--use|-u plugin]

  Options
  --config,  -c Path to JS file                    [string]
  --output,  -o Output html file/folder result     [required]
  --input,   -i Input html file/folder             [required]
  --use,     -u reshape plugin name                [string]
  --replace, -r Replace input file(s)              [boolean]
  --help,    -h Show help                          [boolean]
  --version, -v Show version number                [boolean]

Config

Automatically loads plug-ins with configuration from package.json using post-load-plugins

package.json

{
  "name": "my project",
  "dependencies": {
    "reshape-include": "^1.0.2"
  },
  "reshape": {
    "include": {
      "root": "./"
    }
  }
}

Sample example

  1. Create config in package.json

    {
      "name": "my project",
      "dependencies": {
        "reshape-include": "^1.0.2"
      },
      "reshape": {
        "include": {
          "root": "./"
        }
      }
    }
  2. Create index.html

    <p>Here's my partial:</p>
    <include src='_partial.html'></include>
    <p>after the partial</p>
  3. Create _partial.html

    <strong>hello from the partial!</strong>
  4. Run the command in the terminal

    $ reshape -i path/to/input/index.html -o pat/to/output/result.html

    Will be automatically found plugin reshape-include assembled configuration for it { "root": "./"} and it will be initialized.

  5. Enjoy result.html

    <p>Here's my partial:</p>
    <strong>hello from the partial!</strong>
    <p>after the partial</p>

Options

config

config.js

module.exports = {
  parser: require('sugarml'),
  plugins: {
    include: {
      root: './'
    }
  }
};
$ reshape -o output.html -i input.html -c config.js

--

use

$ reshape 
  -o output.html 
  -i input.html 
  -c config.js
  -u reshape-custom-elements

--

dir

$ reshape -o outputFolder/ -i inputFolder/*.html
$ reshape -o outputFolder/ -i inputFolder/**/*.html

--

replace

$ reshape -i input.html -r
$ reshape -i inputFolder/*.html -r

License MIT