mirror of
https://github.com/Sevichecc/Urara-Blog.git
synced 2025-05-05 20:49:29 +08:00
420 lines
12 KiB
Text
420 lines
12 KiB
Text
/**
|
||
* @typedef {import('unist').Node} Node
|
||
* @typedef {import('unist').Position} Position
|
||
* @typedef {import('unist').Point} Point
|
||
* @typedef {Record<string, unknown> & {type: string, position?: Position|undefined}} NodeLike
|
||
* @typedef {import('./minurl.shared.js').URL} URL
|
||
* @typedef {import('../index.js').Data} Data
|
||
* @typedef {import('../index.js').Value} Value
|
||
*
|
||
* @typedef {'ascii'|'utf8'|'utf-8'|'utf16le'|'ucs2'|'ucs-2'|'base64'|'base64url'|'latin1'|'binary'|'hex'} BufferEncoding
|
||
* Encodings supported by the buffer class.
|
||
* This is a copy of the typing from Node, copied to prevent Node globals from
|
||
* being needed.
|
||
* Copied from: <https://github.com/DefinitelyTyped/DefinitelyTyped/blob/90a4ec8/types/node/buffer.d.ts#L170>
|
||
*
|
||
* @typedef {Value|Options|VFile|URL} Compatible
|
||
* Things that can be passed to the constructor.
|
||
*
|
||
* @typedef VFileCoreOptions
|
||
* @property {Value} [value]
|
||
* @property {string} [cwd]
|
||
* @property {Array<string>} [history]
|
||
* @property {string|URL} [path]
|
||
* @property {string} [basename]
|
||
* @property {string} [stem]
|
||
* @property {string} [extname]
|
||
* @property {string} [dirname]
|
||
* @property {Data} [data]
|
||
*
|
||
* @typedef Map
|
||
* Raw source map, see:
|
||
* <https://github.com/mozilla/source-map/blob/58819f0/source-map.d.ts#L15-L23>.
|
||
* @property {number} version
|
||
* @property {Array<string>} sources
|
||
* @property {Array<string>} names
|
||
* @property {string|undefined} [sourceRoot]
|
||
* @property {Array<string>|undefined} [sourcesContent]
|
||
* @property {string} mappings
|
||
* @property {string} file
|
||
*
|
||
* @typedef {{[key: string]: unknown} & VFileCoreOptions} Options
|
||
* Configuration: a bunch of keys that will be shallow copied over to the new
|
||
* file.
|
||
*
|
||
* @typedef {Record<string, unknown>} ReporterSettings
|
||
* @typedef {<T = ReporterSettings>(files: Array<VFile>, options: T) => string} Reporter
|
||
*/
|
||
|
||
import buffer from 'is-buffer'
|
||
import {VFileMessage} from 'vfile-message'
|
||
import {path} from './minpath.js'
|
||
import {proc} from './minproc.js'
|
||
import {urlToPath, isUrl} from './minurl.js'
|
||
|
||
// Order of setting (least specific to most), we need this because otherwise
|
||
// `{stem: 'a', path: '~/b.js'}` would throw, as a path is needed before a
|
||
// stem can be set.
|
||
const order = ['history', 'path', 'basename', 'stem', 'extname', 'dirname']
|
||
|
||
export class VFile {
|
||
/**
|
||
* Create a new virtual file.
|
||
*
|
||
* If `options` is `string` or `Buffer`, it’s treated as `{value: options}`.
|
||
* If `options` is a `URL`, it’s treated as `{path: options}`.
|
||
* If `options` is a `VFile`, shallow copies its data over to the new file.
|
||
* All fields in `options` are set on the newly created `VFile`.
|
||
*
|
||
* Path related fields are set in the following order (least specific to
|
||
* most specific): `history`, `path`, `basename`, `stem`, `extname`,
|
||
* `dirname`.
|
||
*
|
||
* It’s not possible to set either `dirname` or `extname` without setting
|
||
* either `history`, `path`, `basename`, or `stem` as well.
|
||
*
|
||
* @param {Compatible} [value]
|
||
*/
|
||
constructor(value) {
|
||
/** @type {Options} */
|
||
let options
|
||
|
||
if (!value) {
|
||
options = {}
|
||
} else if (typeof value === 'string' || buffer(value)) {
|
||
// @ts-expect-error Looks like a buffer.
|
||
options = {value}
|
||
} else if (isUrl(value)) {
|
||
options = {path: value}
|
||
} else {
|
||
// @ts-expect-error Looks like file or options.
|
||
options = value
|
||
}
|
||
|
||
/**
|
||
* Place to store custom information (default: `{}`).
|
||
* It’s OK to store custom data directly on the file but moving it to
|
||
* `data` is recommended.
|
||
* @type {Data}
|
||
*/
|
||
this.data = {}
|
||
|
||
/**
|
||
* List of messages associated with the file.
|
||
* @type {Array<VFileMessage>}
|
||
*/
|
||
this.messages = []
|
||
|
||
/**
|
||
* List of filepaths the file moved between.
|
||
* The first is the original path and the last is the current path.
|
||
* @type {Array<string>}
|
||
*/
|
||
this.history = []
|
||
|
||
/**
|
||
* Base of `path` (default: `process.cwd()` or `'/'` in browsers).
|
||
* @type {string}
|
||
*/
|
||
this.cwd = proc.cwd()
|
||
|
||
/* eslint-disable no-unused-expressions */
|
||
/**
|
||
* Raw value.
|
||
* @type {Value}
|
||
*/
|
||
this.value
|
||
|
||
// The below are non-standard, they are “well-known”.
|
||
// As in, used in several tools.
|
||
|
||
/**
|
||
* Whether a file was saved to disk.
|
||
* This is used by vfile reporters.
|
||
* @type {boolean}
|
||
*/
|
||
this.stored
|
||
|
||
/**
|
||
* Sometimes files have a non-string, compiled, representation.
|
||
* This can be stored in the `result` field.
|
||
* One example is when turning markdown into React nodes.
|
||
* This is used by unified to store non-string results.
|
||
* @type {unknown}
|
||
*/
|
||
this.result
|
||
|
||
/**
|
||
* Sometimes files have a source map associated with them.
|
||
* This can be stored in the `map` field.
|
||
* This should be a `Map` type, which is equivalent to the `RawSourceMap`
|
||
* type from the `source-map` module.
|
||
* @type {Map|undefined}
|
||
*/
|
||
this.map
|
||
/* eslint-enable no-unused-expressions */
|
||
|
||
// Set path related properties in the correct order.
|
||
let index = -1
|
||
|
||
while (++index < order.length) {
|
||
const prop = order[index]
|
||
|
||
// Note: we specifically use `in` instead of `hasOwnProperty` to accept
|
||
// `vfile`s too.
|
||
if (prop in options && options[prop] !== undefined) {
|
||
// @ts-expect-error: TS is confused by the different types for `history`.
|
||
this[prop] = prop === 'history' ? [...options[prop]] : options[prop]
|
||
}
|
||
}
|
||
|
||
/** @type {string} */
|
||
let prop
|
||
|
||
// Set non-path related properties.
|
||
for (prop in options) {
|
||
// @ts-expect-error: fine to set other things.
|
||
if (!order.includes(prop)) this[prop] = options[prop]
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Get the full path (example: `'~/index.min.js'`).
|
||
* @returns {string}
|
||
*/
|
||
get path() {
|
||
return this.history[this.history.length - 1]
|
||
}
|
||
|
||
/**
|
||
* Set the full path (example: `'~/index.min.js'`).
|
||
* Cannot be nullified.
|
||
* You can set a file URL (a `URL` object with a `file:` protocol) which will
|
||
* be turned into a path with `url.fileURLToPath`.
|
||
* @param {string|URL} path
|
||
*/
|
||
set path(path) {
|
||
if (isUrl(path)) {
|
||
path = urlToPath(path)
|
||
}
|
||
|
||
assertNonEmpty(path, 'path')
|
||
|
||
if (this.path !== path) {
|
||
this.history.push(path)
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Get the parent path (example: `'~'`).
|
||
*/
|
||
get dirname() {
|
||
return typeof this.path === 'string' ? path.dirname(this.path) : undefined
|
||
}
|
||
|
||
/**
|
||
* Set the parent path (example: `'~'`).
|
||
* Cannot be set if there’s no `path` yet.
|
||
*/
|
||
set dirname(dirname) {
|
||
assertPath(this.basename, 'dirname')
|
||
this.path = path.join(dirname || '', this.basename)
|
||
}
|
||
|
||
/**
|
||
* Get the basename (including extname) (example: `'index.min.js'`).
|
||
*/
|
||
get basename() {
|
||
return typeof this.path === 'string' ? path.basename(this.path) : undefined
|
||
}
|
||
|
||
/**
|
||
* Set basename (including extname) (`'index.min.js'`).
|
||
* Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
|
||
* on windows).
|
||
* Cannot be nullified (use `file.path = file.dirname` instead).
|
||
*/
|
||
set basename(basename) {
|
||
assertNonEmpty(basename, 'basename')
|
||
assertPart(basename, 'basename')
|
||
this.path = path.join(this.dirname || '', basename)
|
||
}
|
||
|
||
/**
|
||
* Get the extname (including dot) (example: `'.js'`).
|
||
*/
|
||
get extname() {
|
||
return typeof this.path === 'string' ? path.extname(this.path) : undefined
|
||
}
|
||
|
||
/**
|
||
* Set the extname (including dot) (example: `'.js'`).
|
||
* Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
|
||
* on windows).
|
||
* Cannot be set if there’s no `path` yet.
|
||
*/
|
||
set extname(extname) {
|
||
assertPart(extname, 'extname')
|
||
assertPath(this.dirname, 'extname')
|
||
|
||
if (extname) {
|
||
if (extname.charCodeAt(0) !== 46 /* `.` */) {
|
||
throw new Error('`extname` must start with `.`')
|
||
}
|
||
|
||
if (extname.includes('.', 1)) {
|
||
throw new Error('`extname` cannot contain multiple dots')
|
||
}
|
||
}
|
||
|
||
this.path = path.join(this.dirname, this.stem + (extname || ''))
|
||
}
|
||
|
||
/**
|
||
* Get the stem (basename w/o extname) (example: `'index.min'`).
|
||
*/
|
||
get stem() {
|
||
return typeof this.path === 'string'
|
||
? path.basename(this.path, this.extname)
|
||
: undefined
|
||
}
|
||
|
||
/**
|
||
* Set the stem (basename w/o extname) (example: `'index.min'`).
|
||
* Cannot contain path separators (`'/'` on unix, macOS, and browsers, `'\'`
|
||
* on windows).
|
||
* Cannot be nullified (use `file.path = file.dirname` instead).
|
||
*/
|
||
set stem(stem) {
|
||
assertNonEmpty(stem, 'stem')
|
||
assertPart(stem, 'stem')
|
||
this.path = path.join(this.dirname || '', stem + (this.extname || ''))
|
||
}
|
||
|
||
/**
|
||
* Serialize the file.
|
||
*
|
||
* @param {BufferEncoding} [encoding='utf8']
|
||
* When `value` is a `Buffer`, `encoding` is a character encoding to
|
||
* understand it as (default: `'utf8'`).
|
||
* @returns {string}
|
||
* Serialized file.
|
||
*/
|
||
toString(encoding) {
|
||
return (this.value || '').toString(encoding)
|
||
}
|
||
|
||
/**
|
||
* Constructs a new `VFileMessage`, where `fatal` is set to `false`, and
|
||
* associates it with the file by adding it to `vfile.messages` and setting
|
||
* `message.file` to the current filepath.
|
||
*
|
||
* @param {string|Error} reason
|
||
* Human readable reason for the message, uses the stack and message of the error if given.
|
||
* @param {Node|NodeLike|Position|Point} [place]
|
||
* Place where the message occurred in the file.
|
||
* @param {string} [origin]
|
||
* Computer readable reason for the message
|
||
* @returns {VFileMessage}
|
||
* Message.
|
||
*/
|
||
message(reason, place, origin) {
|
||
const message = new VFileMessage(reason, place, origin)
|
||
|
||
if (this.path) {
|
||
message.name = this.path + ':' + message.name
|
||
message.file = this.path
|
||
}
|
||
|
||
message.fatal = false
|
||
|
||
this.messages.push(message)
|
||
|
||
return message
|
||
}
|
||
|
||
/**
|
||
* Like `VFile#message()`, but associates an informational message where
|
||
* `fatal` is set to `null`.
|
||
*
|
||
* @param {string|Error} reason
|
||
* Human readable reason for the message, uses the stack and message of the error if given.
|
||
* @param {Node|NodeLike|Position|Point} [place]
|
||
* Place where the message occurred in the file.
|
||
* @param {string} [origin]
|
||
* Computer readable reason for the message
|
||
* @returns {VFileMessage}
|
||
* Message.
|
||
*/
|
||
info(reason, place, origin) {
|
||
const message = this.message(reason, place, origin)
|
||
|
||
message.fatal = null
|
||
|
||
return message
|
||
}
|
||
|
||
/**
|
||
* Like `VFile#message()`, but associates a fatal message where `fatal` is
|
||
* set to `true`, and then immediately throws it.
|
||
*
|
||
* > 👉 **Note**: a fatal error means that a file is no longer processable.
|
||
*
|
||
* @param {string|Error} reason
|
||
* Human readable reason for the message, uses the stack and message of the error if given.
|
||
* @param {Node|NodeLike|Position|Point} [place]
|
||
* Place where the message occurred in the file.
|
||
* @param {string} [origin]
|
||
* Computer readable reason for the message
|
||
* @returns {never}
|
||
* Message.
|
||
*/
|
||
fail(reason, place, origin) {
|
||
const message = this.message(reason, place, origin)
|
||
|
||
message.fatal = true
|
||
|
||
throw message
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Assert that `part` is not a path (as in, does not contain `path.sep`).
|
||
*
|
||
* @param {string|undefined} part
|
||
* @param {string} name
|
||
* @returns {void}
|
||
*/
|
||
function assertPart(part, name) {
|
||
if (part && part.includes(path.sep)) {
|
||
throw new Error(
|
||
'`' + name + '` cannot be a path: did not expect `' + path.sep + '`'
|
||
)
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Assert that `part` is not empty.
|
||
*
|
||
* @param {string|undefined} part
|
||
* @param {string} name
|
||
* @returns {asserts part is string}
|
||
*/
|
||
function assertNonEmpty(part, name) {
|
||
if (!part) {
|
||
throw new Error('`' + name + '` cannot be empty')
|
||
}
|
||
}
|
||
|
||
/**
|
||
* Assert `path` exists.
|
||
*
|
||
* @param {string|undefined} path
|
||
* @param {string} name
|
||
* @returns {asserts path is string}
|
||
*/
|
||
function assertPath(path, name) {
|
||
if (!path) {
|
||
throw new Error('Setting `' + name + '` requires `path` to be set too')
|
||
}
|
||
}
|