md-hopper 1.0.0-alpha.1 → 1.0.0-alpha.10

package/README.md

@@ -2,19 +2,34 @@
 
 # MD HOPPER
 
-This Package Link md files in same repository.
+md-hopper is a tool that recursively processes README.md files, starting from a specified README.md file and adding links to other README.md files nested within its directories to the parent README.md file.
+This helps consolidate dispersed README files into a single, easily manageable document.
 
-# Commands
+## Installation
+
+```bash
+$ npm i -g md-hopper
+```
+
+or
+
+```bash
+$ npm i md-hopper
+```
+
+## Commands
 
 <!-- MD_HOPPER: LINK_NEXT_LINE:
-id: generate-command
+id: link-command
 inline: true
 -->
 
-- [generate][md_hopper:generate-command]
+### [LINK][md_hopper:link-command]
+
+<!-- MD_HOPPER: BEFORE_GENERATE_LINK (6/4/2024, 10:23:14 AM): - [generate][md_hopper:generate-command] -->
 
 <!-- MD_HOPPER: BEGIN_DEFINE_LINKS: -->
 
-[md_hopper:generate-command]: ./src/cli/commands/generate/README.md 'GENERATE COMMAND'
+[md_hopper:link-command]: ./src/cli/commands/link/README.md 'LINK COMMAND'
 
 <!-- MD_HOPPER: END_DEFINE_LINKS: -->

package/cli/commands/generate/actions/link/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@cilly/md-hopper-cli-commands-generate-actions-link",
+  "types": "../../../../../dist/cli/commands/generate/actions/link.d.ts",
+  "main": "../../../../../dist/cli/commands/generate/actions/link.js",
+  "sideEffects": false
+}

package/cli/commands/generate/actions/rc/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@cilly/md-hopper-cli-commands-generate-actions-rc",
+  "types": "../../../../../dist/cli/commands/generate/actions/rc.d.ts",
+  "main": "../../../../../dist/cli/commands/generate/actions/rc.js",
+  "sideEffects": false
+}

package/cli/commands/link/README.md/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@cilly/md-hopper-cli-commands-link-README.md",
+  "types": "../../../../dist/cli/commands/link/README.md.d.ts",
+  "main": "../../../../dist/cli/commands/link/README.md.js",
+  "sideEffects": false
+}

package/cli/commands/link/action/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@cilly/md-hopper-cli-commands-link-action",
+  "types": "../../../../dist/cli/commands/link/action.d.ts",
+  "main": "../../../../dist/cli/commands/link/action.js",
+  "sideEffects": false
+}

package/cli/commands/link/command/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@cilly/md-hopper-cli-commands-link-command",
+  "types": "../../../../dist/cli/commands/link/command.d.ts",
+  "main": "../../../../dist/cli/commands/link/command.js",
+  "sideEffects": false
+}

package/dist/_internal/types/command.d.ts

@@ -1,11 +1,9 @@
-import { Options, DefaultOptions } from './options.js';
-import { Settings } from './settings.js';
 export type Action = (...args: any[]) => any;
 export interface BeforeFunction {
     fn: Action;
     args: any[];
 }
-export interface ActionArg<T extends DefaultOptions> {
-    options: Options<T>;
-    settings: Settings;
+export interface ActionArg<CommandOptions extends Record<string, any>, MdSettings extends Record<string, any>> {
+    options: CommandOptions;
+    settings: MdSettings;
 }

package/dist/_internal/types/configs/generate.d.ts

@@ -0,0 +1,46 @@
+import { DistinctQuestion } from 'inquirer';
+export declare const TYPES: {
+    readonly rc: "rc";
+    readonly link: "link";
+};
+export type Type = (typeof TYPES)[keyof typeof TYPES];
+export interface CommandOptions {
+    debug?: boolean;
+    type?: Type;
+    include?: string;
+    exclude?: string;
+    filenames?: string;
+    input?: string;
+    output?: string;
+    idGen?: GenerateType;
+    depth?: number;
+    id?: string;
+    lock?: boolean;
+    skipHidden?: boolean;
+    title?: string;
+}
+export interface MdSettings {
+    include: string[];
+    exclude: string[];
+    filenames: string[];
+    skipHidden: boolean;
+    input: string;
+    output: string;
+    idGen: GenerateType;
+    id: string;
+    title: string;
+    lock: boolean;
+    depth: number;
+}
+export declare const RC_QUESTIONS: (_options: CommandOptions) => ReadonlyArray<DistinctQuestion>;
+export declare const GENERATE_TYPES: Readonly<{
+    readonly path: "path";
+    readonly random: "random";
+    readonly manual: "manual";
+}>;
+export type GenerateType = (typeof GENERATE_TYPES)[keyof typeof GENERATE_TYPES];
+export declare const LINK_QUESTIONS: (options: CommandOptions) => ReadonlyArray<DistinctQuestion>;
+export declare const QUESTIONS: (options: CommandOptions) => {
+    rc: readonly DistinctQuestion[];
+    link: readonly DistinctQuestion[];
+};

package/dist/_internal/types/configs/generate.js

@@ -0,0 +1,131 @@
+import { isNumber } from 'my-gadgetry/type-check';
+import { DEFAULT_MD_FILENAME } from '../../utils/configs.js';
+import { isDirectory } from '../../utils/path.js';
+export const TYPES = {
+    rc: 'rc',
+    link: 'link',
+};
+const INPUT_QUESTION = {
+    type: 'input',
+    name: 'input',
+    message: 'Please put path from current dir with filename? ex: "./{path}/{filename}.md"',
+};
+const SKIP_HIDDEN_QUESTION = {
+    type: 'confirm',
+    name: 'skipHidden',
+    message: 'skip search hidden file? default Yes.',
+    default: true,
+};
+const INCLUDE_QUESTION = {
+    type: 'input',
+    name: 'include',
+    message: 'include pattern minimatch list with comma. ex: xxx,xxx',
+    default: '',
+};
+const EXCLUDE_QUESTION = {
+    type: 'input',
+    name: 'exclude',
+    message: 'exclude pattern minimatch list with comma. ex: xxx,xxx',
+    default: '',
+};
+const FILENAMES_QUESTION = {
+    type: 'input',
+    name: 'filenames',
+    message: 'search filenames with comma. (default: README.md) ex: README.md,CHANGELOG.md',
+    default: DEFAULT_MD_FILENAME,
+};
+const OUTPUT_QUESTION = {
+    type: 'input',
+    name: 'output',
+    message: 'output filename. (default: same name as read, means update file) ex: README_GENERATE.md',
+};
+const DEPTH_QUESTION = {
+    type: 'number',
+    name: 'depth',
+    message: 'search depth number. more than 0. (if all put 0)',
+    validate: input => {
+        return isNumber(input, true) && input >= 0;
+    },
+    filter: input => {
+        return input >= 0 ? Number(input) : '';
+    },
+    default: 0,
+};
+export const RC_QUESTIONS = (_options) => [
+    {
+        ...INPUT_QUESTION,
+        validate: input => {
+            return !!input;
+        },
+    },
+    SKIP_HIDDEN_QUESTION,
+    INCLUDE_QUESTION,
+    EXCLUDE_QUESTION,
+    FILENAMES_QUESTION,
+    OUTPUT_QUESTION,
+    DEPTH_QUESTION,
+];
+export const GENERATE_TYPES = Object.freeze({
+    path: 'path',
+    random: 'random',
+    manual: 'manual',
+});
+const GENERATE_TYPE_CHOICES = Object.freeze([
+    { name: 'auto generate with directory path', short: 'dir path', value: GENERATE_TYPES.path },
+    { name: 'auto generate with uuid', short: 'random', value: GENERATE_TYPES.random },
+    { name: 'generate yourself', short: 'manually', value: GENERATE_TYPES.manual },
+]);
+const DIR_QUESTIONS = (options) => [SKIP_HIDDEN_QUESTION, INCLUDE_QUESTION, EXCLUDE_QUESTION, FILENAMES_QUESTION, DEPTH_QUESTION].map(QUESTION => ({
+    ...QUESTION,
+    when: (answers) => isDirectory(answers.input || options.input || ''),
+}));
+const FILE_QUESTIONS = (options) => [
+    {
+        type: 'input',
+        name: 'title',
+        message: 'title name. (default: auto detect title)',
+    },
+    {
+        type: 'confirm',
+        name: 'lock',
+        message: 'is locked? if true not link this file. (default: false)',
+        default: false,
+    },
+    OUTPUT_QUESTION,
+].map(QUESTION => ({ ...QUESTION, when: (answers) => !isDirectory(answers.input || options.input || '') }));
+export const LINK_QUESTIONS = (options) => [
+    {
+        ...INPUT_QUESTION,
+        message: 'Please put path from current dir with filename? (default: ".") ex: "./{path}/{filename}.md"',
+        default: '.',
+    },
+    {
+        type: 'list',
+        name: 'idGen',
+        message: `Choose generate type (default: ${GENERATE_TYPE_CHOICES[0].short})`,
+        choices: answers => {
+            if (isDirectory(answers.input || options.input || '')) {
+                return GENERATE_TYPE_CHOICES.filter(({ value }) => [GENERATE_TYPES.path, GENERATE_TYPES.random].includes(value));
+            }
+            return GENERATE_TYPE_CHOICES;
+        },
+        default: 0,
+    },
+    {
+        type: 'input',
+        name: 'id',
+        message: 'type id',
+        validate: input => {
+            return !!input;
+        },
+        when: answers => {
+            return answers.idGen === GENERATE_TYPES.manual;
+        },
+    },
+    ...DIR_QUESTIONS(options),
+    ...FILE_QUESTIONS(options),
+];
+export const QUESTIONS = (options) => ({
+    [TYPES.rc]: RC_QUESTIONS(options),
+    [TYPES.link]: LINK_QUESTIONS(options),
+});

package/dist/_internal/types/configs/help.d.ts

@@ -0,0 +1,2 @@
+export type CommandOptions = Record<never, never>;
+export type MdSettings = Record<never, never>;

package/dist/_internal/types/configs/links.d.ts

@@ -0,0 +1,19 @@
+export interface CommandOptions {
+    debug?: boolean;
+    skipHidden?: boolean;
+    include?: string;
+    exclude?: string;
+    filenames?: string;
+    input?: string;
+    output?: string;
+    depth?: string;
+}
+export interface MdSettings {
+    ['skip-hidden']: boolean;
+    include: string[];
+    exclude: string[];
+    filenames: string[];
+    input: string;
+    output: string;
+    depth: number;
+}

package/dist/_internal/types/configs/links.js

@@ -0,0 +1 @@
+export {};

package/dist/_internal/types/configs.d.ts

@@ -0,0 +1,3 @@
+export interface CommandOptions {
+    [key: string]: any;
+}

package/dist/_internal/types/md.d.ts

@@ -7,13 +7,15 @@ export declare const PROPERTIES: {
     END_DEFINE_LINKS: string;
     BEFORE_GENERATE_LINK: string;
 };
-export interface PathInfo {
+export interface MdAttributes {
     id: string;
     lock: boolean;
     title: string;
+    output: string;
+}
+export interface PathInfo extends MdAttributes {
     path: string;
     dir: string;
-    output: string;
     outputPath: string;
 }
 export interface PathDepthClassify {
@@ -46,3 +48,4 @@ export declare const MD_HOPPER_COMMENT_PREFIX_REG_EXP: RegExp;
 export declare const MD_HOPPER_PARAMS_REG_EXP: RegExp;
 export declare const MD_HOPPER_CONTENT_REG_EXP: RegExp;
 export declare const MD_HOPPER_PROPERTY_REG_EXP: RegExp;
+export declare const getParamExp: (param: string) => RegExp;

package/dist/_internal/types/md.js

@@ -19,3 +19,4 @@ export const MD_HOPPER_COMMENT_PREFIX_REG_EXP = new RegExp(`${BEGIN_COMMENT}\\s*
 export const MD_HOPPER_PARAMS_REG_EXP = new RegExp(`^[^${PARAM_SEPARATOR}]+${PARAM_SEPARATOR}(.*?)${END_COMMENT}.*`, 's');
 export const MD_HOPPER_CONTENT_REG_EXP = new RegExp(`^[^${PARAM_SEPARATOR}]+${PARAM_SEPARATOR}.*${END_COMMENT}(.*)`, 's');
 export const MD_HOPPER_PROPERTY_REG_EXP = new RegExp(`^([^${PARAM_SEPARATOR}]+?)${PARAM_SEPARATOR}.*`, 's');
+export const getParamExp = (param) => new RegExp(`${BEGIN_COMMENT}\\s*${MD_HOPPER_COMMENT_PREFIX}\\s*${PARAM_SEPARATOR}\\s*${param}\\s*${PARAM_SEPARATOR}.*?${END_COMMENT}\\n*`, 'gs');

package/dist/_internal/utils/chalk.d.ts

@@ -0,0 +1,7 @@
+export declare const success: import("chalk").ChalkInstance;
+export declare const warn: import("chalk").ChalkInstance;
+export declare const info: import("chalk").ChalkInstance;
+export declare const error: import("chalk").ChalkInstance;
+export declare const hop: import("chalk").ChalkInstance;
+export declare const cyan: import("chalk").ChalkInstance;
+export declare const bold: import("chalk").ChalkInstance;

package/dist/_internal/utils/chalk.js

@@ -0,0 +1,8 @@
+import chalk from 'chalk';
+export const success = chalk.green;
+export const warn = chalk.hex('#FFA500');
+export const info = chalk.hex('#77CFF5');
+export const error = chalk.red;
+export const hop = chalk.hex('#F577F5');
+export const cyan = chalk.cyan;
+export const bold = chalk.bold;

package/dist/_internal/utils/command.d.ts

@@ -1,18 +1,20 @@
 import { Command as Program } from 'commander';
-import { Action, ActionArg } from '../types/command.js';
-import { DefaultOptions } from '../types/options.js';
-import { Settings } from '../types/settings.js';
-export declare class CommandClass<T extends DefaultOptions> {
+import { Action } from '../types/command.js';
+type SettingsFnc<CommandOptions extends Record<string, any>, MdSettings extends Record<string, any>> = (options: CommandOptions) => MdSettings;
+export declare class CommandClass<CommandOptions extends Record<string, any>, MdSettings extends Record<string, any>> {
     program: Program;
     private befores;
     private args;
-    constructor(program: Program);
-    init(options: ActionArg<T>['options'], settings: Settings): Promise<this>;
+    private getSettingFnc;
+    constructor(program: Program, getSettingFnc: SettingsFnc<CommandOptions, MdSettings>);
+    init(options: CommandOptions, settings: MdSettings): this;
     command(command: string): this;
-    help(helpTxt: string): CommandClass<T>;
-    before(before: Action, ...args: any[]): CommandClass<T>;
-    description(description: string): CommandClass<T>;
-    option(...args: any[]): CommandClass<T>;
-    requiredOption(...args: any[]): CommandClass<T>;
+    help(helpTxt: string): this;
+    before(before: Action, ...args: any[]): this;
+    description(description: string): this;
+    option(...args: any[]): this;
+    requiredOption(...args: any[]): this;
     action(action: Action): void;
 }
+export declare const setCommands: <CommandOptions extends Record<string, any>, MdSettings extends Record<string, any>>(program: Program, commands: string[], initFnc: (commandClass: CommandClass<CommandOptions, MdSettings>) => void, getSettingFnc: SettingsFnc<CommandOptions, MdSettings>) => void;
+export {};

package/dist/_internal/utils/command.js

@@ -1,12 +1,13 @@
-import { getSettings } from './settings.js';
 export class CommandClass {
     program;
     befores = [];
     args;
-    constructor(program) {
+    getSettingFnc;
+    constructor(program, getSettingFnc) {
         this.program = program;
+        this.getSettingFnc = getSettingFnc;
     }
-    async init(options, settings) {
+    init(options, settings) {
         this.args = {
             options,
             settings,
@@ -45,7 +46,7 @@ export class CommandClass {
     action(action) {
         this.program = this.program.action(async (...args) => {
             const options = args[0];
-            await this.init(options, getSettings(options.input || ''));
+            await this.init(options, this.getSettingFnc(options));
             for (const before of this.befores) {
                 await before.fn(options, ...before.args);
             }
@@ -53,3 +54,8 @@ export class CommandClass {
         });
     }
 }
+export const setCommands = (program, commands, initFnc, getSettingFnc) => {
+    for (const command of commands) {
+        initFnc(new CommandClass(program, getSettingFnc).command(command));
+    }
+};

package/dist/_internal/utils/configs.d.ts

@@ -1,3 +1,4 @@
-export declare const SETTING_FILE_NAME = "README.md";
+export declare const DEFAULT_MD_FILENAME = "README.md";
+export declare const SETTING_FILENAME = "README.md";
 export declare const importLineRegExp: RegExp;
 export declare const indentRegExp: RegExp;

package/dist/_internal/utils/configs.js

@@ -1,3 +1,4 @@
-export const SETTING_FILE_NAME = 'README.md';
+export const DEFAULT_MD_FILENAME = 'README.md';
+export const SETTING_FILENAME = DEFAULT_MD_FILENAME;
 export const importLineRegExp = new RegExp(/\s*\/\/\s*@import\s+(\S+).*/g);
 export const indentRegExp = new RegExp(/^(\s*).*/);

package/dist/_internal/utils/fs.d.ts

@@ -1 +1,5 @@
+/// <reference types="node" resolution-mode="require"/>
 export { getAllFiles } from 'my-gadgetry/fs';
+export declare const readJsonFileSync: (path: string, encode?: BufferEncoding) => {};
+export declare const isDirectory: (path: string) => boolean;
+export declare const getAllMdFiles: (filenames: string[], startDir: string, _options?: import("my-gadgetry/fs").Options | undefined) => string[];

package/dist/_internal/utils/fs.js

@@ -1 +1,18 @@
+import { readFileSync, statSync, existsSync } from 'fs';
+import { getAllFiles } from 'my-gadgetry/fs';
+import { isJson } from 'my-gadgetry/type-check';
 export { getAllFiles } from 'my-gadgetry/fs';
+export const readJsonFileSync = (path, encode = 'utf-8') => {
+    const json = isJson(readFileSync(path, encode));
+    if (!json) {
+        return {};
+    }
+    return json;
+};
+export const isDirectory = (path) => {
+    if (!existsSync(path)) {
+        throw new Error('not exists');
+    }
+    return statSync(path).isDirectory();
+};
+export const getAllMdFiles = (filenames, ...args) => getAllFiles(...args).filter(path => filenames.some(filename => path.endsWith(`/${filename}`)));

package/dist/_internal/utils/link.d.ts

@@ -0,0 +1,4 @@
+import { MdSettings } from '../types/configs/links.js';
+export declare const DEFAULT_SETTINGS: MdSettings;
+export declare const parse: (txt: string) => MdSettings;
+export declare const getSettings: (inputFilename: string) => MdSettings;

package/dist/_internal/utils/{settings.js → link.js}

@@ -1,16 +1,18 @@
 import { readFileSync } from 'fs';
 import { getParam } from './md.js';
-import { SETTING_FILE_NAME } from './configs.js';
-import { getProjectRootPath } from './path.js';
-const Booleans = ['skip-hidden'];
-const Strings = ['exclude', 'include', 'filenames'];
-export const DEFAULT_MD_FILE_NAME = 'README.md';
+import { SETTING_FILENAME, DEFAULT_MD_FILENAME } from './configs.js';
+import { getExecDir } from './path.js';
+const BOOLEANS = ['skip-hidden'];
+const STRINGS = ['exclude', 'include', 'filenames'];
+const NUMBERS = ['depth'];
 export const DEFAULT_SETTINGS = Object.freeze({
     'skip-hidden': true,
     exclude: [],
     include: [],
-    filenames: [DEFAULT_MD_FILE_NAME],
-    output: DEFAULT_MD_FILE_NAME,
+    filenames: [DEFAULT_MD_FILENAME],
+    output: DEFAULT_MD_FILENAME,
+    input: '.',
+    depth: 0,
 });
 export const parse = (txt) => {
     const lines = txt.split('\n');
@@ -23,12 +25,15 @@ export const parse = (txt) => {
         const key = keyValue[0].trim();
         const value = keyValue[1].trim();
         let val;
-        if (Booleans.includes(key)) {
+        if (BOOLEANS.includes(key)) {
             val = JSON.parse(`${value}`);
         }
-        else if (Strings.includes(key)) {
+        else if (STRINGS.includes(key)) {
             val = value.split(',');
         }
+        else if (NUMBERS.includes(key)) {
+            val = Number(value);
+        }
         else {
             continue;
         }
@@ -40,6 +45,6 @@ export const parse = (txt) => {
     };
 };
 export const getSettings = (inputFilename) => {
-    const readme = readFileSync(`${getProjectRootPath()}/${inputFilename || SETTING_FILE_NAME}`, 'utf-8');
+    const readme = readFileSync(`${getExecDir()}/${inputFilename || SETTING_FILENAME}`, 'utf-8');
     return parse(getParam(readme, 'CONFIG'));
 };

package/dist/_internal/utils/log.d.ts

@@ -2,3 +2,4 @@ export declare const success: (...args: any[]) => void;
 export declare const warn: (...args: any[]) => void;
 export declare const info: (...args: any[]) => void;
 export declare const error: (...args: any[]) => void;
+export declare const hop: (...args: any[]) => void;

package/dist/_internal/utils/log.js

@@ -1,13 +1,16 @@
-import chalk from 'chalk';
+import * as chalk from './chalk.js';
 export const success = (...args) => {
-    console.log(chalk.green(...args));
+    console.log(chalk.success(...args));
 };
 export const warn = (...args) => {
-    console.log(chalk.hex('#FFA500')(...args));
+    console.log(chalk.warn(...args));
 };
 export const info = (...args) => {
-    console.log(chalk.blue(...args));
+    console.log(chalk.info(...args));
 };
 export const error = (...args) => {
-    console.log(chalk.red(...args));
+    console.log(chalk.error(...args));
+};
+export const hop = (...args) => {
+    console.log(chalk.hop(...args));
 };

package/dist/_internal/utils/md.d.ts

@@ -1,4 +1,11 @@
-import { Detail } from '../types/md.js';
+import { MdAttributes, Detail } from '../types/md.js';
 export declare const getParam: (txt: string, key: string) => string;
+export declare const getParamComment: (param: string, value: string) => string;
+export declare const getKeyValues: (keyValues: Record<string, string | number | boolean>) => string;
+type CommentParams = Record<string, string | number | boolean>;
+export declare const getParamsComment: <T extends CommentParams = CommentParams>(keyValues: T) => string;
+export declare const removeParam: (md: string, param: string) => string;
 export declare const getTitle: (txt: string) => string;
 export declare const replace: (detail: Detail, details: Detail[]) => string;
+export declare const getLinkedMdDetail: (md: string) => MdAttributes;
+export {};

package/dist/_internal/utils/md.js

@@ -1,5 +1,5 @@
 import { readFileSync } from 'fs';
-import { PROPERTIES, LINK_NAME_PREFIX, COMMENT_REG_EXP, PARAM_SEPARATOR, LINK_REG_EXP, MD_HOPPER_COMMENT_PREFIX, MD_HOPPER_COMMENT_PREFIX_REG_EXP, MD_HOPPER_PROPERTY_REG_EXP, MD_HOPPER_PARAMS_REG_EXP, BRAKE_LINE_REG_EXP, MD_HOPPER_CONTENT_REG_EXP, BEGIN_COMMENT, END_COMMENT, } from '../types/md.js';
+import { PROPERTIES, LINK_NAME_PREFIX, COMMENT_REG_EXP, PARAM_SEPARATOR, LINK_REG_EXP, MD_HOPPER_COMMENT_PREFIX, MD_HOPPER_COMMENT_PREFIX_REG_EXP, MD_HOPPER_PROPERTY_REG_EXP, MD_HOPPER_PARAMS_REG_EXP, BRAKE_LINE_REG_EXP, MD_HOPPER_CONTENT_REG_EXP, BEGIN_COMMENT, END_COMMENT, getParamExp, } from '../types/md.js';
 import { replaceLineToLink } from './md/line.js';
 import { getRelative } from './path.js';
 import { isBoolean } from './type-check.js';
@@ -11,6 +11,17 @@ export const getParam = (txt, key) => {
     }
     return reg.exec(txt)[1];
 };
+export const getParamComment = (param, value) => `${BEGIN_COMMENT} ${MD_HOPPER_COMMENT_PREFIX}${PARAM_SEPARATOR} ${param}${PARAM_SEPARATOR} ${value} ${END_COMMENT}`;
+export const getKeyValues = (keyValues) => {
+    const arr = Object.entries(keyValues);
+    const txt = arr.map(([key, value]) => `${key}${PARAM_SEPARATOR} ${value}`).join('\n');
+    const prefixSuffix = arr.length >= 2 ? '\n' : '';
+    return `${prefixSuffix}${txt}${prefixSuffix}`;
+};
+export const getParamsComment = (keyValues) => `${BEGIN_COMMENT} ${MD_HOPPER_COMMENT_PREFIX}${PARAM_SEPARATOR} ${getKeyValues(keyValues)} ${END_COMMENT}`;
+export const removeParam = (md, param) => {
+    return md.replace(getParamExp(param), '');
+};
 const getRemovedComment = (txt) => txt.replace(COMMENT_REG_EXP, '');
 const getFirstLine = (txt) => {
     const lines = txt.split('\n').filter(line => line.trim().length);
@@ -22,7 +33,9 @@ export const getTitle = (txt) => {
         return title;
     }
     const md = getRemovedComment(txt);
-    return md.replace(/\r?\n?#+(.*?)\r?\n.*/s, '$1').trim() || getFirstLine(md);
+    const lines = md.split('\n').filter(line => /^#+\s*./.test(line));
+    const str = lines.length >= 1 ? lines[0].trim().replace(/^\s*#+\s*(.+)$/, '$1') : getFirstLine(md);
+    return str.replace(/[[\]():]/g, '');
 };
 const getLinkName = (id) => `${LINK_NAME_PREFIX}${id}`;
 const getLink = (id, title) => `[${title}][${getLinkName(id)}]`;
@@ -221,3 +234,15 @@ export const replace = (detail, details) => {
     }
     return sections.join(`${BEGIN_COMMENT} ${MD_HOPPER_COMMENT_PREFIX}${PARAM_SEPARATOR} `);
 };
+export const getLinkedMdDetail = (md) => {
+    const id = getParam(md, 'ID').trim();
+    const LOCK = getParam(md, 'LOCK').trim();
+    const lock = LOCK ? JSON.parse(LOCK) : false;
+    const output = getParam(md, 'OUTPUT').trim();
+    return {
+        id,
+        lock,
+        title: (getTitle(md) || id).trim(),
+        output,
+    };
+};

package/dist/_internal/utils/minimatch.d.ts

@@ -0,0 +1,2 @@
+export declare const getExclude: (basePath: string, excludes: string[], skipHidden: boolean) => string[];
+export declare const getInclude: (basePath: string, includes: string[]) => string[];

package/dist/_internal/utils/minimatch.js

@@ -0,0 +1,13 @@
+import { join } from 'path';
+const replacePath = (str) => str.replace(/\/{2,}/, '/');
+export const getExclude = (basePath, excludes, skipHidden) => {
+    return [
+        '**/node_modules/.*/*',
+        '**/node_modules/**/*',
+        ...(skipHidden ? ['**/.*/**/*', '**/.*'] : []),
+        ...excludes.map(path => replacePath(join(basePath, path))),
+    ];
+};
+export const getInclude = (basePath, includes) => {
+    return includes.map(path => replacePath(join(basePath, path)));
+};

package/dist/_internal/utils/path.d.ts

@@ -1,6 +1,8 @@
-export declare const getProjectRootPath: () => string;
-export declare const getFullPath: (...path: string[]) => string;
-export declare const getDir: (path: string) => string;
+export declare const isDirectory: (path: string) => boolean;
+export declare const getExecDir: () => string;
+export declare const getParseDirPath: (path: string) => string;
+export declare const getParentDirname: (path: string) => string | undefined;
+export declare const getCommands: (path: string, start?: number, end?: number) => string[];
 export declare const DEPTH_TYPES: {
     ancestor: string;
     parent: string;