slugify-files's Introduction

slugify-files

A simple CL tool to slugify files (kebab-case)

"this Filename NEEDS cleaning.png" -> "this-filename-needs-cleaning.png"

CHANGELOG

INSTALL

$ npm install slugify-files

USAGE

var slugify = require('slugify-files');

slugify(['*.png'], function (err, sluggedFiles) {
  sluggedFiles.forEach(function(file, idx)) {
    console.log(file.old, 'renamed to', file.new);
  }
});

CLI

$ npm install --global slugify-files

$ slugify --help

  Usage
    $ slugify <source>

  Example
    $ slugify '*.tmp'

  <source> can contain globs if quoted

API

slugify(source, function(err, sluggedFiles){});

source: glob
err: error
sluggedFiles: Array of slugged files objects. Each has two keys: old and new

CONTRIBUTE

$ git clone [email protected]:raiseandfall/slugify-files.git && cd slugify-files

$ npm i

Run

$ npm run dev

Run tests

$ npm run test

LICENSE

MIT

slugify-files's People

Contributors

Stargazers

Watchers

slugify-files's Issues

Add option for recursive mode

Breaks folder(s) when applied recursive

Add dashes when converting PascalCase to kebab-case

I'd like to request mixed-case file names like "ThroughTheLookingGlass.txt" be renamed with dashes between capitalized words: "through-the-looking-glass.txt".

Recommend Projects