This repository has been archived by the owner. It is now read-only.
A MetalSmith plugin for moving the full contents of a directory up one or more levels.
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
eg
lib
test
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
package.json

README.md

metalsmith-move-up

travis git npm standard nearform

Metalsmith MoveUp is a MetalSmith plugin for moving the full contents of a directory up one or more levels. By default this plugin will move everything in your destination directory up one. Metalsmith MoveUp supports multiple transforms, which are processed in the order they are provided, allowing for more complex transforms to be done with a single call.

For globbing support we use minimatch. To make matching easier we set dot matching to true meaning a global match can be done using a single globstar **. MiniMatch options can be provided as a global or on a per transform basis.

Installation

To install Metalsmith MoveUp, simply use npm:

npm install metalsmith-move-up --save

Usage

The example below can be found and ran from the examples folder; it demonstrates how to use Metalsmith MoveUp in a couple of different ways in a node.js app.

Javascript

'use strict'

var metalsmith = require('metalsmith'),
    moveUp = require('metalsmith-move-up')

// move everything in the build folder up one. The
// build folder always represents the root for operations.
metalsmith.use(moveUp())

// defaults are added as needed so input is easier. Input
// is simplified where possible. both lines will have a
// default .by of 1 and will use dot:true for mini-match.
metalsmith.use(moveUp('pages/*'))
metalsmith.use(moveUp({pattern: 'pages/*'}))

// multiple simple transforms are also supported.
metalsmith.use(moveUp([
  'lib/**',
  'test/*'
]))

// multiple, order specific, transforms can be done with one
// call. Each job only begins after the previous one finishes.
metalsmith.use(moveUp([
  '!*.css',
  'index.css'
]))

// the .by field moves everything N or as many times as
// possible. This means if a given match only has one path
// part, it will only be moved up one directory.
metalsmith.use(moveUp({
  pattern: 'pages/*',
  by: 2
}))

// globbing is supported via minimatch. default options for
// minimatch can be supplied at a global level using the .opts
// field. Transforms are added to the .transforms array, any
// transform that does not have a .opts field will get the
// global .opts value. This is a replace, not a merge.
metalsmith.use(moveUp({
  opts: {
    dot: false
  },
  transforms: [
    {pattern: 'pages/*', by: 2},
    {pattern: 'css/*', by: 2, opts: {dot: true}}
  ]
}))

Metalsmith JSON

{
  "source": "./src",
  "destination": "./dest",
  "plugins": {
    "metalsmith-move-up": {
      "opts": {"dot": "true"},
      "transforms": [
        {"pattern": "**", "by": "2"},
        {"pattern": "posts/*", "by": "2", "opts": {"dot": "false"}}
      ]
    }
  }
}

Transform

The transform object has three fields, if no transforms are passed a default pattern will be ran that pulls all applicable files and folders in the build directory up by one.

pattern

The glob pattern to use when locating files and directories for moving. See both minimatch for example patterns.

by

The maximum number of path parts to remove. Matches with less path segments than the count will have all of their segments removed, as such, they will end up in the root (destination) folder.

opts

The options to use with minimatch, order is field > global > default each overriding the last. Note that these options do not merge, they overwrite.

Contributing

Metalsmith MoveUp is an open project and encourages participation. If you feel you can help in any way, be it with examples, extra testing, or new features please be our guest.

See our Contribution Guide for information on obtaining the source and an overview of the tooling used.

License

Copyright Dean McDonnell 2015, Licensed under MIT