node-rename
TypeScript icon, indicating that this package has built-in type declarations

1.1.5 • Public • Published

node-rename · GitHub license GitHub code size in bytes

Tiny NodeJS package for renaming files/folders to lower, upper, camel, pascal, snake, kebab, train, random case types. Also with cli support.

Installation

  • Cli usage npm i node-rename -g
  • Node package usage npm i node-rename

CLI Examples

Cli help to get full documentation:

node-rename --help

Show files/folders by pattern without renaming them:

node-rename --pattern "./src/**"

Then if you want to rename all files/folders within src directory to kebab case add case option:

node-rename --pattern "./src/**" --type kebab

Add "--log" option to see renaming result without renaming

node-rename --pattern "./src/**" --type kebab --log

Custom renaming config

  1. Init config file node-rename init
  2. Set up config file
  3. Run the config:
node-rename --pattern "./src/**" --config "./rename.config.js" --log

Node package usage

Case type functions:

import { camelCase, kebabCase, lowerCase, pascalCase, randomCase, snakeCase, trainCase, upperCase } from 'node-rename';

upperCase('some sentence!'); // "SOME SENTENCE!"

Rename files and folders:

import { nodeRename } from 'node-rename';

nodeRename({
    pattern: 'src/**/*.ts',
    type: 'pascal', // type is optional, type: undefined, only returns files to rename
});

// Or cusom rename config
nodeRename({
    pattern: 'src/**/*.ts',
    config: (name: string) => name.replace('-', ''),
});

Package Sidebar

Install

npm i node-rename

Weekly Downloads

29

Version

1.1.5

License

MIT

Unpacked Size

23.4 kB

Total Files

16

Last publish

Collaborators

  • zemil