(function (factory) { if (typeof exports === "object" && typeof module === "object") { module.exports = factory(); } else if (typeof define === "function" && define.amd) { define(factory); } else { var root = typeof globalThis !== "undefined" ? globalThis : typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : this || {}; root.doc = factory(); } })(function() { "use strict"; var __getOwnPropNames = Object.getOwnPropertyNames; var __commonJS = (cb, mod) => function __require() { return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports; }; // dist/_doc.js.umd.js var require_doc_js_umd = __commonJS({ "dist/_doc.js.umd.js"(exports, module) { var __create = Object.create; var __defProp = Object.defineProperty; var __getOwnPropDesc = Object.getOwnPropertyDescriptor; var __getOwnPropNames2 = Object.getOwnPropertyNames; var __getProtoOf = Object.getPrototypeOf; var __hasOwnProp = Object.prototype.hasOwnProperty; var __esm = (fn, res) => function __init() { return fn && (res = (0, fn[__getOwnPropNames2(fn)[0]])(fn = 0)), res; }; var __commonJS2 = (cb, mod) => function __require() { return mod || (0, cb[__getOwnPropNames2(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports; }; var __export = (target, all) => { for (var name in all) __defProp(target, name, { get: all[name], enumerable: true }); }; var __copyProps = (to, from, except, desc) => { if (from && typeof from === "object" || typeof from === "function") { for (let key of __getOwnPropNames2(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable }); } return to; }; var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod)); var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod); var init_define_process = __esm({ ""() { } }); var require_doc_builders = __commonJS2({ "src/document/doc-builders.js"(exports2, module2) { "use strict"; init_define_process(); function concat(parts) { if (false) { for (const part of parts) { assertDoc(part); } } return { type: "concat", parts }; } function indent(contents) { if (false) { assertDoc(contents); } return { type: "indent", contents }; } function align(widthOrString, contents) { if (false) { assertDoc(contents); } return { type: "align", contents, n: widthOrString }; } function group(contents) { let opts = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {}; if (false) { assertDoc(contents); } return { type: "group", id: opts.id, contents, break: Boolean(opts.shouldBreak), expandedStates: opts.expandedStates }; } function dedentToRoot(contents) { return align(Number.NEGATIVE_INFINITY, contents); } function markAsRoot(contents) { return align({ type: "root" }, contents); } function dedent(contents) { return align(-1, contents); } function conditionalGroup(states, opts) { return group(states[0], Object.assign(Object.assign({}, opts), {}, { expandedStates: states })); } function fill(parts) { if (false) { for (const part of parts) { assertDoc(part); } } return { type: "fill", parts }; } function ifBreak(breakContents, flatContents) { let opts = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : {}; if (false) { if (breakContents) { assertDoc(breakContents); } if (flatContents) { assertDoc(flatContents); } } return { type: "if-break", breakContents, flatContents, groupId: opts.groupId }; } function indentIfBreak(contents, opts) { return { type: "indent-if-break", contents, groupId: opts.groupId, negate: opts.negate }; } function lineSuffix(contents) { if (false) { assertDoc(contents); } return { type: "line-suffix", contents }; } var lineSuffixBoundary = { type: "line-suffix-boundary" }; var breakParent = { type: "break-parent" }; var trim = { type: "trim" }; var hardlineWithoutBreakParent = { type: "line", hard: true }; var literallineWithoutBreakParent = { type: "line", hard: true, literal: true }; var line = { type: "line" }; var softline = { type: "line", soft: true }; var hardline = concat([hardlineWithoutBreakParent, breakParent]); var literalline = concat([literallineWithoutBreakParent, breakParent]); var cursor = { type: "cursor", placeholder: Symbol("cursor") }; function join(sep, arr) { const res = []; for (let i = 0; i < arr.length; i++) { if (i !== 0) { res.push(sep); } res.push(arr[i]); } return concat(res); } function addAlignmentToDoc(doc, size, tabWidth) { let aligned = doc; if (size > 0) { for (let i = 0; i < Math.floor(size / tabWidth); ++i) { aligned = indent(aligned); } aligned = align(size % tabWidth, aligned); aligned = align(Number.NEGATIVE_INFINITY, aligned); } return aligned; } function label(label2, contents) { return { type: "label", label: label2, contents }; } module2.exports = { concat, join, line, softline, hardline, literalline, group, conditionalGroup, fill, lineSuffix, lineSuffixBoundary, cursor, breakParent, ifBreak, trim, indent, indentIfBreak, align, addAlignmentToDoc, markAsRoot, dedentToRoot, dedent, hardlineWithoutBreakParent, literallineWithoutBreakParent, label }; } }); var require_end_of_line = __commonJS2({ "src/common/end-of-line.js"(exports2, module2) { "use strict"; init_define_process(); function guessEndOfLine(text) { const index = text.indexOf("\r"); if (index >= 0) { return text.charAt(index + 1) === "\n" ? "crlf" : "cr"; } return "lf"; } function convertEndOfLineToChars(value) { switch (value) { case "cr": return "\r"; case "crlf": return "\r\n"; default: return "\n"; } } function countEndOfLineChars(text, eol) { let regex; switch (eol) { case "\n": regex = /\n/g; break; case "\r": regex = /\r/g; break; case "\r\n": regex = /\r\n/g; break; default: throw new Error(`Unexpected "eol" ${JSON.stringify(eol)}.`); } const endOfLines = text.match(regex); return endOfLines ? endOfLines.length : 0; } function normalizeEndOfLine(text) { return text.replace(/\r\n?/g, "\n"); } module2.exports = { guessEndOfLine, convertEndOfLineToChars, countEndOfLineChars, normalizeEndOfLine }; } }); var require_get_last = __commonJS2({ "src/utils/get-last.js"(exports2, module2) { "use strict"; init_define_process(); var getLast = (arr) => arr[arr.length - 1]; module2.exports = getLast; } }); function ansiRegex() { let { onlyFirst = false } = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {}; const pattern = ["[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)", "(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))"].join("|"); return new RegExp(pattern, onlyFirst ? void 0 : "g"); } var init_ansi_regex = __esm({ "node_modules/strip-ansi/node_modules/ansi-regex/index.js"() { init_define_process(); } }); function stripAnsi(string) { if (typeof string !== "string") { throw new TypeError(`Expected a \`string\`, got \`${typeof string}\``); } return string.replace(ansiRegex(), ""); } var init_strip_ansi = __esm({ "node_modules/strip-ansi/index.js"() { init_define_process(); init_ansi_regex(); } }); function isFullwidthCodePoint(codePoint) { if (!Number.isInteger(codePoint)) { return false; } return codePoint >= 4352 && (codePoint <= 4447 || codePoint === 9001 || codePoint === 9002 || 11904 <= codePoint && codePoint <= 12871 && codePoint !== 12351 || 12880 <= codePoint && codePoint <= 19903 || 19968 <= codePoint && codePoint <= 42182 || 43360 <= codePoint && codePoint <= 43388 || 44032 <= codePoint && codePoint <= 55203 || 63744 <= codePoint && codePoint <= 64255 || 65040 <= codePoint && codePoint <= 65049 || 65072 <= codePoint && codePoint <= 65131 || 65281 <= codePoint && codePoint <= 65376 || 65504 <= codePoint && codePoint <= 65510 || 110592 <= codePoint && codePoint <= 110593 || 127488 <= codePoint && codePoint <= 127569 || 131072 <= codePoint && codePoint <= 262141); } var init_is_fullwidth_code_point = __esm({ "node_modules/is-fullwidth-code-point/index.js"() { init_define_process(); } }); var require_emoji_regex = __commonJS2({ "node_modules/emoji-regex/index.js"(exports2, module2) { "use strict"; init_define_process(); module2.exports = function() { return /\uD83C\uDFF4\uDB40\uDC67\uDB40\uDC62(?:\uDB40\uDC77\uDB40\uDC6C\uDB40\uDC73|\uDB40\uDC73\uDB40\uDC63\uDB40\uDC74|\uDB40\uDC65\uDB40\uDC6E\uDB40\uDC67)\uDB40\uDC7F|(?:\uD83E\uDDD1\uD83C\uDFFF\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFF\u200D\uD83E\uDD1D\u200D(?:\uD83D[\uDC68\uDC69]))(?:\uD83C[\uDFFB-\uDFFE])|(?:\uD83E\uDDD1\uD83C\uDFFE\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFE\u200D\uD83E\uDD1D\u200D(?:\uD83D[\uDC68\uDC69]))(?:\uD83C[\uDFFB-\uDFFD\uDFFF])|(?:\uD83E\uDDD1\uD83C\uDFFD\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFD\u200D\uD83E\uDD1D\u200D(?:\uD83D[\uDC68\uDC69]))(?:\uD83C[\uDFFB\uDFFC\uDFFE\uDFFF])|(?:\uD83E\uDDD1\uD83C\uDFFC\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFC\u200D\uD83E\uDD1D\u200D(?:\uD83D[\uDC68\uDC69]))(?:\uD83C[\uDFFB\uDFFD-\uDFFF])|(?:\uD83E\uDDD1\uD83C\uDFFB\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83E\uDDD1|\uD83D\uDC69\uD83C\uDFFB\u200D\uD83E\uDD1D\u200D(?:\uD83D[\uDC68\uDC69]))(?:\uD83C[\uDFFC-\uDFFF])|\uD83D\uDC68(?:\uD83C\uDFFB(?:\u200D(?:\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFF])|\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFF]))|\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFC-\uDFFF])|[\u2695\u2696\u2708]\uFE0F|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD]))?|(?:\uD83C[\uDFFC-\uDFFF])\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFF])|\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFF]))|\u200D(?:\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D)?\uD83D\uDC68|(?:\uD83D[\uDC68\uDC69])\u200D(?:\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67]))|\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67])|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFF\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFE])|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFE\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB-\uDFFD\uDFFF])|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFD\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB\uDFFC\uDFFE\uDFFF])|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFC\u200D(?:\uD83E\uDD1D\u200D\uD83D\uDC68(?:\uD83C[\uDFFB\uDFFD-\uDFFF])|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|(?:\uD83C\uDFFF\u200D[\u2695\u2696\u2708]|\uD83C\uDFFE\u200D[\u2695\u2696\u2708]|\uD83C\uDFFD\u200D[\u2695\u2696\u2708]|\uD83C\uDFFC\u200D[\u2695\u2696\u2708]|\u200D[\u2695\u2696\u2708])\uFE0F|\u200D(?:(?:\uD83D[\uDC68\uDC69])\u200D(?:\uD83D[\uDC66\uDC67])|\uD83D[\uDC66\uDC67])|\uD83C\uDFFF|\uD83C\uDFFE|\uD83C\uDFFD|\uD83C\uDFFC)?|(?:\uD83D\uDC69(?:\uD83C\uDFFB\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D(?:\uD83D[\uDC68\uDC69])|\uD83D[\uDC68\uDC69])|(?:\uD83C[\uDFFC-\uDFFF])\u200D\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D(?:\uD83D[\uDC68\uDC69])|\uD83D[\uDC68\uDC69]))|\uD83E\uDDD1(?:\uD83C[\uDFFB-\uDFFF])\u200D\uD83E\uDD1D\u200D\uD83E\uDDD1)(?:\uD83C[\uDFFB-\uDFFF])|\uD83D\uDC69\u200D\uD83D\uDC69\u200D(?:\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67]))|\uD83D\uDC69(?:\u200D(?:\u2764\uFE0F\u200D(?:\uD83D\uDC8B\u200D(?:\uD83D[\uDC68\uDC69])|\uD83D[\uDC68\uDC69])|\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFF\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFE\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFD\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFC\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFB\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD]))|\uD83E\uDDD1(?:\u200D(?:\uD83E\uDD1D\u200D\uD83E\uDDD1|\uD83C[\uDF3E\uDF73\uDF7C\uDF84\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFF\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF84\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFE\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF84\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFD\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF84\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFC\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF84\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD])|\uD83C\uDFFB\u200D(?:\uD83C[\uDF3E\uDF73\uDF7C\uDF84\uDF93\uDFA4\uDFA8\uDFEB\uDFED]|\uD83D[\uDCBB\uDCBC\uDD27\uDD2C\uDE80\uDE92]|\uD83E[\uDDAF-\uDDB3\uDDBC\uDDBD]))|\uD83D\uDC69\u200D\uD83D\uDC66\u200D\uD83D\uDC66|\uD83D\uDC69\u200D\uD83D\uDC69\u200D(?:\uD83D[\uDC66\uDC67])|\uD83D\uDC69\u200D\uD83D\uDC67\u200D(?:\uD83D[\uDC66\uDC67])|(?:\uD83D\uDC41\uFE0F\u200D\uD83D\uDDE8|\uD83E\uDDD1(?:\uD83C\uDFFF\u200D[\u2695\u2696\u2708]|\uD83C\uDFFE\u200D[\u2695\u2696\u2708]|\uD83C\uDFFD\u200D[\u2695\u2696\u2708]|\uD83C\uDFFC\u200D[\u2695\u2696\u2708]|\uD83C\uDFFB\u200D[\u2695\u2696\u2708]|\u200D[\u2695\u2696\u2708])|\uD83D\uDC69(?:\uD83C\uDFFF\u200D[\u2695\u2696\u2708]|\uD83C\uDFFE\u200D[\u2695\u2696\u2708]|\uD83C\uDFFD\u200D[\u2695\u2696\u2708]|\uD83C\uDFFC\u200D[\u2695\u2696\u2708]|\uD83C\uDFFB\u200D[\u2695\u2696\u2708]|\u200D[\u2695\u2696\u2708])|\uD83D\uDE36\u200D\uD83C\uDF2B|\uD83C\uDFF3\uFE0F\u200D\u26A7|\uD83D\uDC3B\u200D\u2744|(?:(?:\uD83C[\uDFC3\uDFC4\uDFCA]|\uD83D[\uDC6E\uDC70\uDC71\uDC73\uDC77\uDC81\uDC82\uDC86\uDC87\uDE45-\uDE47\uDE4B\uDE4D\uDE4E\uDEA3\uDEB4-\uDEB6]|\uD83E[\uDD26\uDD35\uDD37-\uDD39\uDD3D\uDD3E\uDDB8\uDDB9\uDDCD-\uDDCF\uDDD4\uDDD6-\uDDDD])(?:\uD83C[\uDFFB-\uDFFF])|\uD83D\uDC6F|\uD83E[\uDD3C\uDDDE\uDDDF])\u200D[\u2640\u2642]|(?:\u26F9|\uD83C[\uDFCB\uDFCC]|\uD83D\uDD75)(?:\uFE0F|\uD83C[\uDFFB-\uDFFF])\u200D[\u2640\u2642]|\uD83C\uDFF4\u200D\u2620|(?:\uD83C[\uDFC3\uDFC4\uDFCA]|\uD83D[\uDC6E\uDC70\uDC71\uDC73\uDC77\uDC81\uDC82\uDC86\uDC87\uDE45-\uDE47\uDE4B\uDE4D\uDE4E\uDEA3\uDEB4-\uDEB6]|\uD83E[\uDD26\uDD35\uDD37-\uDD39\uDD3D\uDD3E\uDDB8\uDDB9\uDDCD-\uDDCF\uDDD4\uDDD6-\uDDDD])\u200D[\u2640\u2642]|[\xA9\xAE\u203C\u2049\u2122\u2139\u2194-\u2199\u21A9\u21AA\u2328\u23CF\u23ED-\u23EF\u23F1\u23F2\u23F8-\u23FA\u24C2\u25AA\u25AB\u25B6\u25C0\u25FB\u25FC\u2600-\u2604\u260E\u2611\u2618\u2620\u2622\u2623\u2626\u262A\u262E\u262F\u2638-\u263A\u2640\u2642\u265F\u2660\u2663\u2665\u2666\u2668\u267B\u267E\u2692\u2694-\u2697\u2699\u269B\u269C\u26A0\u26A7\u26B0\u26B1\u26C8\u26CF\u26D1\u26D3\u26E9\u26F0\u26F1\u26F4\u26F7\u26F8\u2702\u2708\u2709\u270F\u2712\u2714\u2716\u271D\u2721\u2733\u2734\u2744\u2747\u2763\u27A1\u2934\u2935\u2B05-\u2B07\u3030\u303D\u3297\u3299]|\uD83C[\uDD70\uDD71\uDD7E\uDD7F\uDE02\uDE37\uDF21\uDF24-\uDF2C\uDF36\uDF7D\uDF96\uDF97\uDF99-\uDF9B\uDF9E\uDF9F\uDFCD\uDFCE\uDFD4-\uDFDF\uDFF5\uDFF7]|\uD83D[\uDC3F\uDCFD\uDD49\uDD4A\uDD6F\uDD70\uDD73\uDD76-\uDD79\uDD87\uDD8A-\uDD8D\uDDA5\uDDA8\uDDB1\uDDB2\uDDBC\uDDC2-\uDDC4\uDDD1-\uDDD3\uDDDC-\uDDDE\uDDE1\uDDE3\uDDE8\uDDEF\uDDF3\uDDFA\uDECB\uDECD-\uDECF\uDEE0-\uDEE5\uDEE9\uDEF0\uDEF3])\uFE0F|\uD83C\uDFF3\uFE0F\u200D\uD83C\uDF08|\uD83D\uDC69\u200D\uD83D\uDC67|\uD83D\uDC69\u200D\uD83D\uDC66|\uD83D\uDE35\u200D\uD83D\uDCAB|\uD83D\uDE2E\u200D\uD83D\uDCA8|\uD83D\uDC15\u200D\uD83E\uDDBA|\uD83E\uDDD1(?:\uD83C\uDFFF|\uD83C\uDFFE|\uD83C\uDFFD|\uD83C\uDFFC|\uD83C\uDFFB)?|\uD83D\uDC69(?:\uD83C\uDFFF|\uD83C\uDFFE|\uD83C\uDFFD|\uD83C\uDFFC|\uD83C\uDFFB)?|\uD83C\uDDFD\uD83C\uDDF0|\uD83C\uDDF6\uD83C\uDDE6|\uD83C\uDDF4\uD83C\uDDF2|\uD83D\uDC08\u200D\u2B1B|\u2764\uFE0F\u200D(?:\uD83D\uDD25|\uD83E\uDE79)|\uD83D\uDC41\uFE0F|\uD83C\uDFF3\uFE0F|\uD83C\uDDFF(?:\uD83C[\uDDE6\uDDF2\uDDFC])|\uD83C\uDDFE(?:\uD83C[\uDDEA\uDDF9])|\uD83C\uDDFC(?:\uD83C[\uDDEB\uDDF8])|\uD83C\uDDFB(?:\uD83C[\uDDE6\uDDE8\uDDEA\uDDEC\uDDEE\uDDF3\uDDFA])|\uD83C\uDDFA(?:\uD83C[\uDDE6\uDDEC\uDDF2\uDDF3\uDDF8\uDDFE\uDDFF])|\uD83C\uDDF9(?:\uD83C[\uDDE6\uDDE8\uDDE9\uDDEB-\uDDED\uDDEF-\uDDF4\uDDF7\uDDF9\uDDFB\uDDFC\uDDFF])|\uD83C\uDDF8(?:\uD83C[\uDDE6-\uDDEA\uDDEC-\uDDF4\uDDF7-\uDDF9\uDDFB\uDDFD-\uDDFF])|\uD83C\uDDF7(?:\uD83C[\uDDEA\uDDF4\uDDF8\uDDFA\uDDFC])|\uD83C\uDDF5(?:\uD83C[\uDDE6\uDDEA-\uDDED\uDDF0-\uDDF3\uDDF7-\uDDF9\uDDFC\uDDFE])|\uD83C\uDDF3(?:\uD83C[\uDDE6\uDDE8\uDDEA-\uDDEC\uDDEE\uDDF1\uDDF4\uDDF5\uDDF7\uDDFA\uDDFF])|\uD83C\uDDF2(?:\uD83C[\uDDE6\uDDE8-\uDDED\uDDF0-\uDDFF])|\uD83C\uDDF1(?:\uD83C[\uDDE6-\uDDE8\uDDEE\uDDF0\uDDF7-\uDDFB\uDDFE])|\uD83C\uDDF0(?:\uD83C[\uDDEA\uDDEC-\uDDEE\uDDF2\uDDF3\uDDF5\uDDF7\uDDFC\uDDFE\uDDFF])|\uD83C\uDDEF(?:\uD83C[\uDDEA\uDDF2\uDDF4\uDDF5])|\uD83C\uDDEE(?:\uD83C[\uDDE8-\uDDEA\uDDF1-\uDDF4\uDDF6-\uDDF9])|\uD83C\uDDED(?:\uD83C[\uDDF0\uDDF2\uDDF3\uDDF7\uDDF9\uDDFA])|\uD83C\uDDEC(?:\uD83C[\uDDE6\uDDE7\uDDE9-\uDDEE\uDDF1-\uDDF3\uDDF5-\uDDFA\uDDFC\uDDFE])|\uD83C\uDDEB(?:\uD83C[\uDDEE-\uDDF0\uDDF2\uDDF4\uDDF7])|\uD83C\uDDEA(?:\uD83C[\uDDE6\uDDE8\uDDEA\uDDEC\uDDED\uDDF7-\uDDFA])|\uD83C\uDDE9(?:\uD83C[\uDDEA\uDDEC\uDDEF\uDDF0\uDDF2\uDDF4\uDDFF])|\uD83C\uDDE8(?:\uD83C[\uDDE6\uDDE8\uDDE9\uDDEB-\uDDEE\uDDF0-\uDDF5\uDDF7\uDDFA-\uDDFF])|\uD83C\uDDE7(?:\uD83C[\uDDE6\uDDE7\uDDE9-\uDDEF\uDDF1-\uDDF4\uDDF6-\uDDF9\uDDFB\uDDFC\uDDFE\uDDFF])|\uD83C\uDDE6(?:\uD83C[\uDDE8-\uDDEC\uDDEE\uDDF1\uDDF2\uDDF4\uDDF6-\uDDFA\uDDFC\uDDFD\uDDFF])|[#\*0-9]\uFE0F\u20E3|\u2764\uFE0F|(?:\uD83C[\uDFC3\uDFC4\uDFCA]|\uD83D[\uDC6E\uDC70\uDC71\uDC73\uDC77\uDC81\uDC82\uDC86\uDC87\uDE45-\uDE47\uDE4B\uDE4D\uDE4E\uDEA3\uDEB4-\uDEB6]|\uD83E[\uDD26\uDD35\uDD37-\uDD39\uDD3D\uDD3E\uDDB8\uDDB9\uDDCD-\uDDCF\uDDD4\uDDD6-\uDDDD])(?:\uD83C[\uDFFB-\uDFFF])|(?:\u26F9|\uD83C[\uDFCB\uDFCC]|\uD83D\uDD75)(?:\uFE0F|\uD83C[\uDFFB-\uDFFF])|\uD83C\uDFF4|(?:[\u270A\u270B]|\uD83C[\uDF85\uDFC2\uDFC7]|\uD83D[\uDC42\uDC43\uDC46-\uDC50\uDC66\uDC67\uDC6B-\uDC6D\uDC72\uDC74-\uDC76\uDC78\uDC7C\uDC83\uDC85\uDC8F\uDC91\uDCAA\uDD7A\uDD95\uDD96\uDE4C\uDE4F\uDEC0\uDECC]|\uD83E[\uDD0C\uDD0F\uDD18-\uDD1C\uDD1E\uDD1F\uDD30-\uDD34\uDD36\uDD77\uDDB5\uDDB6\uDDBB\uDDD2\uDDD3\uDDD5])(?:\uD83C[\uDFFB-\uDFFF])|(?:[\u261D\u270C\u270D]|\uD83D[\uDD74\uDD90])(?:\uFE0F|\uD83C[\uDFFB-\uDFFF])|[\u270A\u270B]|\uD83C[\uDF85\uDFC2\uDFC7]|\uD83D[\uDC08\uDC15\uDC3B\uDC42\uDC43\uDC46-\uDC50\uDC66\uDC67\uDC6B-\uDC6D\uDC72\uDC74-\uDC76\uDC78\uDC7C\uDC83\uDC85\uDC8F\uDC91\uDCAA\uDD7A\uDD95\uDD96\uDE2E\uDE35\uDE36\uDE4C\uDE4F\uDEC0\uDECC]|\uD83E[\uDD0C\uDD0F\uDD18-\uDD1C\uDD1E\uDD1F\uDD30-\uDD34\uDD36\uDD77\uDDB5\uDDB6\uDDBB\uDDD2\uDDD3\uDDD5]|\uD83C[\uDFC3\uDFC4\uDFCA]|\uD83D[\uDC6E\uDC70\uDC71\uDC73\uDC77\uDC81\uDC82\uDC86\uDC87\uDE45-\uDE47\uDE4B\uDE4D\uDE4E\uDEA3\uDEB4-\uDEB6]|\uD83E[\uDD26\uDD35\uDD37-\uDD39\uDD3D\uDD3E\uDDB8\uDDB9\uDDCD-\uDDCF\uDDD4\uDDD6-\uDDDD]|\uD83D\uDC6F|\uD83E[\uDD3C\uDDDE\uDDDF]|[\u231A\u231B\u23E9-\u23EC\u23F0\u23F3\u25FD\u25FE\u2614\u2615\u2648-\u2653\u267F\u2693\u26A1\u26AA\u26AB\u26BD\u26BE\u26C4\u26C5\u26CE\u26D4\u26EA\u26F2\u26F3\u26F5\u26FA\u26FD\u2705\u2728\u274C\u274E\u2753-\u2755\u2757\u2795-\u2797\u27B0\u27BF\u2B1B\u2B1C\u2B50\u2B55]|\uD83C[\uDC04\uDCCF\uDD8E\uDD91-\uDD9A\uDE01\uDE1A\uDE2F\uDE32-\uDE36\uDE38-\uDE3A\uDE50\uDE51\uDF00-\uDF20\uDF2D-\uDF35\uDF37-\uDF7C\uDF7E-\uDF84\uDF86-\uDF93\uDFA0-\uDFC1\uDFC5\uDFC6\uDFC8\uDFC9\uDFCF-\uDFD3\uDFE0-\uDFF0\uDFF8-\uDFFF]|\uD83D[\uDC00-\uDC07\uDC09-\uDC14\uDC16-\uDC3A\uDC3C-\uDC3E\uDC40\uDC44\uDC45\uDC51-\uDC65\uDC6A\uDC79-\uDC7B\uDC7D-\uDC80\uDC84\uDC88-\uDC8E\uDC90\uDC92-\uDCA9\uDCAB-\uDCFC\uDCFF-\uDD3D\uDD4B-\uDD4E\uDD50-\uDD67\uDDA4\uDDFB-\uDE2D\uDE2F-\uDE34\uDE37-\uDE44\uDE48-\uDE4A\uDE80-\uDEA2\uDEA4-\uDEB3\uDEB7-\uDEBF\uDEC1-\uDEC5\uDED0-\uDED2\uDED5-\uDED7\uDEEB\uDEEC\uDEF4-\uDEFC\uDFE0-\uDFEB]|\uD83E[\uDD0D\uDD0E\uDD10-\uDD17\uDD1D\uDD20-\uDD25\uDD27-\uDD2F\uDD3A\uDD3F-\uDD45\uDD47-\uDD76\uDD78\uDD7A-\uDDB4\uDDB7\uDDBA\uDDBC-\uDDCB\uDDD0\uDDE0-\uDDFF\uDE70-\uDE74\uDE78-\uDE7A\uDE80-\uDE86\uDE90-\uDEA8\uDEB0-\uDEB6\uDEC0-\uDEC2\uDED0-\uDED6]|(?:[\u231A\u231B\u23E9-\u23EC\u23F0\u23F3\u25FD\u25FE\u2614\u2615\u2648-\u2653\u267F\u2693\u26A1\u26AA\u26AB\u26BD\u26BE\u26C4\u26C5\u26CE\u26D4\u26EA\u26F2\u26F3\u26F5\u26FA\u26FD\u2705\u270A\u270B\u2728\u274C\u274E\u2753-\u2755\u2757\u2795-\u2797\u27B0\u27BF\u2B1B\u2B1C\u2B50\u2B55]|\uD83C[\uDC04\uDCCF\uDD8E\uDD91-\uDD9A\uDDE6-\uDDFF\uDE01\uDE1A\uDE2F\uDE32-\uDE36\uDE38-\uDE3A\uDE50\uDE51\uDF00-\uDF20\uDF2D-\uDF35\uDF37-\uDF7C\uDF7E-\uDF93\uDFA0-\uDFCA\uDFCF-\uDFD3\uDFE0-\uDFF0\uDFF4\uDFF8-\uDFFF]|\uD83D[\uDC00-\uDC3E\uDC40\uDC42-\uDCFC\uDCFF-\uDD3D\uDD4B-\uDD4E\uDD50-\uDD67\uDD7A\uDD95\uDD96\uDDA4\uDDFB-\uDE4F\uDE80-\uDEC5\uDECC\uDED0-\uDED2\uDED5-\uDED7\uDEEB\uDEEC\uDEF4-\uDEFC\uDFE0-\uDFEB]|\uD83E[\uDD0C-\uDD3A\uDD3C-\uDD45\uDD47-\uDD78\uDD7A-\uDDCB\uDDCD-\uDDFF\uDE70-\uDE74\uDE78-\uDE7A\uDE80-\uDE86\uDE90-\uDEA8\uDEB0-\uDEB6\uDEC0-\uDEC2\uDED0-\uDED6])|(?:[#\*0-9\xA9\xAE\u203C\u2049\u2122\u2139\u2194-\u2199\u21A9\u21AA\u231A\u231B\u2328\u23CF\u23E9-\u23F3\u23F8-\u23FA\u24C2\u25AA\u25AB\u25B6\u25C0\u25FB-\u25FE\u2600-\u2604\u260E\u2611\u2614\u2615\u2618\u261D\u2620\u2622\u2623\u2626\u262A\u262E\u262F\u2638-\u263A\u2640\u2642\u2648-\u2653\u265F\u2660\u2663\u2665\u2666\u2668\u267B\u267E\u267F\u2692-\u2697\u2699\u269B\u269C\u26A0\u26A1\u26A7\u26AA\u26AB\u26B0\u26B1\u26BD\u26BE\u26C4\u26C5\u26C8\u26CE\u26CF\u26D1\u26D3\u26D4\u26E9\u26EA\u26F0-\u26F5\u26F7-\u26FA\u26FD\u2702\u2705\u2708-\u270D\u270F\u2712\u2714\u2716\u271D\u2721\u2728\u2733\u2734\u2744\u2747\u274C\u274E\u2753-\u2755\u2757\u2763\u2764\u2795-\u2797\u27A1\u27B0\u27BF\u2934\u2935\u2B05-\u2B07\u2B1B\u2B1C\u2B50\u2B55\u3030\u303D\u3297\u3299]|\uD83C[\uDC04\uDCCF\uDD70\uDD71\uDD7E\uDD7F\uDD8E\uDD91-\uDD9A\uDDE6-\uDDFF\uDE01\uDE02\uDE1A\uDE2F\uDE32-\uDE3A\uDE50\uDE51\uDF00-\uDF21\uDF24-\uDF93\uDF96\uDF97\uDF99-\uDF9B\uDF9E-\uDFF0\uDFF3-\uDFF5\uDFF7-\uDFFF]|\uD83D[\uDC00-\uDCFD\uDCFF-\uDD3D\uDD49-\uDD4E\uDD50-\uDD67\uDD6F\uDD70\uDD73-\uDD7A\uDD87\uDD8A-\uDD8D\uDD90\uDD95\uDD96\uDDA4\uDDA5\uDDA8\uDDB1\uDDB2\uDDBC\uDDC2-\uDDC4\uDDD1-\uDDD3\uDDDC-\uDDDE\uDDE1\uDDE3\uDDE8\uDDEF\uDDF3\uDDFA-\uDE4F\uDE80-\uDEC5\uDECB-\uDED2\uDED5-\uDED7\uDEE0-\uDEE5\uDEE9\uDEEB\uDEEC\uDEF0\uDEF3-\uDEFC\uDFE0-\uDFEB]|\uD83E[\uDD0C-\uDD3A\uDD3C-\uDD45\uDD47-\uDD78\uDD7A-\uDDCB\uDDCD-\uDDFF\uDE70-\uDE74\uDE78-\uDE7A\uDE80-\uDE86\uDE90-\uDEA8\uDEB0-\uDEB6\uDEC0-\uDEC2\uDED0-\uDED6])\uFE0F|(?:[\u261D\u26F9\u270A-\u270D]|\uD83C[\uDF85\uDFC2-\uDFC4\uDFC7\uDFCA-\uDFCC]|\uD83D[\uDC42\uDC43\uDC46-\uDC50\uDC66-\uDC78\uDC7C\uDC81-\uDC83\uDC85-\uDC87\uDC8F\uDC91\uDCAA\uDD74\uDD75\uDD7A\uDD90\uDD95\uDD96\uDE45-\uDE47\uDE4B-\uDE4F\uDEA3\uDEB4-\uDEB6\uDEC0\uDECC]|\uD83E[\uDD0C\uDD0F\uDD18-\uDD1F\uDD26\uDD30-\uDD39\uDD3C-\uDD3E\uDD77\uDDB5\uDDB6\uDDB8\uDDB9\uDDBB\uDDCD-\uDDCF\uDDD1-\uDDDD])/g; }; } }); var string_width_exports = {}; __export(string_width_exports, { default: () => stringWidth }); function stringWidth(string) { if (typeof string !== "string" || string.length === 0) { return 0; } string = stripAnsi(string); if (string.length === 0) { return 0; } string = string.replace((0, import_emoji_regex.default)(), " "); let width = 0; for (let index = 0; index < string.length; index++) { const codePoint = string.codePointAt(index); if (codePoint <= 31 || codePoint >= 127 && codePoint <= 159) { continue; } if (codePoint >= 768 && codePoint <= 879) { continue; } if (codePoint > 65535) { index++; } width += isFullwidthCodePoint(codePoint) ? 2 : 1; } return width; } var import_emoji_regex; var init_string_width = __esm({ "node_modules/string-width/index.js"() { init_define_process(); init_strip_ansi(); init_is_fullwidth_code_point(); import_emoji_regex = __toESM(require_emoji_regex()); } }); var require_get_string_width = __commonJS2({ "src/utils/get-string-width.js"(exports2, module2) { "use strict"; init_define_process(); var stringWidth2 = (init_string_width(), __toCommonJS(string_width_exports)).default; var notAsciiRegex = /[^\x20-\x7F]/; function getStringWidth(text) { if (!text) { return 0; } if (!notAsciiRegex.test(text)) { return text.length; } return stringWidth2(text); } module2.exports = getStringWidth; } }); var require_doc_utils = __commonJS2({ "src/document/doc-utils.js"(exports2, module2) { "use strict"; init_define_process(); var getLast = require_get_last(); var { literalline, join } = require_doc_builders(); var isConcat = (doc) => Array.isArray(doc) || doc && doc.type === "concat"; var getDocParts = (doc) => { if (Array.isArray(doc)) { return doc; } if (doc.type !== "concat" && doc.type !== "fill") { throw new Error("Expect doc type to be `concat` or `fill`."); } return doc.parts; }; var traverseDocOnExitStackMarker = {}; function traverseDoc(doc, onEnter, onExit, shouldTraverseConditionalGroups) { const docsStack = [doc]; while (docsStack.length > 0) { const doc2 = docsStack.pop(); if (doc2 === traverseDocOnExitStackMarker) { onExit(docsStack.pop()); continue; } if (onExit) { docsStack.push(doc2, traverseDocOnExitStackMarker); } if (!onEnter || onEnter(doc2) !== false) { if (isConcat(doc2) || doc2.type === "fill") { const parts = getDocParts(doc2); for (let ic = parts.length, i = ic - 1; i >= 0; --i) { docsStack.push(parts[i]); } } else if (doc2.type === "if-break") { if (doc2.flatContents) { docsStack.push(doc2.flatContents); } if (doc2.breakContents) { docsStack.push(doc2.breakContents); } } else if (doc2.type === "group" && doc2.expandedStates) { if (shouldTraverseConditionalGroups) { for (let ic = doc2.expandedStates.length, i = ic - 1; i >= 0; --i) { docsStack.push(doc2.expandedStates[i]); } } else { docsStack.push(doc2.contents); } } else if (doc2.contents) { docsStack.push(doc2.contents); } } } } function mapDoc(doc, cb) { const mapped = /* @__PURE__ */ new Map(); return rec(doc); function rec(doc2) { if (mapped.has(doc2)) { return mapped.get(doc2); } const result = process2(doc2); mapped.set(doc2, result); return result; } function process2(doc2) { if (Array.isArray(doc2)) { return cb(doc2.map(rec)); } if (doc2.type === "concat" || doc2.type === "fill") { const parts = doc2.parts.map(rec); return cb(Object.assign(Object.assign({}, doc2), {}, { parts })); } if (doc2.type === "if-break") { const breakContents = doc2.breakContents && rec(doc2.breakContents); const flatContents = doc2.flatContents && rec(doc2.flatContents); return cb(Object.assign(Object.assign({}, doc2), {}, { breakContents, flatContents })); } if (doc2.type === "group" && doc2.expandedStates) { const expandedStates = doc2.expandedStates.map(rec); const contents = expandedStates[0]; return cb(Object.assign(Object.assign({}, doc2), {}, { contents, expandedStates })); } if (doc2.contents) { const contents = rec(doc2.contents); return cb(Object.assign(Object.assign({}, doc2), {}, { contents })); } return cb(doc2); } } function findInDoc(doc, fn, defaultValue) { let result = defaultValue; let hasStopped = false; function findInDocOnEnterFn(doc2) { const maybeResult = fn(doc2); if (maybeResult !== void 0) { hasStopped = true; result = maybeResult; } if (hasStopped) { return false; } } traverseDoc(doc, findInDocOnEnterFn); return result; } function willBreakFn(doc) { if (doc.type === "group" && doc.break) { return true; } if (doc.type === "line" && doc.hard) { return true; } if (doc.type === "break-parent") { return true; } } function willBreak(doc) { return findInDoc(doc, willBreakFn, false); } function breakParentGroup(groupStack) { if (groupStack.length > 0) { const parentGroup = getLast(groupStack); if (!parentGroup.expandedStates && !parentGroup.break) { parentGroup.break = "propagated"; } } return null; } function propagateBreaks(doc) { const alreadyVisitedSet = /* @__PURE__ */ new Set(); const groupStack = []; function propagateBreaksOnEnterFn(doc2) { if (doc2.type === "break-parent") { breakParentGroup(groupStack); } if (doc2.type === "group") { groupStack.push(doc2); if (alreadyVisitedSet.has(doc2)) { return false; } alreadyVisitedSet.add(doc2); } } function propagateBreaksOnExitFn(doc2) { if (doc2.type === "group") { const group = groupStack.pop(); if (group.break) { breakParentGroup(groupStack); } } } traverseDoc(doc, propagateBreaksOnEnterFn, propagateBreaksOnExitFn, true); } function removeLinesFn(doc) { if (doc.type === "line" && !doc.hard) { return doc.soft ? "" : " "; } if (doc.type === "if-break") { return doc.flatContents || ""; } return doc; } function removeLines(doc) { return mapDoc(doc, removeLinesFn); } var isHardline = (doc, nextDoc) => doc && doc.type === "line" && doc.hard && nextDoc && nextDoc.type === "break-parent"; function stripDocTrailingHardlineFromDoc(doc) { if (!doc) { return doc; } if (isConcat(doc) || doc.type === "fill") { const parts = getDocParts(doc); while (parts.length > 1 && isHardline(...parts.slice(-2))) { parts.length -= 2; } if (parts.length > 0) { const lastPart = stripDocTrailingHardlineFromDoc(getLast(parts)); parts[parts.length - 1] = lastPart; } return Array.isArray(doc) ? parts : Object.assign(Object.assign({}, doc), {}, { parts }); } switch (doc.type) { case "align": case "indent": case "indent-if-break": case "group": case "line-suffix": case "label": { const contents = stripDocTrailingHardlineFromDoc(doc.contents); return Object.assign(Object.assign({}, doc), {}, { contents }); } case "if-break": { const breakContents = stripDocTrailingHardlineFromDoc(doc.breakContents); const flatContents = stripDocTrailingHardlineFromDoc(doc.flatContents); return Object.assign(Object.assign({}, doc), {}, { breakContents, flatContents }); } } return doc; } function stripTrailingHardline(doc) { return stripDocTrailingHardlineFromDoc(cleanDoc(doc)); } function cleanDocFn(doc) { switch (doc.type) { case "fill": if (doc.parts.every((part) => part === "")) { return ""; } break; case "group": if (!doc.contents && !doc.id && !doc.break && !doc.expandedStates) { return ""; } if (doc.contents.type === "group" && doc.contents.id === doc.id && doc.contents.break === doc.break && doc.contents.expandedStates === doc.expandedStates) { return doc.contents; } break; case "align": case "indent": case "indent-if-break": case "line-suffix": if (!doc.contents) { return ""; } break; case "if-break": if (!doc.flatContents && !doc.breakContents) { return ""; } break; } if (!isConcat(doc)) { return doc; } const parts = []; for (const part of getDocParts(doc)) { if (!part) { continue; } const [currentPart, ...restParts] = isConcat(part) ? getDocParts(part) : [part]; if (typeof currentPart === "string" && typeof getLast(parts) === "string") { parts[parts.length - 1] += currentPart; } else { parts.push(currentPart); } parts.push(...restParts); } if (parts.length === 0) { return ""; } if (parts.length === 1) { return parts[0]; } return Array.isArray(doc) ? parts : Object.assign(Object.assign({}, doc), {}, { parts }); } function cleanDoc(doc) { return mapDoc(doc, (currentDoc) => cleanDocFn(currentDoc)); } function normalizeParts(parts) { const newParts = []; const restParts = parts.filter(Boolean); while (restParts.length > 0) { const part = restParts.shift(); if (!part) { continue; } if (isConcat(part)) { restParts.unshift(...getDocParts(part)); continue; } if (newParts.length > 0 && typeof getLast(newParts) === "string" && typeof part === "string") { newParts[newParts.length - 1] += part; continue; } newParts.push(part); } return newParts; } function normalizeDoc(doc) { return mapDoc(doc, (currentDoc) => { if (Array.isArray(currentDoc)) { return normalizeParts(currentDoc); } if (!currentDoc.parts) { return currentDoc; } return Object.assign(Object.assign({}, currentDoc), {}, { parts: normalizeParts(currentDoc.parts) }); }); } function replaceEndOfLine(doc) { return mapDoc(doc, (currentDoc) => typeof currentDoc === "string" && currentDoc.includes("\n") ? replaceTextEndOfLine(currentDoc) : currentDoc); } function replaceTextEndOfLine(text) { let replacement = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : literalline; return join(replacement, text.split("\n")).parts; } function canBreakFn(doc) { if (doc.type === "line") { return true; } } function canBreak(doc) { return findInDoc(doc, canBreakFn, false); } module2.exports = { isConcat, getDocParts, willBreak, traverseDoc, findInDoc, mapDoc, propagateBreaks, removeLines, stripTrailingHardline, normalizeParts, normalizeDoc, cleanDoc, replaceTextEndOfLine, replaceEndOfLine, canBreak }; } }); var require_doc_printer = __commonJS2({ "src/document/doc-printer.js"(exports2, module2) { "use strict"; init_define_process(); var { convertEndOfLineToChars } = require_end_of_line(); var getLast = require_get_last(); var getStringWidth = require_get_string_width(); var { fill, cursor, indent } = require_doc_builders(); var { isConcat, getDocParts } = require_doc_utils(); var groupModeMap; var MODE_BREAK = 1; var MODE_FLAT = 2; function rootIndent() { return { value: "", length: 0, queue: [] }; } function makeIndent(ind, options) { return generateInd(ind, { type: "indent" }, options); } function makeAlign(indent2, widthOrDoc, options) { if (widthOrDoc === Number.NEGATIVE_INFINITY) { return indent2.root || rootIndent(); } if (widthOrDoc < 0) { return generateInd(indent2, { type: "dedent" }, options); } if (!widthOrDoc) { return indent2; } if (widthOrDoc.type === "root") { return Object.assign(Object.assign({}, indent2), {}, { root: indent2 }); } const alignType = typeof widthOrDoc === "string" ? "stringAlign" : "numberAlign"; return generateInd(indent2, { type: alignType, n: widthOrDoc }, options); } function generateInd(ind, newPart, options) { const queue = newPart.type === "dedent" ? ind.queue.slice(0, -1) : [...ind.queue, newPart]; let value = ""; let length = 0; let lastTabs = 0; let lastSpaces = 0; for (const part of queue) { switch (part.type) { case "indent": flush(); if (options.useTabs) { addTabs(1); } else { addSpaces(options.tabWidth); } break; case "stringAlign": flush(); value += part.n; length += part.n.length; break; case "numberAlign": lastTabs += 1; lastSpaces += part.n; break; default: throw new Error(`Unexpected type '${part.type}'`); } } flushSpaces(); return Object.assign(Object.assign({}, ind), {}, { value, length, queue }); function addTabs(count) { value += " ".repeat(count); length += options.tabWidth * count; } function addSpaces(count) { value += " ".repeat(count); length += count; } function flush() { if (options.useTabs) { flushTabs(); } else { flushSpaces(); } } function flushTabs() { if (lastTabs > 0) { addTabs(lastTabs); } resetLast(); } function flushSpaces() { if (lastSpaces > 0) { addSpaces(lastSpaces); } resetLast(); } function resetLast() { lastTabs = 0; lastSpaces = 0; } } function trim(out) { if (out.length === 0) { return 0; } let trimCount = 0; while (out.length > 0 && typeof getLast(out) === "string" && /^[\t ]*$/.test(getLast(out))) { trimCount += out.pop().length; } if (out.length > 0 && typeof getLast(out) === "string") { const trimmed = getLast(out).replace(/[\t ]*$/, ""); trimCount += getLast(out).length - trimmed.length; out[out.length - 1] = trimmed; } return trimCount; } function fits(next, restCommands, width, hasLineSuffix, mustBeFlat) { let restIdx = restCommands.length; const cmds = [next]; const out = []; while (width >= 0) { if (cmds.length === 0) { if (restIdx === 0) { return true; } cmds.push(restCommands[--restIdx]); continue; } const { mode, doc } = cmds.pop(); if (typeof doc === "string") { out.push(doc); width -= getStringWidth(doc); } else if (isConcat(doc) || doc.type === "fill") { const parts = getDocParts(doc); for (let i = parts.length - 1; i >= 0; i--) { cmds.push({ mode, doc: parts[i] }); } } else { switch (doc.type) { case "indent": case "align": case "indent-if-break": case "label": cmds.push({ mode, doc: doc.contents }); break; case "trim": width += trim(out); break; case "group": { if (mustBeFlat && doc.break) { return false; } const groupMode = doc.break ? MODE_BREAK : mode; const contents = doc.expandedStates && groupMode === MODE_BREAK ? getLast(doc.expandedStates) : doc.contents; cmds.push({ mode: groupMode, doc: contents }); break; } case "if-break": { const groupMode = doc.groupId ? groupModeMap[doc.groupId] || MODE_FLAT : mode; const contents = groupMode === MODE_BREAK ? doc.breakContents : doc.flatContents; if (contents) { cmds.push({ mode, doc: contents }); } break; } case "line": if (mode === MODE_BREAK || doc.hard) { return true; } if (!doc.soft) { out.push(" "); width--; } break; case "line-suffix": hasLineSuffix = true; break; case "line-suffix-boundary": if (hasLineSuffix) { return false; } break; } } } return false; } function printDocToString(doc, options) { groupModeMap = {}; const width = options.printWidth; const newLine = convertEndOfLineToChars(options.endOfLine); let pos = 0; const cmds = [{ ind: rootIndent(), mode: MODE_BREAK, doc }]; const out = []; let shouldRemeasure = false; const lineSuffix = []; while (cmds.length > 0) { const { ind, mode, doc: doc2 } = cmds.pop(); if (typeof doc2 === "string") { const formatted = newLine !== "\n" ? doc2.replace(/\n/g, newLine) : doc2; out.push(formatted); pos += getStringWidth(formatted); } else if (isConcat(doc2)) { const parts = getDocParts(doc2); for (let i = parts.length - 1; i >= 0; i--) { cmds.push({ ind, mode, doc: parts[i] }); } } else { switch (doc2.type) { case "cursor": out.push(cursor.placeholder); break; case "indent": cmds.push({ ind: makeIndent(ind, options), mode, doc: doc2.contents }); break; case "align": cmds.push({ ind: makeAlign(ind, doc2.n, options), mode, doc: doc2.contents }); break; case "trim": pos -= trim(out); break; case "group": switch (mode) { case MODE_FLAT: if (!shouldRemeasure) { cmds.push({ ind, mode: doc2.break ? MODE_BREAK : MODE_FLAT, doc: doc2.contents }); break; } case MODE_BREAK: { shouldRemeasure = false; const next = { ind, mode: MODE_FLAT, doc: doc2.contents }; const rem = width - pos; const hasLineSuffix = lineSuffix.length > 0; if (!doc2.break && fits(next, cmds, rem, hasLineSuffix)) { cmds.push(next); } else { if (doc2.expandedStates) { const mostExpanded = getLast(doc2.expandedStates); if (doc2.break) { cmds.push({ ind, mode: MODE_BREAK, doc: mostExpanded }); break; } else { for (let i = 1; i < doc2.expandedStates.length + 1; i++) { if (i >= doc2.expandedStates.length) { cmds.push({ ind, mode: MODE_BREAK, doc: mostExpanded }); break; } else { const state = doc2.expandedStates[i]; const cmd = { ind, mode: MODE_FLAT, doc: state }; if (fits(cmd, cmds, rem, hasLineSuffix)) { cmds.push(cmd); break; } } } } } else { cmds.push({ ind, mode: MODE_BREAK, doc: doc2.contents }); } } break; } } if (doc2.id) { groupModeMap[doc2.id] = getLast(cmds).mode; } break; case "fill": { const rem = width - pos; const { parts } = doc2; if (parts.length === 0) { break; } const [content, whitespace] = parts; const contentFlatCmd = { ind, mode: MODE_FLAT, doc: content }; const contentBreakCmd = { ind, mode: MODE_BREAK, doc: content }; const contentFits = fits(contentFlatCmd, [], rem, lineSuffix.length > 0, true); if (parts.length === 1) { if (contentFits) { cmds.push(contentFlatCmd); } else { cmds.push(contentBreakCmd); } break; } const whitespaceFlatCmd = { ind, mode: MODE_FLAT, doc: whitespace }; const whitespaceBreakCmd = { ind, mode: MODE_BREAK, doc: whitespace }; if (parts.length === 2) { if (contentFits) { cmds.push(whitespaceFlatCmd, contentFlatCmd); } else { cmds.push(whitespaceBreakCmd, contentBreakCmd); } break; } parts.splice(0, 2); const remainingCmd = { ind, mode, doc: fill(parts) }; const secondContent = parts[0]; const firstAndSecondContentFlatCmd = { ind, mode: MODE_FLAT, doc: [content, whitespace, secondContent] }; const firstAndSecondContentFits = fits(firstAndSecondContentFlatCmd, [], rem, lineSuffix.length > 0, true); if (firstAndSecondContentFits) { cmds.push(remainingCmd, whitespaceFlatCmd, contentFlatCmd); } else if (contentFits) { cmds.push(remainingCmd, whitespaceBreakCmd, contentFlatCmd); } else { cmds.push(remainingCmd, whitespaceBreakCmd, contentBreakCmd); } break; } case "if-break": case "indent-if-break": { const groupMode = doc2.groupId ? groupModeMap[doc2.groupId] : mode; if (groupMode === MODE_BREAK) { const breakContents = doc2.type === "if-break" ? doc2.breakContents : doc2.negate ? doc2.contents : indent(doc2.contents); if (breakContents) { cmds.push({ ind, mode, doc: breakContents }); } } if (groupMode === MODE_FLAT) { const flatContents = doc2.type === "if-break" ? doc2.flatContents : doc2.negate ? indent(doc2.contents) : doc2.contents; if (flatContents) { cmds.push({ ind, mode, doc: flatContents }); } } break; } case "line-suffix": lineSuffix.push({ ind, mode, doc: doc2.contents }); break; case "line-suffix-boundary": if (lineSuffix.length > 0) { cmds.push({ ind, mode, doc: { type: "line", hard: true } }); } break; case "line": switch (mode) { case MODE_FLAT: if (!doc2.hard) { if (!doc2.soft) { out.push(" "); pos += 1; } break; } else { shouldRemeasure = true; } case MODE_BREAK: if (lineSuffix.length > 0) { cmds.push({ ind, mode, doc: doc2 }, ...lineSuffix.reverse()); lineSuffix.length = 0; break; } if (doc2.literal) { if (ind.root) { out.push(newLine, ind.root.value); pos = ind.root.length; } else { out.push(newLine); pos = 0; } } else { pos -= trim(out); out.push(newLine + ind.value); pos = ind.length; } break; } break; case "label": cmds.push({ ind, mode, doc: doc2.contents }); break; default: } } if (cmds.length === 0 && lineSuffix.length > 0) { cmds.push(...lineSuffix.reverse()); lineSuffix.length = 0; } } const cursorPlaceholderIndex = out.indexOf(cursor.placeholder); if (cursorPlaceholderIndex !== -1) { const otherCursorPlaceholderIndex = out.indexOf(cursor.placeholder, cursorPlaceholderIndex + 1); const beforeCursor = out.slice(0, cursorPlaceholderIndex).join(""); const aroundCursor = out.slice(cursorPlaceholderIndex + 1, otherCursorPlaceholderIndex).join(""); const afterCursor = out.slice(otherCursorPlaceholderIndex + 1).join(""); return { formatted: beforeCursor + aroundCursor + afterCursor, cursorNodeStart: beforeCursor.length, cursorNodeText: aroundCursor }; } return { formatted: out.join("") }; } module2.exports = { printDocToString }; } }); var require_doc_debug = __commonJS2({ "src/document/doc-debug.js"(exports2, module2) { "use strict"; init_define_process(); var { isConcat, getDocParts } = require_doc_utils(); function flattenDoc(doc) { if (!doc) { return ""; } if (isConcat(doc)) { const res = []; for (const part of getDocParts(doc)) { if (isConcat(part)) { res.push(...flattenDoc(part).parts); } else { const flattened = flattenDoc(part); if (flattened !== "") { res.push(flattened); } } } return { type: "concat", parts: res }; } if (doc.type === "if-break") { return Object.assign(Object.assign({}, doc), {}, { breakContents: flattenDoc(doc.breakContents), flatContents: flattenDoc(doc.flatContents) }); } if (doc.type === "group") { return Object.assign(Object.assign({}, doc), {}, { contents: flattenDoc(doc.contents), expandedStates: doc.expandedStates && doc.expandedStates.map(flattenDoc) }); } if (doc.type === "fill") { return { type: "fill", parts: doc.parts.map(flattenDoc) }; } if (doc.contents) { return Object.assign(Object.assign({}, doc), {}, { contents: flattenDoc(doc.contents) }); } return doc; } function printDocToDebug(doc) { const printedSymbols = /* @__PURE__ */ Object.create(null); const usedKeysForSymbols = /* @__PURE__ */ new Set(); return printDoc(flattenDoc(doc)); function printDoc(doc2, index, parentParts) { if (typeof doc2 === "string") { return JSON.stringify(doc2); } if (isConcat(doc2)) { const printed = getDocParts(doc2).map(printDoc).filter(Boolean); return printed.length === 1 ? printed[0] : `[${printed.join(", ")}]`; } if (doc2.type === "line") { const withBreakParent = Array.isArray(parentParts) && parentParts[index + 1] && parentParts[index + 1].type === "break-parent"; if (doc2.literal) { return withBreakParent ? "literalline" : "literallineWithoutBreakParent"; } if (doc2.hard) { return withBreakParent ? "hardline" : "hardlineWithoutBreakParent"; } if (doc2.soft) { return "softline"; } return "line"; } if (doc2.type === "break-parent") { const afterHardline = Array.isArray(parentParts) && parentParts[index - 1] && parentParts[index - 1].type === "line" && parentParts[index - 1].hard; return afterHardline ? void 0 : "breakParent"; } if (doc2.type === "trim") { return "trim"; } if (doc2.type === "indent") { return "indent(" + printDoc(doc2.contents) + ")"; } if (doc2.type === "align") { return doc2.n === Number.NEGATIVE_INFINITY ? "dedentToRoot(" + printDoc(doc2.contents) + ")" : doc2.n < 0 ? "dedent(" + printDoc(doc2.contents) + ")" : doc2.n.type === "root" ? "markAsRoot(" + printDoc(doc2.contents) + ")" : "align(" + JSON.stringify(doc2.n) + ", " + printDoc(doc2.contents) + ")"; } if (doc2.type === "if-break") { return "ifBreak(" + printDoc(doc2.breakContents) + (doc2.flatContents ? ", " + printDoc(doc2.flatContents) : "") + (doc2.groupId ? (!doc2.flatContents ? ', ""' : "") + `, { groupId: ${printGroupId(doc2.groupId)} }` : "") + ")"; } if (doc2.type === "indent-if-break") { const optionsParts = []; if (doc2.negate) { optionsParts.push("negate: true"); } if (doc2.groupId) { optionsParts.push(`groupId: ${printGroupId(doc2.groupId)}`); } const options = optionsParts.length > 0 ? `, { ${optionsParts.join(", ")} }` : ""; return `indentIfBreak(${printDoc(doc2.contents)}${options})`; } if (doc2.type === "group") { const optionsParts = []; if (doc2.break && doc2.break !== "propagated") { optionsParts.push("shouldBreak: true"); } if (doc2.id) { optionsParts.push(`id: ${printGroupId(doc2.id)}`); } const options = optionsParts.length > 0 ? `, { ${optionsParts.join(", ")} }` : ""; if (doc2.expandedStates) { return `conditionalGroup([${doc2.expandedStates.map((part) => printDoc(part)).join(",")}]${options})`; } return `group(${printDoc(doc2.contents)}${options})`; } if (doc2.type === "fill") { return `fill([${doc2.parts.map((part) => printDoc(part)).join(", ")}])`; } if (doc2.type === "line-suffix") { return "lineSuffix(" + printDoc(doc2.contents) + ")"; } if (doc2.type === "line-suffix-boundary") { return "lineSuffixBoundary"; } if (doc2.type === "label") { return `label(${JSON.stringify(doc2.label)}, ${printDoc(doc2.contents)})`; } throw new Error("Unknown doc type " + doc2.type); } function printGroupId(id) { if (typeof id !== "symbol") { return JSON.stringify(String(id)); } if (id in printedSymbols) { return printedSymbols[id]; } const prefix = String(id).slice(7, -1) || "symbol"; for (let counter = 0; ; counter++) { const key = prefix + (counter > 0 ? ` #${counter}` : ""); if (!usedKeysForSymbols.has(key)) { usedKeysForSymbols.add(key); return printedSymbols[id] = `Symbol.for(${JSON.stringify(key)})`; } } } } module2.exports = { printDocToDebug }; } }); init_define_process(); module.exports = { builders: require_doc_builders(), printer: require_doc_printer(), utils: require_doc_utils(), debug: require_doc_debug() }; } }); return require_doc_js_umd();/** * The `node:child_process` module provides the ability to spawn subprocesses in * a manner that is similar, but not identical, to [`popen(3)`](http://man7.org/linux/man-pages/man3/popen.3.html). This capability * is primarily provided by the {@link spawn} function: * * ```js * const { spawn } = require('node:child_process'); * const ls = spawn('ls', ['-lh', '/usr']); * * ls.stdout.on('data', (data) => { * console.log(`stdout: ${data}`); * }); * * ls.stderr.on('data', (data) => { * console.error(`stderr: ${data}`); * }); * * ls.on('close', (code) => { * console.log(`child process exited with code ${code}`); * }); * ``` * * By default, pipes for `stdin`, `stdout`, and `stderr` are established between * the parent Node.js process and the spawned subprocess. These pipes have * limited (and platform-specific) capacity. If the subprocess writes to * stdout in excess of that limit without the output being captured, the * subprocess blocks waiting for the pipe buffer to accept more data. This is * identical to the behavior of pipes in the shell. Use the `{ stdio: 'ignore' }`option if the output will not be consumed. * * The command lookup is performed using the `options.env.PATH` environment * variable if `env` is in the `options` object. Otherwise, `process.env.PATH` is * used. If `options.env` is set without `PATH`, lookup on Unix is performed * on a default search path search of `/usr/bin:/bin` (see your operating system's * manual for execvpe/execvp), on Windows the current processes environment * variable `PATH` is used. * * On Windows, environment variables are case-insensitive. Node.js * lexicographically sorts the `env` keys and uses the first one that * case-insensitively matches. Only first (in lexicographic order) entry will be * passed to the subprocess. This might lead to issues on Windows when passing * objects to the `env` option that have multiple variants of the same key, such as`PATH` and `Path`. * * The {@link spawn} method spawns the child process asynchronously, * without blocking the Node.js event loop. The {@link spawnSync} function provides equivalent functionality in a synchronous manner that blocks * the event loop until the spawned process either exits or is terminated. * * For convenience, the `node:child_process` module provides a handful of * synchronous and asynchronous alternatives to {@link spawn} and {@link spawnSync}. Each of these alternatives are implemented on * top of {@link spawn} or {@link spawnSync}. * * * {@link exec}: spawns a shell and runs a command within that * shell, passing the `stdout` and `stderr` to a callback function when * complete. * * {@link execFile}: similar to {@link exec} except * that it spawns the command directly without first spawning a shell by * default. * * {@link fork}: spawns a new Node.js process and invokes a * specified module with an IPC communication channel established that allows * sending messages between parent and child. * * {@link execSync}: a synchronous version of {@link exec} that will block the Node.js event loop. * * {@link execFileSync}: a synchronous version of {@link execFile} that will block the Node.js event loop. * * For certain use cases, such as automating shell scripts, the `synchronous counterparts` may be more convenient. In many cases, however, * the synchronous methods can have significant impact on performance due to * stalling the event loop while spawned processes complete. * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/child_process.js) */ declare module "child_process" { import { ObjectEncodingOptions } from "node:fs"; import { Abortable, EventEmitter } from "node:events"; import * as net from "node:net"; import { Pipe, Readable, Stream, Writable } from "node:stream"; import { URL } from "node:url"; type Serializable = string | object | number | boolean | bigint; type SendHandle = net.Socket | net.Server; /** * Instances of the `ChildProcess` represent spawned child processes. * * Instances of `ChildProcess` are not intended to be created directly. Rather, * use the {@link spawn}, {@link exec},{@link execFile}, or {@link fork} methods to create * instances of `ChildProcess`. * @since v2.2.0 */ class ChildProcess extends EventEmitter { /** * A `Writable Stream` that represents the child process's `stdin`. * * If a child process waits to read all of its input, the child will not continue * until this stream has been closed via `end()`. * * If the child was spawned with `stdio[0]` set to anything other than `'pipe'`, * then this will be `null`. * * `subprocess.stdin` is an alias for `subprocess.stdio[0]`. Both properties will * refer to the same value. * * The `subprocess.stdin` property can be `null` or `undefined`if the child process could not be successfully spawned. * @since v0.1.90 */ stdin: Writable | null; /** * A `Readable Stream` that represents the child process's `stdout`. * * If the child was spawned with `stdio[1]` set to anything other than `'pipe'`, * then this will be `null`. * * `subprocess.stdout` is an alias for `subprocess.stdio[1]`. Both properties will * refer to the same value. * * ```js * const { spawn } = require('node:child_process'); * * const subprocess = spawn('ls'); * * subprocess.stdout.on('data', (data) => { * console.log(`Received chunk ${data}`); * }); * ``` * * The `subprocess.stdout` property can be `null` or `undefined`if the child process could not be successfully spawned. * @since v0.1.90 */ stdout: Readable | null; /** * A `Readable Stream` that represents the child process's `stderr`. * * If the child was spawned with `stdio[2]` set to anything other than `'pipe'`, * then this will be `null`. * * `subprocess.stderr` is an alias for `subprocess.stdio[2]`. Both properties will * refer to the same value. * * The `subprocess.stderr` property can be `null` or `undefined`if the child process could not be successfully spawned. * @since v0.1.90 */ stderr: Readable | null; /** * The `subprocess.channel` property is a reference to the child's IPC channel. If * no IPC channel exists, this property is `undefined`. * @since v7.1.0 */ readonly channel?: Pipe | null | undefined; /** * A sparse array of pipes to the child process, corresponding with positions in * the `stdio` option passed to {@link spawn} that have been set * to the value `'pipe'`. `subprocess.stdio[0]`, `subprocess.stdio[1]`, and`subprocess.stdio[2]` are also available as `subprocess.stdin`,`subprocess.stdout`, and `subprocess.stderr`, * respectively. * * In the following example, only the child's fd `1` (stdout) is configured as a * pipe, so only the parent's `subprocess.stdio[1]` is a stream, all other values * in the array are `null`. * * ```js * const assert = require('node:assert'); * const fs = require('node:fs'); * const child_process = require('node:child_process'); * * const subprocess = child_process.spawn('ls', { * stdio: [ * 0, // Use parent's stdin for child. * 'pipe', // Pipe child's stdout to parent. * fs.openSync('err.out', 'w'), // Direct child's stderr to a file. * ], * }); * * assert.strictEqual(subprocess.stdio[0], null); * assert.strictEqual(subprocess.stdio[0], subprocess.stdin); * * assert(subprocess.stdout); * assert.strictEqual(subprocess.stdio[1], subprocess.stdout); * * assert.strictEqual(subprocess.stdio[2], null); * assert.strictEqual(subprocess.stdio[2], subprocess.stderr); * ``` * * The `subprocess.stdio` property can be `undefined` if the child process could * not be successfully spawned. * @since v0.7.10 */ readonly stdio: [ Writable | null, // stdin Readable | null, // stdout Readable | null, // stderr Readable | Writable | null | undefined, // extra Readable | Writable | null | undefined, // extra ]; /** * The `subprocess.killed` property indicates whether the child process * successfully received a signal from `subprocess.kill()`. The `killed` property * does not indicate that the child process has been terminated. * @since v0.5.10 */ readonly killed: boolean; /** * Returns the process identifier (PID) of the child process. If the child process * fails to spawn due to errors, then the value is `undefined` and `error` is * emitted. * * ```js * const { spawn } = require('node:child_process'); * const grep = spawn('grep', ['ssh']); * * console.log(`Spawned child pid: ${grep.pid}`); * grep.stdin.end(); * ``` * @since v0.1.90 */ readonly pid?: number | undefined; /** * The `subprocess.connected` property indicates whether it is still possible to * send and receive messages from a child process. When `subprocess.connected` is`false`, it is no longer possible to send or receive messages. * @since v0.7.2 */ readonly connected: boolean; /** * The `subprocess.exitCode` property indicates the exit code of the child process. * If the child process is still running, the field will be `null`. */ readonly exitCode: number | null; /** * The `subprocess.signalCode` property indicates the signal received by * the child process if any, else `null`. */ readonly signalCode: NodeJS.Signals | null; /** * The `subprocess.spawnargs` property represents the full list of command-line * arguments the child process was launched with. */ readonly spawnargs: string[]; /** * The `subprocess.spawnfile` property indicates the executable file name of * the child process that is launched. * * For {@link fork}, its value will be equal to `process.execPath`. * For {@link spawn}, its value will be the name of * the executable file. * For {@link exec}, its value will be the name of the shell * in which the child process is launched. */ readonly spawnfile: string; /** * The `subprocess.kill()` method sends a signal to the child process. If no * argument is given, the process will be sent the `'SIGTERM'` signal. See [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html) for a list of available signals. This function * returns `true` if [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) succeeds, and `false` otherwise. * * ```js * const { spawn } = require('node:child_process'); * const grep = spawn('grep', ['ssh']); * * grep.on('close', (code, signal) => { * console.log( * `child process terminated due to receipt of signal ${signal}`); * }); * * // Send SIGHUP to process. * grep.kill('SIGHUP'); * ``` * * The `ChildProcess` object may emit an `'error'` event if the signal * cannot be delivered. Sending a signal to a child process that has already exited * is not an error but may have unforeseen consequences. Specifically, if the * process identifier (PID) has been reassigned to another process, the signal will * be delivered to that process instead which can have unexpected results. * * While the function is called `kill`, the signal delivered to the child process * may not actually terminate the process. * * See [`kill(2)`](http://man7.org/linux/man-pages/man2/kill.2.html) for reference. * * On Windows, where POSIX signals do not exist, the `signal` argument will be * ignored, and the process will be killed forcefully and abruptly (similar to`'SIGKILL'`). * See `Signal Events` for more details. * * On Linux, child processes of child processes will not be terminated * when attempting to kill their parent. This is likely to happen when running a * new process in a shell or with the use of the `shell` option of `ChildProcess`: * * ```js * 'use strict'; * const { spawn } = require('node:child_process'); * * const subprocess = spawn( * 'sh', * [ * '-c', * `node -e "setInterval(() => { * console.log(process.pid, 'is alive') * }, 500);"`, * ], { * stdio: ['inherit', 'inherit', 'inherit'], * }, * ); * * setTimeout(() => { * subprocess.kill(); // Does not terminate the Node.js process in the shell. * }, 2000); * ``` * @since v0.1.90 */ kill(signal?: NodeJS.Signals | number): boolean; /** * Calls {@link ChildProcess.kill} with `'SIGTERM'`. * @since v20.5.0 */ [Symbol.dispose](): void; /** * When an IPC channel has been established between the parent and child ( * i.e. when using {@link fork}), the `subprocess.send()` method can * be used to send messages to the child process. When the child process is a * Node.js instance, these messages can be received via the `'message'` event. * * The message goes through serialization and parsing. The resulting * message might not be the same as what is originally sent. * * For example, in the parent script: * * ```js * const cp = require('node:child_process'); * const n = cp.fork(`${__dirname}/sub.js`); * * n.on('message', (m) => { * console.log('PARENT got message:', m); * }); * * // Causes the child to print: CHILD got message: { hello: 'world' } * n.send({ hello: 'world' }); * ``` * * And then the child script, `'sub.js'` might look like this: * * ```js * process.on('message', (m) => { * console.log('CHILD got message:', m); * }); * * // Causes the parent to print: PARENT got message: { foo: 'bar', baz: null } * process.send({ foo: 'bar', baz: NaN }); * ``` * * Child Node.js processes will have a `process.send()` method of their own * that allows the child to send messages back to the parent. * * There is a special case when sending a `{cmd: 'NODE_foo'}` message. Messages * containing a `NODE_` prefix in the `cmd` property are reserved for use within * Node.js core and will not be emitted in the child's `'message'` event. Rather, such messages are emitted using the`'internalMessage'` event and are consumed internally by Node.js. * Applications should avoid using such messages or listening for`'internalMessage'` events as it is subject to change without notice. * * The optional `sendHandle` argument that may be passed to `subprocess.send()` is * for passing a TCP server or socket object to the child process. The child will * receive the object as the second argument passed to the callback function * registered on the `'message'` event. Any data that is received * and buffered in the socket will not be sent to the child. * * The optional `callback` is a function that is invoked after the message is * sent but before the child may have received it. The function is called with a * single argument: `null` on success, or an `Error` object on failure. * * If no `callback` function is provided and the message cannot be sent, an`'error'` event will be emitted by the `ChildProcess` object. This can * happen, for instance, when the child process has already exited. * * `subprocess.send()` will return `false` if the channel has closed or when the * backlog of unsent messages exceeds a threshold that makes it unwise to send * more. Otherwise, the method returns `true`. The `callback` function can be * used to implement flow control. * * #### Example: sending a server object * * The `sendHandle` argument can be used, for instance, to pass the handle of * a TCP server object to the child process as illustrated in the example below: * * ```js * const subprocess = require('node:child_process').fork('subprocess.js'); * * // Open up the server object and send the handle. * const server = require('node:net').createServer(); * server.on('connection', (socket) => { * socket.end('handled by parent'); * }); * server.listen(1337, () => { * subprocess.send('server', server); * }); * ``` * * The child would then receive the server object as: * * ```js * process.on('message', (m, server) => { * if (m === 'server') { * server.on('connection', (socket) => { * socket.end('handled by child'); * }); * } * }); * ``` * * Once the server is now shared between the parent and child, some connections * can be handled by the parent and some by the child. * * While the example above uses a server created using the `node:net` module,`node:dgram` module servers use exactly the same workflow with the exceptions of * listening on a `'message'` event instead of `'connection'` and using`server.bind()` instead of `server.listen()`. This is, however, only * supported on Unix platforms. * * #### Example: sending a socket object * * Similarly, the `sendHandler` argument can be used to pass the handle of a * socket to the child process. The example below spawns two children that each * handle connections with "normal" or "special" priority: * * ```js * const { fork } = require('node:child_process'); * const normal = fork('subprocess.js', ['normal']); * const special = fork('subprocess.js', ['special']); * * // Open up the server and send sockets to child. Use pauseOnConnect to prevent * // the sockets from being read before they are sent to the child process. * const server = require('node:net').createServer({ pauseOnConnect: true }); * server.on('connection', (socket) => { * * // If this is special priority... * if (socket.remoteAddress === '74.125.127.100') { * special.send('socket', socket); * return; * } * // This is normal priority. * normal.send('socket', socket); * }); * server.listen(1337); * ``` * * The `subprocess.js` would receive the socket handle as the second argument * passed to the event callback function: * * ```js * process.on('message', (m, socket) => { * if (m === 'socket') { * if (socket) { * // Check that the client socket exists. * // It is possible for the socket to be closed between the time it is * // sent and the time it is received in the child process. * socket.end(`Request handled with ${process.argv[2]} priority`); * } * } * }); * ``` * * Do not use `.maxConnections` on a socket that has been passed to a subprocess. * The parent cannot track when the socket is destroyed. * * Any `'message'` handlers in the subprocess should verify that `socket` exists, * as the connection may have been closed during the time it takes to send the * connection to the child. * @since v0.5.9 * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties: */ send(message: Serializable, callback?: (error: Error | null) => void): boolean; send(message: Serializable, sendHandle?: SendHandle, callback?: (error: Error | null) => void): boolean; send( message: Serializable, sendHandle?: SendHandle, options?: MessageOptions, callback?: (error: Error | null) => void, ): boolean; /** * Closes the IPC channel between parent and child, allowing the child to exit * gracefully once there are no other connections keeping it alive. After calling * this method the `subprocess.connected` and `process.connected` properties in * both the parent and child (respectively) will be set to `false`, and it will be * no longer possible to pass messages between the processes. * * The `'disconnect'` event will be emitted when there are no messages in the * process of being received. This will most often be triggered immediately after * calling `subprocess.disconnect()`. * * When the child process is a Node.js instance (e.g. spawned using {@link fork}), the `process.disconnect()` method can be invoked * within the child process to close the IPC channel as well. * @since v0.7.2 */ disconnect(): void; /** * By default, the parent will wait for the detached child to exit. To prevent the * parent from waiting for a given `subprocess` to exit, use the`subprocess.unref()` method. Doing so will cause the parent's event loop to not * include the child in its reference count, allowing the parent to exit * independently of the child, unless there is an established IPC channel between * the child and the parent. * * ```js * const { spawn } = require('node:child_process'); * * const subprocess = spawn(process.argv[0], ['child_program.js'], { * detached: true, * stdio: 'ignore', * }); * * subprocess.unref(); * ``` * @since v0.7.10 */ unref(): void; /** * Calling `subprocess.ref()` after making a call to `subprocess.unref()` will * restore the removed reference count for the child process, forcing the parent * to wait for the child to exit before exiting itself. * * ```js * const { spawn } = require('node:child_process'); * * const subprocess = spawn(process.argv[0], ['child_program.js'], { * detached: true, * stdio: 'ignore', * }); * * subprocess.unref(); * subprocess.ref(); * ``` * @since v0.7.10 */ ref(): void; /** * events.EventEmitter * 1. close * 2. disconnect * 3. error * 4. exit * 5. message * 6. spawn */ addListener(event: string, listener: (...args: any[]) => void): this; addListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; addListener(event: "disconnect", listener: () => void): this; addListener(event: "error", listener: (err: Error) => void): this; addListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; addListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; addListener(event: "spawn", listener: () => void): this; emit(event: string | symbol, ...args: any[]): boolean; emit(event: "close", code: number | null, signal: NodeJS.Signals | null): boolean; emit(event: "disconnect"): boolean; emit(event: "error", err: Error): boolean; emit(event: "exit", code: number | null, signal: NodeJS.Signals | null): boolean; emit(event: "message", message: Serializable, sendHandle: SendHandle): boolean; emit(event: "spawn", listener: () => void): boolean; on(event: string, listener: (...args: any[]) => void): this; on(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; on(event: "disconnect", listener: () => void): this; on(event: "error", listener: (err: Error) => void): this; on(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; on(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; on(event: "spawn", listener: () => void): this; once(event: string, listener: (...args: any[]) => void): this; once(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; once(event: "disconnect", listener: () => void): this; once(event: "error", listener: (err: Error) => void): this; once(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; once(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; once(event: "spawn", listener: () => void): this; prependListener(event: string, listener: (...args: any[]) => void): this; prependListener(event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; prependListener(event: "disconnect", listener: () => void): this; prependListener(event: "error", listener: (err: Error) => void): this; prependListener(event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void): this; prependListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; prependListener(event: "spawn", listener: () => void): this; prependOnceListener(event: string, listener: (...args: any[]) => void): this; prependOnceListener( event: "close", listener: (code: number | null, signal: NodeJS.Signals | null) => void, ): this; prependOnceListener(event: "disconnect", listener: () => void): this; prependOnceListener(event: "error", listener: (err: Error) => void): this; prependOnceListener( event: "exit", listener: (code: number | null, signal: NodeJS.Signals | null) => void, ): this; prependOnceListener(event: "message", listener: (message: Serializable, sendHandle: SendHandle) => void): this; prependOnceListener(event: "spawn", listener: () => void): this; } // return this object when stdio option is undefined or not specified interface ChildProcessWithoutNullStreams extends ChildProcess { stdin: Writable; stdout: Readable; stderr: Readable; readonly stdio: [ Writable, Readable, Readable, // stderr Readable | Writable | null | undefined, // extra, no modification Readable | Writable | null | undefined, // extra, no modification ]; } // return this object when stdio option is a tuple of 3 interface ChildProcessByStdio extends ChildProcess { stdin: I; stdout: O; stderr: E; readonly stdio: [ I, O, E, Readable | Writable | null | undefined, // extra, no modification Readable | Writable | null | undefined, // extra, no modification ]; } interface MessageOptions { keepOpen?: boolean | undefined; } type IOType = "overlapped" | "pipe" | "ignore" | "inherit"; type StdioOptions = IOType | Array; type SerializationType = "json" | "advanced"; interface MessagingOptions extends Abortable { /** * Specify the kind of serialization used for sending messages between processes. * @default 'json' */ serialization?: SerializationType | undefined; /** * The signal value to be used when the spawned process will be killed by the abort signal. * @default 'SIGTERM' */ killSignal?: NodeJS.Signals | number | undefined; /** * In milliseconds the maximum amount of time the process is allowed to run. */ timeout?: number | undefined; } interface ProcessEnvOptions { uid?: number | undefined; gid?: number | undefined; cwd?: string | URL | undefined; env?: NodeJS.ProcessEnv | undefined; } interface CommonOptions extends ProcessEnvOptions { /** * @default false */ windowsHide?: boolean | undefined; /** * @default 0 */ timeout?: number | undefined; } interface CommonSpawnOptions extends CommonOptions, MessagingOptions, Abortable { argv0?: string | undefined; /** * Can be set to 'pipe', 'inherit', 'overlapped', or 'ignore', or an array of these strings. * If passed as an array, the first element is used for `stdin`, the second for * `stdout`, and the third for `stderr`. A fourth element can be used to * specify the `stdio` behavior beyond the standard streams. See * {@link ChildProcess.stdio} for more information. * * @default 'pipe' */ stdio?: StdioOptions | undefined; shell?: boolean | string | undefined; windowsVerbatimArguments?: boolean | undefined; } interface SpawnOptions extends CommonSpawnOptions { detached?: boolean | undefined; } interface SpawnOptionsWithoutStdio extends SpawnOptions { stdio?: StdioPipeNamed | StdioPipe[] | undefined; } type StdioNull = "inherit" | "ignore" | Stream; type StdioPipeNamed = "pipe" | "overlapped"; type StdioPipe = undefined | null | StdioPipeNamed; interface SpawnOptionsWithStdioTuple< Stdin extends StdioNull | StdioPipe, Stdout extends StdioNull | StdioPipe, Stderr extends StdioNull | StdioPipe, > extends SpawnOptions { stdio: [Stdin, Stdout, Stderr]; } /** * The `child_process.spawn()` method spawns a new process using the given`command`, with command-line arguments in `args`. If omitted, `args` defaults * to an empty array. * * **If the `shell` option is enabled, do not pass unsanitized user input to this** * **function. Any input containing shell metacharacters may be used to trigger** * **arbitrary command execution.** * * A third argument may be used to specify additional options, with these defaults: * * ```js * const defaults = { * cwd: undefined, * env: process.env, * }; * ``` * * Use `cwd` to specify the working directory from which the process is spawned. * If not given, the default is to inherit the current working directory. If given, * but the path does not exist, the child process emits an `ENOENT` error * and exits immediately. `ENOENT` is also emitted when the command * does not exist. * * Use `env` to specify environment variables that will be visible to the new * process, the default is `process.env`. * * `undefined` values in `env` will be ignored. * * Example of running `ls -lh /usr`, capturing `stdout`, `stderr`, and the * exit code: * * ```js * const { spawn } = require('node:child_process'); * const ls = spawn('ls', ['-lh', '/usr']); * * ls.stdout.on('data', (data) => { * console.log(`stdout: ${data}`); * }); * * ls.stderr.on('data', (data) => { * console.error(`stderr: ${data}`); * }); * * ls.on('close', (code) => { * console.log(`child process exited with code ${code}`); * }); * ``` * * Example: A very elaborate way to run `ps ax | grep ssh` * * ```js * const { spawn } = require('node:child_process'); * const ps = spawn('ps', ['ax']); * const grep = spawn('grep', ['ssh']); * * ps.stdout.on('data', (data) => { * grep.stdin.write(data); * }); * * ps.stderr.on('data', (data) => { * console.error(`ps stderr: ${data}`); * }); * * ps.on('close', (code) => { * if (code !== 0) { * console.log(`ps process exited with code ${code}`); * } * grep.stdin.end(); * }); * * grep.stdout.on('data', (data) => { * console.log(data.toString()); * }); * * grep.stderr.on('data', (data) => { * console.error(`grep stderr: ${data}`); * }); * * grep.on('close', (code) => { * if (code !== 0) { * console.log(`grep process exited with code ${code}`); * } * }); * ``` * * Example of checking for failed `spawn`: * * ```js * const { spawn } = require('node:child_process'); * const subprocess = spawn('bad_command'); * * subprocess.on('error', (err) => { * console.error('Failed to start subprocess.'); * }); * ``` * * Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process * title while others (Windows, SunOS) will use `command`. * * Node.js overwrites `argv[0]` with `process.execPath` on startup, so`process.argv[0]` in a Node.js child process will not match the `argv0`parameter passed to `spawn` from the parent. Retrieve * it with the`process.argv0` property instead. * * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except * the error passed to the callback will be an `AbortError`: * * ```js * const { spawn } = require('node:child_process'); * const controller = new AbortController(); * const { signal } = controller; * const grep = spawn('grep', ['ssh'], { signal }); * grep.on('error', (err) => { * // This will be called with err being an AbortError if the controller aborts * }); * controller.abort(); // Stops the child process * ``` * @since v0.1.90 * @param command The command to run. * @param args List of string arguments. */ function spawn(command: string, options?: SpawnOptionsWithoutStdio): ChildProcessWithoutNullStreams; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn(command: string, options: SpawnOptions): ChildProcess; // overloads of spawn with 'args' function spawn( command: string, args?: readonly string[], options?: SpawnOptionsWithoutStdio, ): ChildProcessWithoutNullStreams; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn( command: string, args: readonly string[], options: SpawnOptionsWithStdioTuple, ): ChildProcessByStdio; function spawn(command: string, args: readonly string[], options: SpawnOptions): ChildProcess; interface ExecOptions extends CommonOptions { shell?: string | undefined; signal?: AbortSignal | undefined; maxBuffer?: number | undefined; killSignal?: NodeJS.Signals | number | undefined; } interface ExecOptionsWithStringEncoding extends ExecOptions { encoding: BufferEncoding; } interface ExecOptionsWithBufferEncoding extends ExecOptions { encoding: BufferEncoding | null; // specify `null`. } interface ExecException extends Error { cmd?: string | undefined; killed?: boolean | undefined; code?: number | undefined; signal?: NodeJS.Signals | undefined; } /** * Spawns a shell then executes the `command` within that shell, buffering any * generated output. The `command` string passed to the exec function is processed * directly by the shell and special characters (vary based on [shell](https://en.wikipedia.org/wiki/List_of_command-line_interpreters)) * need to be dealt with accordingly: * * ```js * const { exec } = require('node:child_process'); * * exec('"/path/to/test file/test.sh" arg1 arg2'); * // Double quotes are used so that the space in the path is not interpreted as * // a delimiter of multiple arguments. * * exec('echo "The \\$HOME variable is $HOME"'); * // The $HOME variable is escaped in the first instance, but not in the second. * ``` * * **Never pass unsanitized user input to this function. Any input containing shell** * **metacharacters may be used to trigger arbitrary command execution.** * * If a `callback` function is provided, it is called with the arguments`(error, stdout, stderr)`. On success, `error` will be `null`. On error,`error` will be an instance of `Error`. The * `error.code` property will be * the exit code of the process. By convention, any exit code other than `0`indicates an error. `error.signal` will be the signal that terminated the * process. * * The `stdout` and `stderr` arguments passed to the callback will contain the * stdout and stderr output of the child process. By default, Node.js will decode * the output as UTF-8 and pass strings to the callback. The `encoding` option * can be used to specify the character encoding used to decode the stdout and * stderr output. If `encoding` is `'buffer'`, or an unrecognized character * encoding, `Buffer` objects will be passed to the callback instead. * * ```js * const { exec } = require('node:child_process'); * exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => { * if (error) { * console.error(`exec error: ${error}`); * return; * } * console.log(`stdout: ${stdout}`); * console.error(`stderr: ${stderr}`); * }); * ``` * * If `timeout` is greater than `0`, the parent will send the signal * identified by the `killSignal` property (the default is `'SIGTERM'`) if the * child runs longer than `timeout` milliseconds. * * Unlike the [`exec(3)`](http://man7.org/linux/man-pages/man3/exec.3.html) POSIX system call, `child_process.exec()` does not replace * the existing process and uses a shell to execute the command. * * If this method is invoked as its `util.promisify()` ed version, it returns * a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In * case of an error (including any error resulting in an exit code other than 0), a * rejected promise is returned, with the same `error` object given in the * callback, but with two additional properties `stdout` and `stderr`. * * ```js * const util = require('node:util'); * const exec = util.promisify(require('node:child_process').exec); * * async function lsExample() { * const { stdout, stderr } = await exec('ls'); * console.log('stdout:', stdout); * console.error('stderr:', stderr); * } * lsExample(); * ``` * * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except * the error passed to the callback will be an `AbortError`: * * ```js * const { exec } = require('node:child_process'); * const controller = new AbortController(); * const { signal } = controller; * const child = exec('grep ssh', { signal }, (error) => { * console.error(error); // an AbortError * }); * controller.abort(); * ``` * @since v0.1.90 * @param command The command to run, with space-separated arguments. * @param callback called with the output when process terminates. */ function exec( command: string, callback?: (error: ExecException | null, stdout: string, stderr: string) => void, ): ChildProcess; // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. function exec( command: string, options: { encoding: "buffer" | null; } & ExecOptions, callback?: (error: ExecException | null, stdout: Buffer, stderr: Buffer) => void, ): ChildProcess; // `options` with well known `encoding` means stdout/stderr are definitely `string`. function exec( command: string, options: { encoding: BufferEncoding; } & ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void, ): ChildProcess; // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. function exec( command: string, options: { encoding: BufferEncoding; } & ExecOptions, callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; // `options` without an `encoding` means stdout/stderr are definitely `string`. function exec( command: string, options: ExecOptions, callback?: (error: ExecException | null, stdout: string, stderr: string) => void, ): ChildProcess; // fallback if nothing else matches. Worst case is always `string | Buffer`. function exec( command: string, options: (ObjectEncodingOptions & ExecOptions) | undefined | null, callback?: (error: ExecException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; interface PromiseWithChild extends Promise { child: ChildProcess; } namespace exec { function __promisify__(command: string): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( command: string, options: { encoding: "buffer" | null; } & ExecOptions, ): PromiseWithChild<{ stdout: Buffer; stderr: Buffer; }>; function __promisify__( command: string, options: { encoding: BufferEncoding; } & ExecOptions, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( command: string, options: ExecOptions, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( command: string, options?: (ObjectEncodingOptions & ExecOptions) | null, ): PromiseWithChild<{ stdout: string | Buffer; stderr: string | Buffer; }>; } interface ExecFileOptions extends CommonOptions, Abortable { maxBuffer?: number | undefined; killSignal?: NodeJS.Signals | number | undefined; windowsVerbatimArguments?: boolean | undefined; shell?: boolean | string | undefined; signal?: AbortSignal | undefined; } interface ExecFileOptionsWithStringEncoding extends ExecFileOptions { encoding: BufferEncoding; } interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions { encoding: "buffer" | null; } interface ExecFileOptionsWithOtherEncoding extends ExecFileOptions { encoding: BufferEncoding; } type ExecFileException = & Omit & Omit & { code?: string | number | undefined | null }; /** * The `child_process.execFile()` function is similar to {@link exec} except that it does not spawn a shell by default. Rather, the specified * executable `file` is spawned directly as a new process making it slightly more * efficient than {@link exec}. * * The same options as {@link exec} are supported. Since a shell is * not spawned, behaviors such as I/O redirection and file globbing are not * supported. * * ```js * const { execFile } = require('node:child_process'); * const child = execFile('node', ['--version'], (error, stdout, stderr) => { * if (error) { * throw error; * } * console.log(stdout); * }); * ``` * * The `stdout` and `stderr` arguments passed to the callback will contain the * stdout and stderr output of the child process. By default, Node.js will decode * the output as UTF-8 and pass strings to the callback. The `encoding` option * can be used to specify the character encoding used to decode the stdout and * stderr output. If `encoding` is `'buffer'`, or an unrecognized character * encoding, `Buffer` objects will be passed to the callback instead. * * If this method is invoked as its `util.promisify()` ed version, it returns * a `Promise` for an `Object` with `stdout` and `stderr` properties. The returned`ChildProcess` instance is attached to the `Promise` as a `child` property. In * case of an error (including any error resulting in an exit code other than 0), a * rejected promise is returned, with the same `error` object given in the * callback, but with two additional properties `stdout` and `stderr`. * * ```js * const util = require('node:util'); * const execFile = util.promisify(require('node:child_process').execFile); * async function getVersion() { * const { stdout } = await execFile('node', ['--version']); * console.log(stdout); * } * getVersion(); * ``` * * **If the `shell` option is enabled, do not pass unsanitized user input to this** * **function. Any input containing shell metacharacters may be used to trigger** * **arbitrary command execution.** * * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except * the error passed to the callback will be an `AbortError`: * * ```js * const { execFile } = require('node:child_process'); * const controller = new AbortController(); * const { signal } = controller; * const child = execFile('node', ['--version'], { signal }, (error) => { * console.error(error); // an AbortError * }); * controller.abort(); * ``` * @since v0.1.91 * @param file The name or path of the executable file to run. * @param args List of string arguments. * @param callback Called with the output when process terminates. */ function execFile(file: string): ChildProcess; function execFile( file: string, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, ): ChildProcess; function execFile(file: string, args?: readonly string[] | null): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, ): ChildProcess; // no `options` definitely means stdout/stderr are `string`. function execFile( file: string, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void, ): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void, ): ChildProcess; // `options` with `"buffer"` or `null` for `encoding` means stdout/stderr are definitely `Buffer`. function execFile( file: string, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void, ): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, options: ExecFileOptionsWithBufferEncoding, callback: (error: ExecFileException | null, stdout: Buffer, stderr: Buffer) => void, ): ChildProcess; // `options` with well known `encoding` means stdout/stderr are definitely `string`. function execFile( file: string, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void, ): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, options: ExecFileOptionsWithStringEncoding, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void, ): ChildProcess; // `options` with an `encoding` whose type is `string` means stdout/stderr could either be `Buffer` or `string`. // There is no guarantee the `encoding` is unknown as `string` is a superset of `BufferEncoding`. function execFile( file: string, options: ExecFileOptionsWithOtherEncoding, callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, options: ExecFileOptionsWithOtherEncoding, callback: (error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void, ): ChildProcess; // `options` without an `encoding` means stdout/stderr are definitely `string`. function execFile( file: string, options: ExecFileOptions, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void, ): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, options: ExecFileOptions, callback: (error: ExecFileException | null, stdout: string, stderr: string) => void, ): ChildProcess; // fallback if nothing else matches. Worst case is always `string | Buffer`. function execFile( file: string, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, callback: | ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, ): ChildProcess; function execFile( file: string, args: readonly string[] | undefined | null, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, callback: | ((error: ExecFileException | null, stdout: string | Buffer, stderr: string | Buffer) => void) | undefined | null, ): ChildProcess; namespace execFile { function __promisify__(file: string): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( file: string, args: readonly string[] | undefined | null, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( file: string, options: ExecFileOptionsWithBufferEncoding, ): PromiseWithChild<{ stdout: Buffer; stderr: Buffer; }>; function __promisify__( file: string, args: readonly string[] | undefined | null, options: ExecFileOptionsWithBufferEncoding, ): PromiseWithChild<{ stdout: Buffer; stderr: Buffer; }>; function __promisify__( file: string, options: ExecFileOptionsWithStringEncoding, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( file: string, args: readonly string[] | undefined | null, options: ExecFileOptionsWithStringEncoding, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( file: string, options: ExecFileOptionsWithOtherEncoding, ): PromiseWithChild<{ stdout: string | Buffer; stderr: string | Buffer; }>; function __promisify__( file: string, args: readonly string[] | undefined | null, options: ExecFileOptionsWithOtherEncoding, ): PromiseWithChild<{ stdout: string | Buffer; stderr: string | Buffer; }>; function __promisify__( file: string, options: ExecFileOptions, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( file: string, args: readonly string[] | undefined | null, options: ExecFileOptions, ): PromiseWithChild<{ stdout: string; stderr: string; }>; function __promisify__( file: string, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, ): PromiseWithChild<{ stdout: string | Buffer; stderr: string | Buffer; }>; function __promisify__( file: string, args: readonly string[] | undefined | null, options: (ObjectEncodingOptions & ExecFileOptions) | undefined | null, ): PromiseWithChild<{ stdout: string | Buffer; stderr: string | Buffer; }>; } interface ForkOptions extends ProcessEnvOptions, MessagingOptions, Abortable { execPath?: string | undefined; execArgv?: string[] | undefined; silent?: boolean | undefined; /** * Can be set to 'pipe', 'inherit', 'overlapped', or 'ignore', or an array of these strings. * If passed as an array, the first element is used for `stdin`, the second for * `stdout`, and the third for `stderr`. A fourth element can be used to * specify the `stdio` behavior beyond the standard streams. See * {@link ChildProcess.stdio} for more information. * * @default 'pipe' */ stdio?: StdioOptions | undefined; detached?: boolean | undefined; windowsVerbatimArguments?: boolean | undefined; } /** * The `child_process.fork()` method is a special case of {@link spawn} used specifically to spawn new Node.js processes. * Like {@link spawn}, a `ChildProcess` object is returned. The * returned `ChildProcess` will have an additional communication channel * built-in that allows messages to be passed back and forth between the parent and * child. See `subprocess.send()` for details. * * Keep in mind that spawned Node.js child processes are * independent of the parent with exception of the IPC communication channel * that is established between the two. Each process has its own memory, with * their own V8 instances. Because of the additional resource allocations * required, spawning a large number of child Node.js processes is not * recommended. * * By default, `child_process.fork()` will spawn new Node.js instances using the `process.execPath` of the parent process. The `execPath` property in the`options` object allows for an alternative * execution path to be used. * * Node.js processes launched with a custom `execPath` will communicate with the * parent process using the file descriptor (fd) identified using the * environment variable `NODE_CHANNEL_FD` on the child process. * * Unlike the [`fork(2)`](http://man7.org/linux/man-pages/man2/fork.2.html) POSIX system call, `child_process.fork()` does not clone the * current process. * * The `shell` option available in {@link spawn} is not supported by`child_process.fork()` and will be ignored if set. * * If the `signal` option is enabled, calling `.abort()` on the corresponding`AbortController` is similar to calling `.kill()` on the child process except * the error passed to the callback will be an `AbortError`: * * ```js * if (process.argv[2] === 'child') { * setTimeout(() => { * console.log(`Hello from ${process.argv[2]}!`); * }, 1_000); * } else { * const { fork } = require('node:child_process'); * const controller = new AbortController(); * const { signal } = controller; * const child = fork(__filename, ['child'], { signal }); * child.on('error', (err) => { * // This will be called with err being an AbortError if the controller aborts * }); * controller.abort(); // Stops the child process * } * ``` * @since v0.5.0 * @param modulePath The module to run in the child. * @param args List of string arguments. */ function fork(modulePath: string, options?: ForkOptions): ChildProcess; function fork(modulePath: string, args?: readonly string[], options?: ForkOptions): ChildProcess; interface SpawnSyncOptions extends CommonSpawnOptions { input?: string | NodeJS.ArrayBufferView | undefined; maxBuffer?: number | undefined; encoding?: BufferEncoding | "buffer" | null | undefined; } interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { encoding: BufferEncoding; } interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { encoding?: "buffer" | null | undefined; } interface SpawnSyncReturns { pid: number; output: Array; stdout: T; stderr: T; status: number | null; signal: NodeJS.Signals | null; error?: Error | undefined; } /** * The `child_process.spawnSync()` method is generally identical to {@link spawn} with the exception that the function will not return * until the child process has fully closed. When a timeout has been encountered * and `killSignal` is sent, the method won't return until the process has * completely exited. If the process intercepts and handles the `SIGTERM` signal * and doesn't exit, the parent process will wait until the child process has * exited. * * **If the `shell` option is enabled, do not pass unsanitized user input to this** * **function. Any input containing shell metacharacters may be used to trigger** * **arbitrary command execution.** * @since v0.11.12 * @param command The command to run. * @param args List of string arguments. */ function spawnSync(command: string): SpawnSyncReturns; function spawnSync(command: string, options: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; function spawnSync(command: string, options: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns; function spawnSync(command: string, args: readonly string[]): SpawnSyncReturns; function spawnSync( command: string, args: readonly string[], options: SpawnSyncOptionsWithStringEncoding, ): SpawnSyncReturns; function spawnSync( command: string, args: readonly string[], options: SpawnSyncOptionsWithBufferEncoding, ): SpawnSyncReturns; function spawnSync( command: string, args?: readonly string[], options?: SpawnSyncOptions, ): SpawnSyncReturns; interface CommonExecOptions extends CommonOptions { input?: string | NodeJS.ArrayBufferView | undefined; /** * Can be set to 'pipe', 'inherit, or 'ignore', or an array of these strings. * If passed as an array, the first element is used for `stdin`, the second for * `stdout`, and the third for `stderr`. A fourth element can be used to * specify the `stdio` behavior beyond the standard streams. See * {@link ChildProcess.stdio} for more information. * * @default 'pipe' */ stdio?: StdioOptions | undefined; killSignal?: NodeJS.Signals | number | undefined; maxBuffer?: number | undefined; encoding?: BufferEncoding | "buffer" | null | undefined; } interface ExecSyncOptions extends CommonExecOptions { shell?: string | undefined; } interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { encoding: BufferEncoding; } interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { encoding?: "buffer" | null | undefined; } /** * The `child_process.execSync()` method is generally identical to {@link exec} with the exception that the method will not return * until the child process has fully closed. When a timeout has been encountered * and `killSignal` is sent, the method won't return until the process has * completely exited. If the child process intercepts and handles the `SIGTERM`signal and doesn't exit, the parent process will wait until the child process * has exited. * * If the process times out or has a non-zero exit code, this method will throw. * The `Error` object will contain the entire result from {@link spawnSync}. * * **Never pass unsanitized user input to this function. Any input containing shell** * **metacharacters may be used to trigger arbitrary command execution.** * @since v0.11.12 * @param command The command to run. * @return The stdout from the command. */ function execSync(command: string): Buffer; function execSync(command: string, options: ExecSyncOptionsWithStringEncoding): string; function execSync(command: string, options: ExecSyncOptionsWithBufferEncoding): Buffer; function execSync(command: string, options?: ExecSyncOptions): string | Buffer; interface ExecFileSyncOptions extends CommonExecOptions { shell?: boolean | string | undefined; } interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { encoding: BufferEncoding; } interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { encoding?: "buffer" | null; // specify `null`. } /** * The `child_process.execFileSync()` method is generally identical to {@link execFile} with the exception that the method will not * return until the child process has fully closed. When a timeout has been * encountered and `killSignal` is sent, the method won't return until the process * has completely exited. * * If the child process intercepts and handles the `SIGTERM` signal and * does not exit, the parent process will still wait until the child process has * exited. * * If the process times out or has a non-zero exit code, this method will throw an `Error` that will include the full result of the underlying {@link spawnSync}. * * **If the `shell` option is enabled, do not pass unsanitized user input to this** * **function. Any input containing shell metacharacters may be used to trigger** * **arbitrary command execution.** * @since v0.11.12 * @param file The name or path of the executable file to run. * @param args List of string arguments. * @return The stdout from the command. */ function execFileSync(file: string): Buffer; function execFileSync(file: string, options: ExecFileSyncOptionsWithStringEncoding): string; function execFileSync(file: string, options: ExecFileSyncOptionsWithBufferEncoding): Buffer; function execFileSync(file: string, options?: ExecFileSyncOptions): string | Buffer; function execFileSync(file: string, args: readonly string[]): Buffer; function execFileSync( file: string, args: readonly string[], options: ExecFileSyncOptionsWithStringEncoding, ): string; function execFileSync( file: string, args: readonly string[], options: ExecFileSyncOptionsWithBufferEncoding, ): Buffer; function execFileSync(file: string, args?: readonly string[], options?: ExecFileSyncOptions): string | Buffer; } declare module "node:child_process" { export * from "child_process"; }