Allow the package to be imported

ksw2000 · ksw2000 · commit afd2ab0efde9 · 2023-04-13T13:26:02.000+08:00
diff --git a/lib/container.ts b/lib/container.ts
@@ -5,7 +5,7 @@ import StateBlock from "markdown-it/lib/rules_block/state_block"
 import Token from "markdown-it/lib/token"
 
 const names = ['success', 'info', 'warning', 'danger', 'spoiler']
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
+
 export function MarkdownItContainer(md: MarkdownIt, _options: MarkdownIt.Options) {
   // Second param may be useful if you decide
   // to increase minimal allowed marker length
diff --git a/lib/converter.ts b/lib/converter.ts
@@ -24,18 +24,20 @@ const MarkdownItRuby = require('markdown-it-ruby')
 const htmlEncode = require('htmlencode').htmlEncode;
 
 export class Convert {
-  src: Array<string>
-  dest: string
-  layout: string
-  md: MarkdownIt
-  metadata: Metadata
+  private md: MarkdownIt
+  private metadata: Metadata
+  private layout: string
 
-  constructor(src: Array<string>, dest: string, layout: string, hardBreak: boolean) {
-    this.src = src
-    this.dest = dest
-    this.layout = layout
+  /**
+   * @param layout set null if you want to use default layout, 
+   * @param hardBreak set true if want to use hardBread
+   */
+  constructor(layout: string | null, hardBreak: boolean = false) {
     this.metadata = new Metadata()
-
+    if (layout === null) {
+      layout = this.defaultLayout()
+    }
+    this.layout = layout
     // https://hackmd.io/c/codimd-documentation/%2F%40codimd%2Fmarkdown-syntax
     this.md = new MarkdownIt({
       html: true,
@@ -69,86 +71,117 @@ export class Convert {
       .use(MarkdownItFenceX)
   }
 
-  // @param html: html string
-  // @return: html string with layout
-  private addLayout(metadata: Metadata, html: string): string {
-    if (fs.existsSync(this.layout)) {
-      const layout = fs.readFileSync(this.layout, { encoding: 'utf-8' })
-      let metas = ''
-      if (metadata.title !== '') {
-        metas += '<title>' + htmlEncode(metadata.title) + '</title>\n'
-        metas += '<meta name="twitter:title" content="' + htmlEncode(metadata.title) + '" />\n'
-        metas += '<meta property="og:title" content="' + htmlEncode(metadata.title) + '" />\n'
-      }
-      if (metadata.robots !== '') {
-        metas += '<meta name="robots" content="' + htmlEncode(metadata.robots) + '">\n'
-      }
-      if (metadata.description !== '') {
-        metas += '<meta name="description" content="' + htmlEncode(metadata.description) + '">\n'
-        metas += '<meta name="twitter:description" content="' + htmlEncode(metadata.description) + '">\n'
-        metas += '<meta property="og:description" content="' + htmlEncode(metadata.description) + '">\n'
-      }
-      if (metadata.image !== '') {
-        metas += '<meta name="twitter:image:src" content="' + htmlEncode(metadata.image) + '" />\n'
-        metas += '<meta property="og:image" content="' + htmlEncode(metadata.image) + '" />\n'
-      }
-      let lang = ''
-      if (metadata.lang !== '') {
-        lang = ' lang="' + htmlEncode(metadata.lang) + '"'
-      }
-      let dir = ''
-      if (metadata.dir !== '') {
-        dir = ' dir="' + htmlEncode(metadata.dir) + '"'
-      }
-      return layout
-        .replace('{{lang}}', lang)
-        .replace('{{dir}}', dir)
-        .replace('{{metas}}', metas)
-        .replace('{{main}}', html)
+  /**
+   * @param main main HTML string converted by MarkdownIt 
+   * @returns generated code
+   */
+  private useLayout(main: string): string {
+    const metadata = this.metadata
+    let metas = ''
+    if (metadata.title !== '') {
+      metas += '<title>' + htmlEncode(metadata.title) + '</title>\n'
+      metas += '<meta name="twitter:title" content="' + htmlEncode(metadata.title) + '" />\n'
+      metas += '<meta property="og:title" content="' + htmlEncode(metadata.title) + '" />\n'
+    }
+    if (metadata.robots !== '') {
+      metas += '<meta name="robots" content="' + htmlEncode(metadata.robots) + '">\n'
+    }
+    if (metadata.description !== '') {
+      metas += '<meta name="description" content="' + htmlEncode(metadata.description) + '">\n'
+      metas += '<meta name="twitter:description" content="' + htmlEncode(metadata.description) + '">\n'
+      metas += '<meta property="og:description" content="' + htmlEncode(metadata.description) + '">\n'
+    }
+    if (metadata.image !== '') {
+      metas += '<meta name="twitter:image:src" content="' + htmlEncode(metadata.image) + '" />\n'
+      metas += '<meta property="og:image" content="' + htmlEncode(metadata.image) + '" />\n'
+    }
+    let lang = ''
+    if (metadata.lang !== '') {
+      lang = ' lang="' + htmlEncode(metadata.lang) + '"'
+    }
+    let dir = ''
+    if (metadata.dir !== '') {
+      dir = ' dir="' + htmlEncode(metadata.dir) + '"'
     }
 
-    console.error(`${this.layout} is not found`)
-    return html
+    return `${this.layout}`
+      .replace('{{lang}}', lang)
+      .replace('{{dir}}', dir)
+      .replace('{{metas}}', metas)
+      .replace('{{main}}', main)
   }
 
-  // @param filepath: the path of the file should be converted
-  // this function doesn't check the ext name of filepath
-  public convertFile(filepath: string) {
-    const markdown = fs.readFileSync(filepath, { encoding: 'utf-8' })
+  /**
+   * @param markdown markdown text
+   * @returns generated html text
+   */
+  public convert(markdown: string): string {
     const html = this.md.render(markdown)
-    const res = this.addLayout(this.metadata, html)
-    const basename = path.basename(filepath)
-    fs.writeFileSync(path.join(this.dest, basename.replace(/\.md$/, '.html')), res)
+    return this.useLayout(html)
+  }
+
+  /**
+   * Get metadata after converting.
+   * Before calling this function, Please call convert() first
+   * @returns metadata of the markdown file
+   */
+  public getMetadata(): Metadata{
+    return this.metadata
+  }
+
+  /**
+   * @returns default HTML layout
+   */
+  public defaultLayout(): string {
+    return fs.readFileSync(path.join(__dirname, '../layout.html'), { encoding: 'utf-8' })
   }
 
-  public convertBatch() {
-    if (!fs.existsSync(this.dest)) {
-      fs.mkdirSync(this.dest)
+  /**
+   * ```
+   * 
+   * .
+   * ├── foo
+   * │   ├── a.md
+   * │   └── b.md
+   * ├── c.md
+   * └── out
+   *     ├── foo
+   *     │   ├── a.html
+   *     │   └── b.html
+   *     └── c.html
+   * ```
+   * @param filePathsOrDir a list of the path of files or directories e.g. ["./foo", "c.md"]
+   * @param destDir the path of destination directory e.g. ["./build"]
+   */
+  public convertFiles(filePathsOrDir: fs.PathLike[], destDir: fs.PathLike) {
+    console.log(filePathsOrDir)
+
+    if (!fs.existsSync(destDir)) {
+      fs.mkdirSync(destDir)
     }
-    this.src.forEach((fileOrDir: string) => {
-      if (!fs.existsSync(fileOrDir)) {
-        console.error(`${fileOrDir} is not found`)
+
+    const files: fs.PathLike[] = []
+    filePathsOrDir.forEach((fn: fs.PathLike) => {
+      if (!fs.existsSync(fn)) {
+        console.error(`${fn} is not found`)
         return
       }
-
-      const stats = fs.statSync(fileOrDir)
-
+      const stats = fs.statSync(fn)
       if (stats.isDirectory()) {
-        fs.readdir(fileOrDir, (err: NodeJS.ErrnoException | null, files: string[]) => {
-          if (err) {
-            throw (err)
-          }
-          files?.forEach((fn) => {
-            if (path.extname(fn) === '.md') {
-              this.convertFile(path.join(fileOrDir, fn))
-            }
-          })
+        const f = fs.readdirSync(fn)
+        f.forEach((e: fs.PathLike) => {
+          files.push(path.join(fn.toString(), e.toString()))
         })
       } else if (stats.isFile()) {
-        if (path.extname(fileOrDir) === '.md') {
-          this.convertFile(fileOrDir)
-        }
+        files.push(fn)
       }
     })
+
+    files.forEach((fn: fs.PathLike) => {
+      const markdown = fs.readFileSync(fn, { encoding: 'utf-8' })
+      const res = this.convert(markdown)
+      const basename = path.basename(fn.toString())
+      fs.writeFileSync(path.join(destDir.toString(), basename.replace(/\.md$/, '.html')), res)
+    });
   }
-}
+}
diff --git a/lib/index.ts b/lib/index.ts
@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import commander from 'commander'
-import path from 'path'
+import fs from 'fs'
 import { Convert } from './converter'
 
 commander.program.version('0.0.10', '-v, --version', 'output the current version')
@@ -14,6 +14,9 @@ commander.program
 const options = commander.program.opts()
 
 const dest: string = options.destination === '' ? './output' : options.destination
-const layout: string = options.layout === '' ? path.join(__dirname, '../layout.html') : options.layout
+const layout: string | null = options.layout !== '' ? fs.readFileSync(options.layout, { encoding: 'utf-8' }) : null
 const hardBreak: boolean = options.hardBreak
-new Convert(options.source, dest, layout, hardBreak).convertBatch()
+
+const converter = new Convert(layout, hardBreak)
+
+converter.convertFiles(options.source, dest)
diff --git a/lib/yaml-metadata.ts b/lib/yaml-metadata.ts
@@ -60,6 +60,7 @@ export function MarkdownItYAMLMetadata(md: MarkdownIt, callback: (metadata: Meta
     return true
   }
 
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   function renderer(tokens: Token[], idx: number, _options: MarkdownIt.Options, _evn: any): string {
     const token = tokens[idx]!
     if (callback) {
diff --git a/package.json b/package.json
@@ -17,7 +17,8 @@
   "bin": {
     "hmd2html": "dist/index.js"
   },
-  "types": "types/index.d.ts",
+  "main":"dist/converter.js",
+  "types": "types/converter.d.ts",
   "scripts": {
     "build": "tsc",
     "test": "tsc & npx hmd2html -s ./example",
diff --git a/tsconfig.json b/tsconfig.json
@@ -42,18 +42,18 @@
     // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
 
     /* Emit */
-    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
     // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
     // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
     // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
     // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
-    "outDir": "dist",                                   /* Specify an output folder for all emitted files. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
     "removeComments": false,                           /* Disable emitting comments. */
     // "noEmit": true,                                   /* Disable emitting files from a compilation. */
     // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
     // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
     // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
-    "sourceRoot": "./src",                                 /* Specify the root path for debuggers to find the reference source code. */
+    "sourceRoot": "./lib",                                 /* Specify the root path for debuggers to find the reference source code. */
     // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
     "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
     // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ export function MarkdownItYAMLMetadata(md: MarkdownIt, callback: (metadata: Meta`
`60`	`60`	`return true`
`61`	`61`	`}`
`62`	`62`
	`63`	`+ // eslint-disable-next-line @typescript-eslint/no-unused-vars`
`63`	`64`	`function renderer(tokens: Token[], idx: number, _options: MarkdownIt.Options, _evn: any): string {`
`64`	`65`	`const token = tokens[idx]!`
`65`	`66`	`if (callback) {`