vfile-rename
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatvfile
vfile utility to rename a file.Contents
* [`convert(renames)`](#convertrenames)
* [`rename(file, renames)`](#renamefile-renames)
* [`Move`](#move)
* [`Renames`](#renames)
* [`Spec`](#spec)
* [`SpecAffix`](#specaffix)
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 onlyesm. In Node.js (version 16+), install with npm:npm install vfile-rename
In Deno with
esm.sh
esmsh:import {rename} from 'https://esm.sh/vfile-rename@3'
In browsers with
esm.sh
esmsh:<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 identifiersconvert
api-convert and
rename
api-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
renames
(Renames
api-renames, optional)
— rename instructions
Returns
A move (Move
api-move).rename(file, renames)
Rename a file.When given something, returns a vfile from that, and changes its path properties.
Parameters
file
(VFile
)
— file to rename
renames
(Renames
api-renames, optional)
— rename instructions
Returns
Nothing (undefined
).Move
Move (TypeScript type).Parameters
— file to change
Returns
Nothing (undefined
).Renames
Rename instructions (TypeScript type).- if the bound rename is a normal string starting with a dot (
.
), sets
`file.extname`
- otherwise, if the bound rename is a normal string, sets
file.basename
- otherwise, if the bound test is an array, all renames in it are
performed
- otherwise, if the bound rename is an object, renames according to the
[`Spec`][api-spec]
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
basename
(SpecAffix
api-spec-affix orstring
, optional)
— change basename (`'index.min.js'`).
dirname
(SpecAffix
api-spec-affix orstring
, optional)
— change dirname (`'~'`).
extname
(SpecAffix
api-spec-affix orstring
, optional)
— change extname (`'.js'`).
path
(SpecAffix
api-spec-affix,URL
, orstring
, optional)
— change file path (`'~/index.min.js'`).
stem
(SpecAffix
api-spec-affix orstring
, optional)
— change stem (`'index.min'`).
SpecAffix
Define prepending and/or appending (TypeScript type).Fields
prefix
(string
, optional)
— substring to prepend before the field
suffix
(string
, optional)
— substring to append after the field.
Types
This package is fully typed with TypeScript. It exports the typesMove
api-move, Renames
api-renames,
Spec
api-spec, and SpecAffix
api-spec-affix.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 ofvfile-rename
is safe.Contribute
Seecontributing.md
contributing in vfile/.github
health for ways to
get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.