recursive-rename
[![Build Status](https://travis-ci.org/HeroProtagonist/recursive-rename.svg?branch=master)](https://travis-ci.org/HeroProtagonist/recursive-rename) [![Codecov](https://img.shields.io/codecov/c/github/HeroProtagonist/recursive-rename.svg)](https://codecov.
Last updated a year ago by heroprotagonist .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install recursive-rename -g
SYNC missed versions from official npm registry.

Recursive-Rename

Build Status Codecov NPM version

walter-white

Recursive rename is a simple tool used to manipulate file names.

It can be used from the command line or NodeJS.

Examples

CLI

rename jsx js

Rename all .jsx files to .js in current directory. By default node_modules and .git are excluded from the crawl. This can be overridden and/or extended.

rename jsx js --dry

Adding the dry flag will return the files that would be changed.

Node

Equivalent operations can be performed in Node

import Rename = 'recursive-rename'

const rename = new Rename({
  src: 'jsx',
  dest: 'js',
})

rename.dive()

Add dry option to get insight on the renaming process without performing it

rename.dive({
  dry: true,
})

Installation

yarn add recursive-rename

or

yarn global add recursive-rename

  • Global installation with expose the rename command

If you have not switched to yarn. Simply use npm

npm install recursive-rename

  • use -g flag for global installation

Usage

Comand Line

rename $SRC $DEST

$SRC will be the extensions that will be renamed to $DEST extension. These are required. If the path is not provided it will default to the current directory.

Optional flags

 --dry [if present the renaming will not occur, but a list of the changes that would occur are shown]
 --exclude [set to folder that should not be touched]
 --override [if present remove default excluded folders. These are .git and node_modules]
 --path [set to path of folder to rename if not targeting current directory]

Informational flags

--help
--version

Node

Using babel

import Rename from 'recursive-rename'

or

const Rename = require('recursive-rename')

Rename(options)

Create a new instance that will be used to traverse directory and perform renaming.

Options [object]
- src [string]: required
- dest [string]: required
- exclude [array]
- override [array]

Renaming

dive(options)

Once instantiated rename has the dive method. This will perform the crawl based on the options supplied to Rename constructor.

Options [object]
- dry [bool] (if present renaming will not occur and output will be list of what would)

Current Tags

  • 1.0.0                                ...           beta (3 years ago)
  • 4.0.0                                ...           latest (5 months ago)

6 Versions

  • 4.0.0                                ...           5 months ago
  • 3.0.0                                ...           a year ago
  • 2.0.0                                ...           3 years ago
  • 1.2.0 [deprecated]           ...           3 years ago
  • 1.1.0 [deprecated]           ...           3 years ago
  • 1.0.0 [deprecated]           ...           3 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 6
Dependencies (5)
Dev Dependencies (16)

Copyright 2014 - 2016 © taobao.org |