-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor to move implementation to
lib/
- Loading branch information
Showing
3 changed files
with
293 additions
and
284 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,287 +1,8 @@ | ||
| /** | ||
| * @typedef {import('vfile').VFileCompatible} VFileCompatible | ||
| * @typedef {import('vfile').VFileOptions} VFileOptions | ||
| * @typedef {import('./lib/index.js').Move} Move | ||
| * @typedef {import('./lib/index.js').Renames} Renames | ||
| * @typedef {import('./lib/index.js').Spec} Spec | ||
| * @typedef {import('./lib/index.js').SpecAffix} SpecAffix | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef SpecAffix | ||
| * Define prepending and/or appending. | ||
| * @property {string | null | undefined} [prefix] | ||
| * Substring to prepend in front of the field. | ||
| * @property {string | null | undefined} [suffix] | ||
| * Substring to append after the field. | ||
| * | ||
| * @typedef Spec | ||
| * An object describing path properties to values. | ||
| * | ||
| * 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. | ||
| * @property {VFileOptions['basename'] | SpecAffix} [basename] | ||
| * Change basename (`'index.min.js'`). | ||
| * @property {VFileOptions['dirname'] | SpecAffix} [dirname] | ||
| * Change dirname (`'~'`). | ||
| * @property {VFileOptions['extname'] | SpecAffix} [extname] | ||
| * Change extname (`'.js'`). | ||
| * @property {VFileOptions['path'] | SpecAffix} [path] | ||
| * Change file path (`'~/index.min.js'`). | ||
| * @property {VFileOptions['stem'] | SpecAffix} [stem] | ||
| * Change stem (`'index.min'`). | ||
| * | ||
| * @typedef {'basename' | 'dirname' | 'extname' | 'path' | 'stem'} Field | ||
| * Fields related to paths. | ||
| */ | ||
|
|
||
| /** | ||
| * @callback Move | ||
| * When given something, returns a vfile from that, and changes its path | ||
| * properties. | ||
| * | ||
| * * if there is no bound rename (it’s `null` or `undefined`), does nothing. | ||
| * * otherwise, 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` | ||
| * @param {VFile} file | ||
| * File to change. | ||
| * @returns {void} | ||
| * Nothing. | ||
| */ | ||
|
|
||
| /** | ||
| * @typedef {string | Move | Spec | Array<string | Move | Spec>} Renames | ||
| * How to rename. | ||
| */ | ||
|
|
||
| import {VFile} from 'vfile' | ||
|
|
||
| const own = {}.hasOwnProperty | ||
|
|
||
| // Order of renaming properties. | ||
| // See <https://github.com/vfile/vfile/blob/7339f82/lib/index.js#L58> | ||
| // Other properties are invalid. | ||
| /** @type {Array<Field>} */ | ||
| const order = ['path', 'basename', 'stem', 'extname', 'dirname'] | ||
|
|
||
| // To do: next major: only allow actual vfiles. | ||
| // To do: next major: don’t return given file. | ||
| /** | ||
| * Rename a file. | ||
| * | ||
| * @param {VFileCompatible | null | undefined} [value] | ||
| * File to rename. | ||
| * @param {Renames | null | undefined} [renames] | ||
| * Rename instructions. | ||
| * @returns {VFile} | ||
| * The renamed `file`. | ||
| */ | ||
| export function rename(value, renames) { | ||
| // @ts-expect-error: `VFile` should support `null`. | ||
| const file = value instanceof VFile ? value : new VFile(value) | ||
| convert(renames)(file) | ||
| return file | ||
| } | ||
|
|
||
| /** | ||
| * Create a function (the move) from `renames`, that when given a file changes | ||
| * its path properties. | ||
| * | ||
| * @param {Renames | null | undefined} [renames] | ||
| * Rename instructions. | ||
| * @returns {Move} | ||
| * A move. | ||
| */ | ||
| export function convert(renames) { | ||
| if (renames === null || renames === undefined) { | ||
| return nothing | ||
| } | ||
|
|
||
| if (typeof renames === 'function') { | ||
| return renames | ||
| } | ||
|
|
||
| if (typeof renames === 'string') { | ||
| return setter(renames.charAt(0) === '.' ? 'extname' : 'basename', renames) | ||
| } | ||
|
|
||
| if (typeof renames === 'object') { | ||
| return Array.isArray(renames) | ||
| ? allFactory(convertAll(renames)) | ||
| : specFactory(renames) | ||
| } | ||
|
|
||
| throw new Error('Expected function, string, array, or object as renames') | ||
| } | ||
|
|
||
| /** | ||
| * @param {Spec} spec | ||
| * @returns {Move} | ||
| */ | ||
| function specFactory(spec) { | ||
| /** @type {Array<Field>} */ | ||
| const props = [] | ||
| /** @type {Array<Move>} */ | ||
| const moves = [] | ||
| /** @type {Field} */ | ||
| let prop | ||
|
|
||
| // Fail on non-path props. | ||
| for (prop in spec) { | ||
| if (own.call(spec, prop)) { | ||
| if (!order.includes(prop)) { | ||
| throw new Error( | ||
| 'Cannot rename `' + prop + '`: it’s not a path property' | ||
| ) | ||
| } | ||
|
|
||
| props.push(prop) | ||
| } | ||
| } | ||
|
|
||
| // Create moves for all specs. | ||
| props.sort(sort) | ||
|
|
||
| let index = -1 | ||
|
|
||
| while (++index < props.length) { | ||
| const prop = props[index] | ||
| const value = spec[prop] | ||
|
|
||
| if (typeof value === 'string') { | ||
| moves.push(setter(prop, value)) | ||
| } else if (value) { | ||
| if ('prefix' in value && value.prefix) { | ||
| moves.push(prefix(prop, value.prefix)) | ||
| } | ||
|
|
||
| if ('suffix' in value && value.suffix) { | ||
| moves.push(suffix(prop, value.suffix)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return allFactory(moves) | ||
| } | ||
|
|
||
| /** | ||
| * Convert renames into moves. | ||
| * | ||
| * @param {Array<string | Move | Spec>} renames | ||
| * Renames. | ||
| * @returns {Array<Move>} | ||
| * Moves. | ||
| */ | ||
| function convertAll(renames) { | ||
| /** @type {Array<Move>} */ | ||
| const moves = [] | ||
| let index = -1 | ||
|
|
||
| while (++index < renames.length) { | ||
| moves[index] = convert(renames[index]) | ||
| } | ||
|
|
||
| return moves | ||
| } | ||
|
|
||
| /** | ||
| * Create a move from multiples moves. | ||
| * | ||
| * @param {Array<Move>} changes | ||
| * Moves. | ||
| * @returns {Move} | ||
| * Move. | ||
| */ | ||
| function allFactory(changes) { | ||
| return all | ||
| /** @type {Move} */ | ||
| function all(file) { | ||
| const history = file.history.concat() | ||
| let index = -1 | ||
|
|
||
| while (++index < changes.length) { | ||
| changes[index](file) | ||
| } | ||
|
|
||
| // Clean history to only include one changed path. | ||
| file.history = [...history, file.path] | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Create a move that sets. | ||
| * | ||
| * @param {Field} key | ||
| * Field. | ||
| * @param {string} value | ||
| * Value to set. | ||
| * @returns {Move} | ||
| * Move. | ||
| */ | ||
| function setter(key, value) { | ||
| return set | ||
| /** @type {Move} */ | ||
| function set(file) { | ||
| file[key] = value | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Create a move that prepends. | ||
| * | ||
| * @param {Field} key | ||
| * Field. | ||
| * @param {string} prefix | ||
| * Value to add. | ||
| * @returns {Move} | ||
| * Move. | ||
| */ | ||
| function prefix(key, prefix) { | ||
| return add | ||
| /** @type {Move} */ | ||
| function add(file) { | ||
| file[key] = prefix + file[key] | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Create a move that appends. | ||
| * | ||
| * @param {Field} key | ||
| * Field. | ||
| * @param {string} suffix | ||
| * Value to add. | ||
| * @returns {Move} | ||
| * Move. | ||
| */ | ||
| function suffix(key, suffix) { | ||
| return add | ||
| /** @type {Move} */ | ||
| function add(file) { | ||
| file[key] += suffix | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Move that doesn’t do anything. | ||
| * | ||
| * @type {Move} | ||
| */ | ||
| function nothing() {} | ||
|
|
||
| /** | ||
| * Sort fields on which comes first in `order`. | ||
| * | ||
| * @param {Field} a | ||
| * Left. | ||
| * @param {Field} b | ||
| * Right. | ||
| * @returns {number} | ||
| * Sort. | ||
| */ | ||
| function sort(a, b) { | ||
| return order.indexOf(a) - order.indexOf(b) | ||
| } | ||
| export {convert, rename} from './lib/index.js' |
Oops, something went wrong.