unified

Project: vfile/vfile-rename

Package: vfile-rename@2.0.1

  1. vfile utility to rename the path parts of a file
  1. util 145
  2. utility 141
  3. file 33
  4. vfile 16
  5. virtual 16
  6. vfile-util 14
  7. check 11
  8. move 3

vfile-rename

Build Coverage Downloads Size Sponsors Backers Chat

vfile utility to rename a file.

Contents

What is this?

This package is a utility to add different data-driven ways to rename files.

When should I use this?

This package is mostly useful when creating higher level tools that include support for renaming files to end users.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install vfile-rename

In Deno with esm.sh:

import {rename} from 'https://esm.sh/vfile-rename@3'

In browsers with esm.sh:

<script type="module">
  import {rename} from 'https://esm.sh/vfile-rename@3?bundle'
</script>

Use

import {VFile} from 'vfile'
import {rename} from 'vfile-rename'

const file = new VFile({path: 'readme.md'})
file.path // => readme.md

// Set extname:
rename(file, '.html')
file.path // => readme.html

// Set basename:
rename(file, 'main.md')
file.path // => main.md

// Set path properties:
rename(file, {stem: 'index'})
file.path // => index.md

// Change path properties:
rename(file, {stem: {suffix: '.bak'}})
file.path // => index.bak.md

// All together:
rename(file, ['readme.md', '.htm', {stem: 'index', extname: {suffix: 'l'}}])
file.path // => index.html

API

This package exports the identifiers convert and rename. There is no default export.

convert(renames)

Create a function (the move) from renames, that when given a file changes its path properties.

Parameters
Returns

A move (Move).

rename(file, renames)

Rename a file.

When given something, returns a vfile from that, and changes its path properties.

Parameters
Returns

Nothing (undefined).

Move

Move (TypeScript type).

Parameters
Returns

Nothing (undefined).

Renames

Rename instructions (TypeScript type).

Type
type Renames = Array<Move | Spec | string> | Move | Spec | string

Spec

An object describing path properties to values (TypeScript type).

For each property in spec, if its value is string, the value of the path property on the given file is set. If the value is object, it can have a prefix or suffix key, the value of the path property on the given file is prefixed and/or suffixed.

Fields

SpecAffix

Define prepending and/or appending (TypeScript type).

Fields

Types

This package is fully typed with TypeScript. It exports the types Move, Renames, Spec, and SpecAffix.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, vfile-rename@^3, compatible with Node.js 16.

Security

Use of vfile-rename is safe.

Contribute

See contributing.md in vfile/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer