npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@intouchg/rename-files

v0.0.2

Published

Simple Node CLI to rename, move, and delete files using a config file

Downloads

3

Readme

@intouchg/rename-files

Simple Node CLI to rename, move, and delete files using a config file

Getting Started

  1. Install dependencies
yarn add --dev @intouchg/rename-files
  1. Setup a .rename.js config file

  2. Run the CLI, perhaps as part of an npm script after a build

rename-files

Configuration

Create a .rename.js config file in the project root.

// .rename.js
module.exports = {
	context: 'dist',
	patterns: [
		{
			from: '404.html',
			to: 'page-not-found.html',
		},
		{
			from: '/images/icons/*.png',
			to: '/images/*-icon.png',
		},
		{
			delete: '/data/**/*.json'
		},
		{
			from: '/images/**/',
			to: (filepath) => {
				const files = fs.readdirSync(filepath)
				if (files.length > 100) return '/images/100/*'
				return filepath
			}
		},
	],
}

Options

context - Optional. This is the base filepath that all patterns paths will be resolved against. The context path may be absolute or relative to the process.cwd(). Defaults to process.cwd().

cleanEmptyDirs - Optional. This boolean controls if the CLI deletes all empty directories under the context path once all file renaming and deleting has been completed. Defaults to true.

Patterns

patterns - Required. This array contains all pattern objects which control renaming and deleting files.

To delete a file, create a pattern object with a delete path, relative to the context. The delete filepath supports full glob pattern matching.

To rename or move a file, create a pattern object with from and to paths, relative to the context.

The from filepath supports full glob pattern matching.

The to filepath supports a single wildcard character * which will be replaced by everything that was magically matched by glob. This is suitable for simple glob-based replacements:

module.exports = {
	patterns: [
		{
			from: '/texts/**/*.txt',
			to: '/user/documents/*.rtf',
		}
	]
}

For more complex replacements, the to property can also be a function that receives the matched filepath from glob. You can return a string from the to function and the CLI will treat it like any other pattern object - or you can take whatever operations you want on the provided filepath and return void:

module.exports = {
	patterns: [
		{
			from: '/**/*.js',
			to: (filepath) => {
				console.log(filepath)
				return '/scripts/*.jsx'
			}
		},
		{
			from: '/**/',
			to: (filepath) => {
				const files = fs.readDirSync(filepath)
				console.log(files.length)
			}
		},
	]
}