@k4a_l/dirtreeist 0.4.0 → 1.0.0

package/dist/index.js

@@ -1,9 +1,609 @@
-import { parse } from './modules/parse.js';
-import { convert } from './modules/convert.js';
-import { symbolSets } from './constants/constant.js';
+import { fromMarkdown } from "mdast-util-from-markdown";
+
+//#region src/constants/constant.ts
+const symbolSets = {
+	normal: {
+		vertical: "│",
+		horizontal: "─",
+		crossing: "├",
+		end: "└",
+		space: "　"
+	},
+	bold: {
+		vertical: "┃",
+		horizontal: "━",
+		crossing: "┣",
+		end: "┗",
+		space: "　"
+	},
+	ascii: {
+		vertical: "|",
+		horizontal: "-",
+		crossing: "+",
+		end: "+",
+		space: " "
+	}
+};
+const defaultOptions = {
+	treeType: "normal",
+	spaceBeforeName: false,
+	spaceSize: 2,
+	emptyBeforeUpperHierarchy: false,
+	keepMarkdown: false,
+	cjkFont: true,
+	delimiter: false,
+	memoAlign: "all",
+	memoGap: 2,
+	memoMaxColumn: false,
+	noteAlignToMemo: true,
+	noteBullet: "・",
+	noteIndentSize: 2
+};
+const treeTypeValues = [
+	"normal",
+	"bold",
+	"ascii"
+];
+const memoAlignValues = [
+	"all",
+	"siblings",
+	"none"
+];
+
+//#endregion
+//#region src/modules/options.ts
+/** 整数として扱える数値か。min未満は既定値に落とす。 */
+const integerAtLeast = (min) => (value, defaultValue) => {
+	if (typeof value !== "number") return defaultValue;
+	if (!Number.isFinite(value)) return defaultValue;
+	if (value < min) return defaultValue;
+	return Math.floor(value);
+};
+const oneOf = (values) => (value, defaultValue) => {
+	return values.includes(value) ? value : defaultValue;
+};
+const boolean = () => (value, defaultValue) => {
+	return typeof value === "boolean" ? value : defaultValue;
+};
+/** 空文字は「記号なし」の指定として有効なので許す。 */
+const anyString = (value, defaultValue) => {
+	return typeof value === "string" ? value : defaultValue;
+};
+/** 空文字だと区切れないので落とす。falseは機能オフの指定として有効。 */
+const nonEmptyStringOrFalse = (value, defaultValue) => {
+	if (value === false) return false;
+	if (typeof value !== "string") return defaultValue;
+	if (value.length === 0) return defaultValue;
+	return value;
+};
+const positiveIntegerOrFalse = (value, defaultValue) => {
+	if (value === false) return false;
+	if (typeof value !== "number") return defaultValue;
+	if (!Number.isFinite(value)) return defaultValue;
+	if (value < 1) return defaultValue;
+	return Math.floor(value);
+};
+/** キーごとの検証。全キーを網羅していないと型エラーになる。 */
+const guards = {
+	treeType: oneOf(treeTypeValues),
+	emptyBeforeUpperHierarchy: boolean(),
+	spaceBeforeName: boolean(),
+	spaceSize: integerAtLeast(1),
+	keepMarkdown: boolean(),
+	cjkFont: boolean(),
+	delimiter: nonEmptyStringOrFalse,
+	memoAlign: oneOf(memoAlignValues),
+	memoGap: integerAtLeast(0),
+	memoMaxColumn: positiveIntegerOrFalse,
+	noteAlignToMemo: boolean(),
+	noteBullet: anyString,
+	noteIndentSize: integerAtLeast(0)
+};
+const pickOption = (options, defaultOptions$1, key) => {
+	const defaultValue = defaultOptions$1[key];
+	const value = options?.[key];
+	if (value === void 0) return defaultValue;
+	return guards[key](value, defaultValue);
+};
+const buildOption = (options, defaultOptions$1) => {
+	return Object.keys(guards).reduce((built, key) => {
+		return Object.assign(built, { [key]: pickOption(options, defaultOptions$1, key) });
+	}, {});
+};
+
+//#endregion
+//#region src/modules/width.ts
+const wideRanges = [
+	[4352, 4447],
+	[11904, 12350],
+	[12353, 13311],
+	[13312, 19903],
+	[19968, 40959],
+	[40960, 42191],
+	[43360, 43391],
+	[44032, 55203],
+	[63744, 64255],
+	[65040, 65049],
+	[65072, 65135],
+	[65280, 65376],
+	[65504, 65510],
+	[127744, 128591],
+	[129280, 129535],
+	[131072, 262141]
+];
+const ambiguousRanges = [
+	[161, 161],
+	[164, 164],
+	[167, 168],
+	[170, 170],
+	[173, 174],
+	[176, 180],
+	[182, 186],
+	[188, 191],
+	[198, 198],
+	[208, 208],
+	[215, 216],
+	[222, 225],
+	[230, 230],
+	[232, 234],
+	[236, 237],
+	[240, 240],
+	[242, 243],
+	[247, 250],
+	[252, 252],
+	[254, 254],
+	[8208, 8208],
+	[8211, 8214],
+	[8216, 8217],
+	[8220, 8221],
+	[8224, 8226],
+	[8228, 8231],
+	[8240, 8240],
+	[8242, 8243],
+	[8245, 8245],
+	[8251, 8251],
+	[8254, 8254],
+	[8308, 8308],
+	[8319, 8319],
+	[8321, 8324],
+	[8364, 8364],
+	[8451, 8451],
+	[8453, 8453],
+	[8457, 8457],
+	[8467, 8467],
+	[8470, 8470],
+	[8481, 8482],
+	[8486, 8486],
+	[8491, 8491],
+	[8531, 8532],
+	[8539, 8542],
+	[8544, 8555],
+	[8560, 8569],
+	[8585, 8585],
+	[8592, 8601],
+	[8632, 8633],
+	[8658, 8658],
+	[8660, 8660],
+	[8679, 8679],
+	[8704, 8704],
+	[8706, 8707],
+	[8711, 8712],
+	[8715, 8715],
+	[8719, 8719],
+	[8721, 8721],
+	[8725, 8725],
+	[8730, 8730],
+	[8733, 8736],
+	[8739, 8739],
+	[8741, 8741],
+	[8743, 8748],
+	[8750, 8750],
+	[8756, 8759],
+	[8764, 8765],
+	[8776, 8776],
+	[8780, 8780],
+	[8786, 8786],
+	[8800, 8801],
+	[8804, 8807],
+	[8810, 8811],
+	[8814, 8815],
+	[8834, 8835],
+	[8838, 8839],
+	[8853, 8853],
+	[8857, 8857],
+	[8869, 8869],
+	[8895, 8895],
+	[8978, 8978],
+	[9312, 9449],
+	[9451, 9547],
+	[9552, 9587],
+	[9600, 9615],
+	[9618, 9621],
+	[9632, 9633],
+	[9635, 9641],
+	[9650, 9651],
+	[9654, 9655],
+	[9660, 9661],
+	[9664, 9665],
+	[9670, 9672],
+	[9675, 9675],
+	[9678, 9681],
+	[9698, 9701],
+	[9711, 9711],
+	[9733, 9734],
+	[9737, 9737],
+	[9742, 9743],
+	[9748, 9749],
+	[9756, 9756],
+	[9758, 9758],
+	[9792, 9792],
+	[9794, 9794],
+	[9824, 9825],
+	[9827, 9829],
+	[9831, 9834],
+	[9836, 9837],
+	[9839, 9839],
+	[10045, 10045],
+	[10102, 10111],
+	[57344, 63743],
+	[65533, 65533]
+];
+const includes = (ranges, code) => {
+	let low = 0;
+	let high = ranges.length - 1;
+	while (low <= high) {
+		const middle = Math.floor((low + high) / 2);
+		const [start, end] = ranges[middle];
+		if (code < start) high = middle - 1;
+		else if (code > end) low = middle + 1;
+		else return true;
+	}
+	return false;
+};
+const charWidth = (code, ambiguousWidth) => {
+	if (code === 0) return 0;
+	if (code < 32 || code >= 127 && code < 160) return 0;
+	if (code < 127) return 1;
+	if (code >= 768 && code <= 879) return 0;
+	if (code === 8203 || code === 65039) return 0;
+	if (includes(wideRanges, code)) return 2;
+	if (includes(ambiguousRanges, code)) return ambiguousWidth;
+	return 1;
+};
+/**
+* 等幅表示を前提とした表示幅を返す。
+* 罫線素片や全角スペースを混在させるため、East Asian Width を見て 1/2 を数える。
+*/
+const stringWidth = (text, ambiguousWidth) => {
+	let width = 0;
+	for (const char of text) width += charWidth(char.codePointAt(0), ambiguousWidth);
+	return width;
+};
+/**
+* CJKフォント前提かどうかを、Ambiguousな文字の幅に読み替える。
+* CJKフォントでは罫線素片などが全角で描画されるため2幅として数える。
+*/
+const ambiguousWidthOf = (cjkFont) => {
+	return cjkFont ? 2 : 1;
+};
+/**
+* markdown記法のうち、レンダリング後に消える文字を取り除く。
+* keepMarkdown:true のとき、`**bold**` を4文字ではなく8文字と数えてしまうのを防ぐ。
+*
+* あくまで文字数の話であり、太字や色などレンダリング後の字形の違いまでは扱えない。
+*/
+const stripMarkdown = (text) => {
+	return text.replace(/!?\[([^\]]*)\]\([^)]*\)/g, "$1").replace(/!?\[([^\]]*)\]\[[^\]]*\]/g, "$1").replace(/`+([^`]*)`+/g, "$1").replace(/(\*\*\*|\*\*|\*|___|__|_)(.+?)\1/g, "$2").replace(/\\([!-/:-@[-`{-~])/g, "$1");
+};
+
+//#endregion
+//#region src/modules/convert.ts
+const makeSymbol = (symbolSet, isLast) => {
+	if (isLast) return symbolSet.end;
+	return symbolSet.crossing;
+};
+const makeAsciiSpace = (spaceSize) => {
+	return new Array(spaceSize).fill(" ").reduce((prev, cur) => {
+		return prev + cur;
+	}, "");
+};
+const makeSpace = (spaceSize) => {
+	return new Array(Math.floor(spaceSize / 2)).fill("　").reduce((prev, cur) => {
+		return prev + cur;
+	}, "") + (spaceSize % 2 === 1 ? " " : "");
+};
+const reduce = (dirTree, options, prefix, hie, isLastGroup, group, counter) => {
+	const rows = [];
+	let currentGroup = group;
+	dirTree.forEach((dirNode, dirNodeIndex) => {
+		const isLast = dirNodeIndex === dirTree.length - 1;
+		const isOneTop = hie === 0 && dirTree.length === 1;
+		const symbolSet = symbolSets[options.treeType];
+		const makePrefix = () => {
+			if (isOneTop) return "";
+			return makeSymbol(symbolSet, isLast) + new Array(Math.floor(options.spaceSize / (options.treeType === "ascii" ? 1 : 2))).fill(symbolSet.horizontal).reduce((prev, cur) => prev + cur, "") + (options.spaceBeforeName ? " " : "");
+		};
+		rows.push({
+			kind: "node",
+			prefix: prefix + makePrefix(),
+			name: dirNode.name,
+			memo: dirNode.memo,
+			group: currentGroup,
+			node: dirNode,
+			hierarchy: hie
+		});
+		const makeNextSpaces = () => {
+			if (isOneTop) return "";
+			return options.treeType === "ascii" ? makeAsciiSpace(options.spaceSize) : makeSpace(options.spaceSize);
+		};
+		const makeNextVertical = () => {
+			if (!isLast) return symbolSet.vertical;
+			if (!isOneTop) return symbolSet.space;
+			return "";
+		};
+		const childPrefix = prefix + makeNextVertical() + makeNextSpaces();
+		/**
+		* note行の罫線。
+		* noteの下には子要素が続くので、childPrefixの後ろにさらに縦線を置いて
+		* 自分から子への線を途切れさせない。子がなければ線を引く先がないので置かない。
+		*/
+		const notePrefix = dirNode.children.length > 0 ? childPrefix + symbolSet.vertical : childPrefix;
+		const pushNotes = (notes, depth) => {
+			notes.forEach((noteNode) => {
+				rows.push({
+					kind: "note",
+					prefix: notePrefix,
+					text: noteNode.text,
+					depth,
+					group: currentGroup,
+					node: dirNode,
+					noteNode
+				});
+				pushNotes(noteNode.children, depth + 1);
+			});
+		};
+		pushNotes(dirNode.notes ?? [], 0);
+		counter.value += 1;
+		const childrenRows = reduce(dirNode.children, options, childPrefix, hie + 1, isLastGroup || isLast, counter.value, counter);
+		rows.push(...childrenRows);
+		if (options.memoAlign === "siblings" && childrenRows.length > 0) {
+			counter.value += 1;
+			currentGroup = counter.value;
+		}
+		if (options.emptyBeforeUpperHierarchy && isLast && !(isLastGroup || hie === 0)) rows.push({
+			kind: "empty",
+			prefix: symbolSet.vertical
+		});
+	});
+	return rows;
+};
+/** memo/noteの開始位置を揃えて、行ごとに空白を確定させる。 */
+const align = (rows, options) => {
+	const keyOf = (row) => options.memoAlign === "all" ? 0 : row.group;
+	const ambiguousWidth = ambiguousWidthOf(options.cjkFont);
+	const widthOf = (text) => stringWidth(text, ambiguousWidth);
+	const nodeWidthOf = (row) => widthOf(row.prefix) + widthOf(options.keepMarkdown ? stripMarkdown(row.name) : row.name);
+	const makeNoteIndent = (depth) => {
+		const size = options.noteIndentSize * depth;
+		return options.treeType === "ascii" ? makeAsciiSpace(size) : makeSpace(size);
+	};
+	const columns = /* @__PURE__ */ new Map();
+	if (options.memoAlign !== "none") {
+		const maxColumn = options.memoMaxColumn;
+		rows.forEach((row) => {
+			if (row.kind !== "node" || row.memo === void 0) return;
+			const width = nodeWidthOf(row);
+			if (maxColumn !== false && width > maxColumn) return;
+			const key = keyOf(row);
+			columns.set(key, Math.max(columns.get(key) ?? 0, width));
+		});
+	}
+	return rows.map((row) => {
+		if (row.kind === "empty") return {
+			type: "empty",
+			branch: row.prefix
+		};
+		if (row.kind === "note") {
+			const common$1 = {
+				type: "note",
+				branch: row.prefix,
+				indent: makeNoteIndent(row.depth),
+				bullet: options.noteBullet,
+				text: row.text,
+				depth: row.depth,
+				node: row.node,
+				noteNode: row.noteNode
+			};
+			if (!options.noteAlignToMemo) return {
+				...common$1,
+				gap: makeNoteIndent(1)
+			};
+			const width$1 = widthOf(row.prefix);
+			const column$1 = columns.get(keyOf(row)) ?? width$1;
+			return {
+				...common$1,
+				gap: makeAsciiSpace(Math.max(column$1 - width$1, 0) + options.memoGap)
+			};
+		}
+		const common = {
+			type: "node",
+			branch: row.prefix,
+			name: row.name,
+			node: row.node,
+			hierarchy: row.hierarchy
+		};
+		if (row.memo === void 0) return {
+			...common,
+			gap: ""
+		};
+		const width = nodeWidthOf(row);
+		const column = columns.get(keyOf(row)) ?? width;
+		return {
+			...common,
+			gap: makeAsciiSpace(Math.max(column - width, 0) + options.memoGap),
+			memo: row.memo
+		};
+	});
+};
+/** Lineを1行の文字列にする。 */
+const lineToString = (line) => {
+	if (line.type === "empty") return line.branch;
+	if (line.type === "note") return line.branch + line.gap + line.indent + line.bullet + line.text;
+	return line.branch + line.name + line.gap + (line.memo ?? "");
+};
+/**
+* 階層構造を、上から下へのフラットな行データに落とす。
+* 罫線・名前・空白・メモが分かれているので、利用側で独自にレンダリングできる。
+*/
+const layout = (dirTree, options) => {
+	const mergedOptions = buildOption(options, defaultOptions);
+	return align(reduce(dirTree, mergedOptions, "", 0, false, 0, { value: 0 }), mergedOptions);
+};
+const convert = (dirTree, options) => {
+	try {
+		return layout(dirTree, options).map(lineToString).join("\n");
+	} catch (error) {
+		return "Some errors occurred!\n\n" + String(error) + "\n\nPlease contact to developper.";
+	}
+};
+
+//#endregion
+//#region src/modules/parse.ts
+const wholeRange = {
+	from: 0,
+	to: Infinity
+};
+const unescapeMarkdown = (text) => {
+	return text.replace(/\\([!-/:-@[-`{-~])/g, "$1");
+};
+const extractText = (content, chunk, options, range = wholeRange) => {
+	if (!content) return "";
+	const start = content.position?.start.offset ?? 0;
+	const end = content.position?.end.offset ?? Infinity;
+	if (end <= range.from || start >= range.to) return "";
+	const isWhole = start >= range.from && end <= range.to;
+	const sliceStart = Math.max(start, range.from);
+	const sliceEnd = Math.min(end, range.to);
+	if (options.keepMarkdown && content.position) return chunk.slice(sliceStart, sliceEnd);
+	if (content.type === "text") {
+		if (isWhole) return content.value;
+		return unescapeMarkdown(chunk.slice(sliceStart, sliceEnd));
+	}
+	if ("value" in content) {
+		if (isWhole) return content.value;
+		return chunk.slice(sliceStart, sliceEnd);
+	}
+	if ("children" in content) return content.children.map((child) => {
+		return extractText(child, chunk, options, range);
+	}).reduce((prev, cur) => {
+		return prev + cur;
+	}, "");
+	return "";
+};
+/**
+* メモの区切り文字の位置(chunk上のoffset)を返す。
+* リンクのURLやコードスパンの中身を誤って区切らないよう、
+* テキストノードの範囲だけを走査する。`\#`のようなエスケープは無視する。
+*/
+const findMemoOffset = (content, chunk, delimiter) => {
+	if (!content) return void 0;
+	if (!("children" in content)) return void 0;
+	for (const child of content.children) {
+		if (child.type !== "text") continue;
+		const start = child.position?.start.offset;
+		const end = child.position?.end.offset;
+		if (start === void 0 || end === void 0) continue;
+		let index = chunk.indexOf(delimiter, start);
+		while (index >= 0 && index + delimiter.length <= end) {
+			if (chunk[index - 1] !== "\\") return index;
+			index = chunk.indexOf(delimiter, index + delimiter.length);
+		}
+	}
+};
+/** 名前が空でメモだけの行(note)かどうか。 */
+const isNoteOnly = (node) => {
+	return node.name === "" && node.memo !== void 0;
+};
+/**
+* noteの行を、子孫まとめてNoteNodeに変換する。
+* noteの子は名前を持っていてもnoteとして扱う。
+*/
+const toNoteNode = (node) => {
+	return {
+		text: node.memo ?? node.name,
+		children: node.children.map(toNoteNode)
+	};
+};
+/**
+* noteの子をchildrenから外してnotesへ移す。
+* 分割前のchildrenを見るので、実ノードと混ざっていても元の順序を保てる。
+*/
+const splitNotes = (node) => {
+	const notes = node.children.filter(isNoteOnly).map(toNoteNode);
+	const children = node.children.filter((child) => !isNoteOnly(child)).map(splitNotes);
+	if (notes.length === 0) return {
+		...node,
+		children
+	};
+	return {
+		...node,
+		children,
+		notes
+	};
+};
+const extractListItem = (listItem, chunk, options) => {
+	const content = listItem.children[0];
+	const children = listItem.children.length > 1 ? extractList(listItem.children[1], chunk, options) : [];
+	const delimiter = options.delimiter;
+	const memoOffset = delimiter ? findMemoOffset(content, chunk, delimiter) : void 0;
+	if (!delimiter || memoOffset === void 0) return {
+		name: extractText(content, chunk, options),
+		children
+	};
+	const name = extractText(content, chunk, options, {
+		from: 0,
+		to: memoOffset
+	}).trimEnd();
+	const memo = extractText(content, chunk, options, {
+		from: memoOffset + delimiter.length,
+		to: Infinity
+	}).trim();
+	if (!memo) return {
+		name,
+		children
+	};
+	return {
+		name,
+		memo,
+		children
+	};
+};
+const extractList = (list, chunk, options) => {
+	if (list.type !== "list") return [];
+	if (!list.children) return [];
+	return list.children.map((listItem) => {
+		return extractListItem(listItem, chunk, options);
+	});
+};
+const parse = (chunk, options) => {
+	const tree = fromMarkdown(chunk);
+	const mergedOptions = buildOption(options, defaultOptions);
+	return tree.children.filter((child) => child.type === "list").map((list) => {
+		try {
+			return extractList(list, chunk, mergedOptions).map(splitNotes);
+		} catch (_error) {
+			return [];
+		}
+	});
+};
+
+//#endregion
+//#region src/index.ts
 const dirtreeist = (markdown, option) => {
-    return parse(markdown, option).map((dirtree) => convert(dirtree, option));
+	return parse(markdown, option).map((dirtree) => convert(dirtree, option));
 };
-export { parse, convert, symbolSets };
-export default dirtreeist;
+var src_default = dirtreeist;
+
+//#endregion
+export { convert, src_default as default, defaultOptions, layout, lineToString, memoAlignValues, parse, symbolSets, treeTypeValues };
 //# sourceMappingURL=index.js.map