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

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

@@ -1,10 +1,12 @@
 export interface BundleOptions {
+    debug?: boolean;
     skipHidden?: boolean;
     include?: string;
     exclude?: string;
     filenames?: string;
     output?: string;
     input?: string;
+    depth?: string;
 }
 export interface HelpOptions {
     [key: string]: any;

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

@@ -4,5 +4,6 @@ export interface Settings {
     exclude: string[];
     filenames: string[];
     output: string;
+    depth: number;
 }
 export type RcSettings = Partial<Settings>;

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

@@ -1 +1,3 @@
+/// <reference types="node" resolution-mode="require"/>
 export { getAllFiles } from 'my-gadgetry/fs';
+export declare const readJsonFileSync: (path: string, encode?: BufferEncoding) => {};

package/dist/_internal/utils/fs.js

@@ -1 +1,10 @@
+import { readFileSync } from '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;
+};

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

@@ -11,3 +11,6 @@ export const info = (...args) => {
 export const error = (...args) => {
     console.log(chalk.red(...args));
 };
+export const hop = (...args) => {
+    console.log(chalk.hex('#F577F5')(...args));
+};

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

@@ -1,5 +1,4 @@
-export declare const getProjectRootPath: () => string;
-export declare const getFullPath: (...path: string[]) => string;
+export declare const getExecDir: () => string;
 export declare const getDir: (path: string) => string;
 export declare const DEPTH_TYPES: {
     ancestor: string;

package/dist/_internal/utils/path.js

@@ -1,19 +1,5 @@
-import { existsSync } from 'fs';
-import { join, parse, relative } from 'path';
-import { SETTING_FILE_NAME } from './configs.js';
-export const getProjectRootPath = () => {
-    let path = process.cwd();
-    if (!existsSync(join(path, SETTING_FILE_NAME))) {
-        for (const _ in process.cwd().split(/\//g)) {
-            path = join(path, '..');
-            if (existsSync(join(path, SETTING_FILE_NAME))) {
-                break;
-            }
-        }
-    }
-    return path;
-};
-export const getFullPath = (...path) => join(getProjectRootPath(), ...path);
+import { parse, relative } from 'path';
+export const getExecDir = () => process.cwd();
 export const getDir = (path) => {
     return parse(path).dir;
 };

package/dist/_internal/utils/process.js

@@ -1,8 +1,11 @@
+import { join } from 'path';
 import { ENVS } from '../types/process.js';
-import pkg from '../../../package.json' assert { type: 'json' };
+import { readJsonFileSync } from './fs.js';
 export * from '../types/process.js';
+const __dirname = import.meta.dirname;
 export const args = process.argv.slice(2);
 export const init = () => {
+    const pkg = readJsonFileSync(join(__dirname, '../../..', 'package.json'));
     set(ENVS.PACKAGE_VERSION, pkg.version);
     set(ENVS.IS_DEBUG, bool(process.env.DEBUG) || args.includes('--debug'));
 };

package/dist/_internal/utils/settings.js

@@ -1,9 +1,10 @@
 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'];
+import { getExecDir } from './path.js';
+const BOOLEANS = ['skip-hidden'];
+const STRINGS = ['exclude', 'include', 'filenames'];
+const NUMBERS = ['depth'];
 export const DEFAULT_MD_FILE_NAME = 'README.md';
 export const DEFAULT_SETTINGS = Object.freeze({
     'skip-hidden': true,
@@ -11,6 +12,7 @@ export const DEFAULT_SETTINGS = Object.freeze({
     include: [],
     filenames: [DEFAULT_MD_FILE_NAME],
     output: DEFAULT_MD_FILE_NAME,
+    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_FILE_NAME}`, 'utf-8');
     return parse(getParam(readme, 'CONFIG'));
 };

package/dist/cli/commands/generate/action.js

@@ -1,8 +1,9 @@
 import { readFileSync, writeFileSync } from 'fs';
 import { join } from 'path';
 import { getAllFiles } from '../../../_internal/utils/fs.js';
+import { info, warn, success } from '../../../_internal/utils/log.js';
 import { getParam, getTitle, replace } from '../../../_internal/utils/md.js';
-import { getProjectRootPath } from '../../../_internal/utils/path.js';
+import { getExecDir } from '../../../_internal/utils/path.js';
 import { getDir, getDepthType, DEPTH_TYPES } from '../../../_internal/utils/path.js';
 const replacePath = (str) => str.replace(/\/{2,}/, '/');
 const splitComma = (str, alternative) => (str ? str.split(',') : null) || alternative;
@@ -13,6 +14,7 @@ const mergeConfig = ({ options, settings }) => {
         include: splitComma(options.include, settings.include),
         filenames: splitComma(options.filenames, settings.filenames),
         output: options.output || settings.output,
+        depth: Number(options.depth) || settings.depth,
     };
 };
 const classify = (dataList) => {
@@ -63,17 +65,43 @@ const getPathDetails = (paths, config) => {
     return classify(list);
 };
 export const action = async (args) => {
-    const rootPath = getProjectRootPath();
+    const isDebug = args.options.debug;
+    if (isDebug) {
+        info('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        info('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- DEBUG MODE =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        info('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+    }
+    else {
+        warn('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        warn('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- PRODUCTION MODE =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        warn('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+    }
+    const execDir = getExecDir();
+    info('exec dir path', execDir);
     const config = mergeConfig(args);
+    info('settings', JSON.stringify(config, null, 2));
     const skipHidden = config['skip-hidden'] ? ['**/.*/**/*', '**/.*'] : [];
     const exclude = [
         '**/node_modules/.*/*',
         '**/node_modules/**/*',
         ...skipHidden,
-        ...config.exclude.map(path => replacePath(`${rootPath}/${path}`)),
+        ...config.exclude.map(path => replacePath(`${execDir}/${path}`)),
     ];
-    const include = config.include.map(path => replacePath(`${rootPath}/${path}`));
-    const paths = getAllFiles(rootPath, [], { include, exclude }).filter(path => config.filenames.some(filename => path.endsWith(`/${filename}`)));
+    info('exclude', JSON.stringify(exclude, null, 2));
+    const include = config.include.map(path => replacePath(`${execDir}/${path}`));
+    info('include', JSON.stringify(include, null, 2));
+    const paths = getAllFiles(execDir, {
+        include,
+        exclude,
+        ...(config.depth >= 1 ? { depth: config.depth } : {}),
+    }).filter(path => config.filenames.some(filename => path.endsWith(`/${filename}`)));
+    info('target paths', JSON.stringify(paths, null, 2));
+    if (isDebug) {
+        info('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        info('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- END OF DEBUG MODE =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        info('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+        return;
+    }
     const pathDetails = getPathDetails(paths, config);
     for (const pathDetail of pathDetails) {
         if (pathDetail.lock) {
@@ -82,6 +110,10 @@ export const action = async (args) => {
         const content = replace(pathDetail, pathDetails);
         const output = pathDetail.output || config.output;
         const writePath = output ? join(pathDetail.dir, output) : pathDetail.path;
+        success('write file: ', writePath);
         writeFileSync(writePath, content, 'utf-8');
     }
+    success('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+    success('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- END OF PRODUCTION MODE =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
+    success('=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-');
 };

package/dist/cli/commands/generate/command.js

@@ -9,6 +9,7 @@ const setAliases = (commandClass) => {
         .option('-f, --filenames <strings>', 'filenames, default: README.md only')
         .option('-o, --output <filename>', 'output filename. default: README.md (replace)')
         .option('-i, --input <filename>', 'target root filename, default: README.md')
+        .option('-D, --depth <filename>', 'depth level more than 0')
         .action(options => {
         return action(options);
     });

package/dist/cli/commands/help/action.js

@@ -1,23 +1,23 @@
 import { platform } from 'node:process';
-import { info } from '../../../_internal/utils/log.js';
+import { info, hop } from '../../../_internal/utils/log.js';
 import { get, ENVS } from '../../../_internal/utils/process.js';
 const ASCII_ART = `
  
- _       _   __   _   _   _             ___  ___   _____
-| |     | | |  \\ | | | | / /           /   |/   | |  _  \\
-| |     | | |   \\| | | |/ /           / /|   /| | | | | |
-| |     | | | |\\   | | |\\ \\          / / |__/ | | | | | |
-| |___  | | | | \\  | | | \\ \\        / /       | | | |_| |
-|_____| |_| |_|  \\_| |_|  \\_\\      /_/        |_| |_____/
+     ___  ___   _____        _   _   _____   _____   _____   _____   _____
+    /   |/   | |  _  \\      | | | | /  _  \\ |  _  \\ |  _  \\ | ____| |  _  \\
+   / /|   /| | | | | |      | |_| | | | | | | |_| | | |_| | | |__   | |_| |
+  / / |__/ | | | | | |      |  _  | | | | | |  ___/ |  ___/ |  __|  |  _  /
+ / /       | | | |_| |      | | | | | |_| | | |     | |     | |___  | | \\ \\
+/_/        |_| |_____/      |_| |_| \\_____/ |_|     |_|     |_____| |_|  \\_\\
 
 `;
 const VERSIONS = `
-  Link MD: ${get(ENVS.PACKAGE_VERSION)}
+  MD Hopper: ${get(ENVS.PACKAGE_VERSION)}
   Node: ${process.versions.node}
   OS: ${platform} ${process.arch}
   `;
 const show = () => {
-    info(ASCII_ART);
+    hop(ASCII_ART);
     info(VERSIONS);
 };
 export const action = async (_) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "md-hopper",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "description": "",
   "type": "module",
   "bin": {
@@ -63,16 +63,16 @@
     "@actions/exec": "^1.1.1",
     "@actions/github": "^6.0.0",
     "chalk": "^5.3.0",
-    "commander": "^12.0.0",
+    "commander": "^12.1.0",
     "marked": "^12.0.2",
     "minimatch": "^9.0.4",
-    "my-gadgetry": "^1.1.2",
-    "zx": "^8.1.0"
+    "my-gadgetry": "^1.2.5",
+    "zx": "^8.1.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.24.5",
-    "@babel/preset-env": "^7.24.5",
-    "@babel/preset-typescript": "^7.24.1",
+    "@babel/core": "^7.24.6",
+    "@babel/preset-env": "^7.24.6",
+    "@babel/preset-typescript": "^7.24.6",
     "@eslint/js": "^8.57.0",
     "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^7.9.0",
@@ -87,15 +87,15 @@
     "fs-extra": "^11.2.0",
     "husky": "^9.0.11",
     "jest": "^29.7.0",
-    "lint-staged": "^15.2.2",
+    "lint-staged": "^15.2.5",
     "npm-run-all2": "^6.2.0",
     "prettier": "^3.2.5",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.1.4",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.10",
-    "tsx": "^4.10.4",
+    "tsx": "^4.11.0",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^7.9.0"
+    "typescript-eslint": "^7.11.0"
   },
   "files": [
     "cli",