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

package/README.md

@@ -11,7 +11,7 @@ id: generate-command
 inline: true
 -->
 
-[generate][md_hopper:generate-command]
+- [generate][md_hopper:generate-command]
 
 <!-- MD_HOPPER: BEGIN_DEFINE_LINKS: -->
 

package/dist/_internal/types/md.js

@@ -14,7 +14,7 @@ export const PARAM_SEPARATOR = ':';
 export const MD_HOPPER_COMMENT_PREFIX = 'MD_HOPPER';
 export const COMMENT_REG_EXP = new RegExp(`${BEGIN_COMMENT}\\s*.*?${END_COMMENT}`, 'gs');
 export const BRAKE_LINE_REG_EXP = new RegExp(/\r?\n/, 'g');
-export const LINK_REG_EXP = new RegExp('^\\s*.*\\[(.+)][(|\\[](.+)[)|\\]].*');
+export const LINK_REG_EXP = new RegExp('^(\\s*.*)\\[(.+)][(|\\[](.+)[)|\\]].*');
 export const MD_HOPPER_COMMENT_PREFIX_REG_EXP = new RegExp(`${BEGIN_COMMENT}\\s*${MD_HOPPER_COMMENT_PREFIX}${PARAM_SEPARATOR}\\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');

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

@@ -0,0 +1 @@
+export declare const lexer: (txt: string) => import("marked").Token;

package/dist/_internal/utils/md/lexer.js

@@ -0,0 +1,5 @@
+import { marked } from 'marked';
+export const lexer = (txt) => {
+    const tokens = marked.lexer(txt);
+    return tokens[0];
+};

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

@@ -0,0 +1,22 @@
+import { Token as _Token, Tokens } from 'marked';
+type Token = Tokens.ListItem | Tokens.Heading;
+interface SymbolEl {
+    raw: Token['raw'];
+    text: Token['text'];
+}
+export declare const getSymbolAndText: ({ raw, text }: SymbolEl) => {
+    symbol: string;
+    text: string;
+};
+export declare const getElements: (txt: string) => {
+    indent: string;
+    str: string;
+    token: _Token;
+};
+export declare const getProperties: (txt: string) => {
+    indent: string;
+    symbol: string;
+    text: string;
+} | null;
+export declare const replaceLineToLink: (txt: string, defineName: string) => string;
+export {};

package/dist/_internal/utils/md/line.js

@@ -0,0 +1,51 @@
+import { lexer } from './lexer.js';
+const TOKEN_TYPES = {
+    list: 'list',
+    heading: 'heading',
+};
+export const getSymbolAndText = ({ raw, text }) => {
+    return {
+        symbol: raw.replace(new RegExp(`${text}$`), ''),
+        text,
+    };
+};
+export const getElements = (txt) => {
+    const indent = txt.replace(/^(\s*)(.*)$/, '$1');
+    const str = txt.replace(/^(\s*)(.*)$/, '$2');
+    const token = lexer(str);
+    return {
+        indent,
+        str,
+        token,
+    };
+};
+export const getProperties = (txt) => {
+    const { indent, token } = getElements(txt);
+    let symbol = '';
+    let text = '';
+    switch (token.type) {
+        case TOKEN_TYPES.list: {
+            const symbolAndText = getSymbolAndText(token.items[0]);
+            symbol = symbolAndText.symbol;
+            text = symbolAndText.text;
+            break;
+        }
+        case TOKEN_TYPES.heading: {
+            const symbolAndText = getSymbolAndText(token);
+            symbol = symbolAndText.symbol;
+            text = symbolAndText.text;
+            break;
+        }
+        default:
+            return null;
+    }
+    return { indent, symbol, text };
+};
+export const replaceLineToLink = (txt, defineName) => {
+    const properties = getProperties(txt);
+    if (!properties) {
+        return `[${txt}][${defineName}]`;
+    }
+    const { indent, symbol, text } = properties;
+    return `${indent}${symbol}[${text}][${defineName}]`;
+};

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

@@ -1,5 +1,4 @@
 import { Detail } from '../types/md.js';
-export declare const getParam: (text: string, key: string) => string;
-export declare const getParams: (text: string, key: string) => RegExpMatchArray | "";
-export declare const getTitle: (text: string) => string;
+export declare const getParam: (txt: string, key: string) => string;
+export declare const getTitle: (txt: string) => string;
 export declare const replace: (detail: Detail, details: Detail[]) => string;

package/dist/_internal/utils/md.js

@@ -1,35 +1,28 @@
 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 { replaceLineToLink } from './md/line.js';
 import { getRelative } from './path.js';
 import { isBoolean } from './type-check.js';
-export const getParam = (text, key) => {
+export const getParam = (txt, key) => {
     const PREFIX = `${BEGIN_COMMENT}\\s*${MD_HOPPER_COMMENT_PREFIX}:\\s*${key}:`;
     const reg = new RegExp(`${PREFIX}(.*?)${END_COMMENT}`, 's');
-    if (!reg.test(text)) {
+    if (!reg.test(txt)) {
         return '';
     }
-    return reg.exec(text)[1];
+    return reg.exec(txt)[1];
 };
-export const getParams = (text, key) => {
-    const PREFIX = `${BEGIN_COMMENT}\\s*${MD_HOPPER_COMMENT_PREFIX}:\\s*${key}:`;
-    const reg = new RegExp(`${PREFIX}(.*?)${END_COMMENT}`, 'gs');
-    if (!reg.test(text)) {
-        return '';
-    }
-    return text.match(reg);
-};
-const getRemovedCommentOut = (text) => text.replace(COMMENT_REG_EXP, '');
-const getFirstLine = (text) => {
-    const lines = text.split('\n').filter(line => line.trim().length);
+const getRemovedComment = (txt) => txt.replace(COMMENT_REG_EXP, '');
+const getFirstLine = (txt) => {
+    const lines = txt.split('\n').filter(line => line.trim().length);
     return lines.length ? lines[0].trim() : '';
 };
-export const getTitle = (text) => {
-    const title = getParam(text, 'TITLE');
+export const getTitle = (txt) => {
+    const title = getParam(txt, 'TITLE');
     if (title) {
         return title;
     }
-    const md = getRemovedCommentOut(text);
-    return getParam(text, 'TITLE') || md.replace(/\r?\n?#+(.*?)\r?\n.*/s, '$1').trim() || getFirstLine(md);
+    const md = getRemovedComment(txt);
+    return md.replace(/\r?\n?#+(.*?)\r?\n.*/s, '$1').trim() || getFirstLine(md);
 };
 const getLinkName = (id) => `${LINK_NAME_PREFIX}${id}`;
 const getLink = (id, title) => `[${title}][${getLinkName(id)}]`;
@@ -37,17 +30,16 @@ const getLinksByDetails = (details) => details.map(d => getLink(d.id, d.title));
 const getDefineLink = (id, url, title) => `[${getLinkName(id)}]: ${url}${title ? ` '${title}'` : ''}`;
 const replaceToLink = (txt, inline, detail) => {
     if (LINK_REG_EXP.test(txt)) {
-        const url = txt.replace(LINK_REG_EXP, '$2');
+        const url = txt.replace(LINK_REG_EXP, '$3');
         if (url === getLinkName(detail.id)) {
             return txt;
         }
-        return `[${txt.replace(LINK_REG_EXP, '$1')}][${getLinkName(detail.id)}]
-<!-- ${MD_HOPPER_COMMENT_PREFIX}${PARAM_SEPARATOR} ${PROPERTIES.BEFORE_GENERATE_LINK}${PARAM_SEPARATOR} -->
-<!-- ${txt} -->
+        return `${replaceLineToLink(txt.replace(LINK_REG_EXP, '$1$2'), getLinkName(detail.id))}
+<!-- ${MD_HOPPER_COMMENT_PREFIX}${PARAM_SEPARATOR} ${PROPERTIES.BEFORE_GENERATE_LINK} (${new Date().toLocaleString()})${PARAM_SEPARATOR} ${txt} -->
 `;
     }
     if (inline) {
-        return `[${txt}][${getLinkName(detail.id)}]`;
+        return replaceLineToLink(txt, getLinkName(detail.id));
     }
     else {
         return `[${detail.title}][${getLinkName(detail.id)}]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "md-hopper",
-  "version": "1.0.0-alpha",
+  "version": "1.0.0-alpha.1",
   "description": "",
   "type": "module",
   "bin": {
@@ -16,6 +16,12 @@
     "url": "https://github.com/cilly-yllic/md-hopper/issues"
   },
   "homepage": "https://github.com/cilly-yllic/md-hopper#readme",
+  "keywords": [
+    "markdown",
+    "readme",
+    "md",
+    "links"
+  ],
   "scripts": {
     "prepare": "husky",
     "jest": "jest",
@@ -30,20 +36,17 @@
     "generate": "tsx --tsconfig ./tsconfig.zx.json ./tools/generate-alias.zx.ts",
     "ci:update-version": "tsx --tsconfig ./tsconfig.zx.json ./tools/update-version.zx.ts",
     "md:generate": "tsx --tsconfig ./tsconfig.zx.json ./tools/generate-md.ts",
-
     "//--- test ---//": "",
     "test": "run-s test:*",
     "test:lint": "npm run lint",
     "test:prettier": "npm run prettier:check",
     "test:jest": "npm run jest",
-
     "//--- build ---//": "",
     "build": "run-s build:*",
     "build:test": "npm run test",
     "build:clean": "npm run clean",
     "build:tsc": "npm run tsc",
     "build:generate": "npm run generate",
-
     "//--- publish ---//": "",
     "publish:build": "run-s build:{clean,tsc,generate}"
   },
@@ -61,6 +64,7 @@
     "@actions/github": "^6.0.0",
     "chalk": "^5.3.0",
     "commander": "^12.0.0",
+    "marked": "^12.0.2",
     "minimatch": "^9.0.4",
     "my-gadgetry": "^1.1.2",
     "zx": "^8.1.0"