vfile-rename

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

[vfile][vfile] utility to rename a file.

* What is this?
* When should I use this?
* Install
* Use
* API
* convert(renames)
* rename(file, renames)
* Move
* Renames
* Spec
* SpecAffix
* Types
* Compatibility
* Security
* Contribute
* License

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][esm].
In Node.js (version 16+), install with [npm][]:

``sh npm install vfile-rename`

In Deno with [esm.sh][esmsh]:

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

In browsers with [esm.sh][esmsh]:

`html`

`Use`

`js 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][api-convert] and [rename][api-rename]. There is no default export.

`$3`

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]).

`$3`

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).

`$3`

Move (TypeScript type).

###### Parameters

* file ([VFile][vfile]) — file to change

###### Returns

Nothing (undefined).

`$3`

Rename instructions (TypeScript type).

* if the bound rename is a normal string starting with a dot (.), setsfile.extname* otherwise, if the bound rename is a normal string, setsfile.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

`ts type Renames = Array | Move | Spec | string`

`$3`

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] or string, optional) — change basename ('index.min.js'). *dirname ([SpecAffix][api-spec-affix] or string, optional) — change dirname ('~'). *extname ([SpecAffix][api-spec-affix] or string, optional) — change extname ('.js'). *path ([SpecAffix][api-spec-affix], URL, or string, optional) — change file path ('~/index.min.js'). *stem ([SpecAffix][api-spec-affix] or string, optional) — change stem ('index.min').

`$3`

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 types [Move][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 of vfile-rename is safe.

`Contribute`

See [contributing.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 conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/vfile/vfile-rename/workflows/main/badge.svg

[build]: https://github.com/vfile/vfile-rename/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-rename.svg

[coverage]: https://codecov.io/github/vfile/vfile-rename

[downloads-badge]: https://img.shields.io/npm/dm/vfile-rename.svg

[downloads]: https://www.npmjs.com/package/vfile-rename

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=vfile-rename

[size]: https://bundlejs.com/?q=vfile-rename

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/vfile/vfile/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[contributing]: https://github.com/vfile/.github/blob/main/contributing.md

[support]: https://github.com/vfile/.github/blob/main/support.md

[health]: https://github.com/vfile/.github

[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[vfile]: https://github.com/vfile/vfile

[api-convert]: #convertrenames

[api-rename]: #renamefile-renames

[api-move]: #move

[api-renames]: #renames

[api-spec]: #spec

[api-spec-affix]: #specaffix

vfile-rename

[vfile][vfile] utility to rename a file.

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][esm].
In Node.js (version 16+), install with [npm][]:

``sh npm install vfile-rename`

In Deno with [esm.sh][esmsh]:

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

In browsers with [esm.sh][esmsh]:

`html`

`Use`

`js 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][api-convert] and [rename][api-rename]. There is no default export.

`$3`

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]).

`$3`

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).

`$3`

Move (TypeScript type).

###### Parameters

* file ([VFile][vfile]) — file to change

###### Returns

Nothing (undefined).

`$3`

Rename instructions (TypeScript type).

###### Type

`ts type Renames = Array | Move | Spec | string`

`$3`

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

###### Fields

`$3`

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 types [Move][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 of vfile-rename is safe.

`Contribute`

See [contributing.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 conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

License

[build-badge]: https://github.com/vfile/vfile-rename/workflows/main/badge.svg

[build]: https://github.com/vfile/vfile-rename/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/vfile/vfile-rename.svg

[coverage]: https://codecov.io/github/vfile/vfile-rename

[downloads-badge]: https://img.shields.io/npm/dm/vfile-rename.svg

[downloads]: https://www.npmjs.com/package/vfile-rename

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=vfile-rename

[size]: https://bundlejs.com/?q=vfile-rename

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/vfile/vfile/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[contributing]: https://github.com/vfile/.github/blob/main/contributing.md

[support]: https://github.com/vfile/.github/blob/main/support.md

[health]: https://github.com/vfile/.github

[coc]: https://github.com/vfile/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[vfile]: https://github.com/vfile/vfile

[api-convert]: #convertrenames

[api-rename]: #renamefile-renames

[api-move]: #move

[api-renames]: #renames

[api-spec]: #spec

[api-spec-affix]: #specaffix

vfile-rename

vfile-rename

Contents

What is this?

When should I use this?

Install

`Use`

`API`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Types`

`Compatibility`

`Security`

`Contribute`

License

vfile-rename

vfile-rename

Contents

What is this?

When should I use this?

Install

`Use`

`API`

`$3`

`$3`

`$3`

`$3`

`$3`

`$3`

`Types`

`Compatibility`

`Security`

`Contribute`

License