FLIPS

Flips directory structure

INSTALLATION

npm install -g flips

USAGE

Command Line

You need .flipsrc file to tell flips which path to be flipped. The flips file contains Object with key of path to be flipped and value of path to be flipped to.

For example, if you have a directory structure like this:

./
  README.md
  package.json

Then you write a flips file like this:

{
  "README.md": "DON'T README.md",
  "package.json": "fake-package.json"
}

On that directory, run:

flips

The you will have this:

./
  DON'T README.md
  fake-package.json

And the flips file will be flipped too:

{
  "DON'T README.md": "README.md",
  "fake-package.json": "package.json"
}

Script

You can use flips as a requirable module too. Flips exports a function that take an object like that in flips file. It return a promise that resolve an object with two field, the key-value pair before flipping and key-value pair after flipping.

Example:

const flips = require('flips');

const flipPaths = {
  "README.md": "DON'T README.md",
  "package.json": "fake-package.json"
};

flips(flipPaths)
  .then(result => {
    console.log(result);
  });

The output will be:

{
  before: {
    "README.md": "DON'T README.md",
    "package.json": "fake-package.json"
  },
  after: {
    "DON'T README.md": "README.md",
    "fake-package.json": "package.json"
  }
}

CHANGES

Now flips have two flip mode: mirror flip and single flip.

• single flip is just flip the directory structure to another path.
• mirror flip is flip the directory with another directory.

You don't need to specify which mode to be used. It will automatically do single or mirror mode by detecting whether the destination directory is empty. If it is empty, flips just move the source directory. If not, flips flips those directory.

LICENSE

MIT