@mryhryki/markdown-preview 0.4.3 → 0.5.1

package/README.md

@@ -4,7 +4,7 @@ Markdown realtime preview on browser with your favorite editor.
 
 ## Demo
 
-![DEMO](./gif/demo.gif)
+![DEMO](https://github.com/mryhryki/markdown-preview/assets/12733897/68cb3653-254b-4540-9859-0a7c262736e0)
 
 ## Usage
 

package/index.js

@@ -1,4 +1,4 @@
 #!/usr/bin/env node
 "use strict";
 
-require("./src/index");
+require("./src/index.js");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mryhryki/markdown-preview",
   "description": "Markdown realtime preview on browser",
-  "version": "0.4.3",
+  "version": "0.5.1",
   "author": "mryhryki",
   "license": "MIT",
   "publishConfig": {
@@ -20,32 +20,64 @@
     "url": "https://github.com/mryhryki/markdown-preview/issues"
   },
   "engines": {
-    "node": ">=12.0.0",
-    "npm": ">=6.0.0"
+    "node": ">=18.0.0",
+    "npm": ">=9.0.0"
   },
   "main": "index.js",
   "bin": {
     "markdown-preview": "index.js"
   },
   "dependencies": {
-    "express": "^4.18.2",
+    "express": "^4.18.3",
     "express-ws": "^5.0.2",
     "log4js": "^6.9.1",
     "opener": "^1.5.2",
     "serve-index": "^1.9.1",
-    "ws": "^8.13.0"
+    "ws": "^8.16.0"
   },
   "devDependencies": {
-    "@mryhryki/lint": "^0.0.12",
-    "jest": "^29.5.0",
-    "nodemon": "^2.0.21"
+    "@types/express": "^4.17.21",
+    "@types/express-ws": "^3.0.4",
+    "@types/jest": "^29.5.12",
+    "@types/opener": "^1.4.3",
+    "@types/serve-index": "^1.9.4",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-react": "^7.34.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-simple-import-sort": "^12.0.0",
+    "eslint-plugin-unused-imports": "^3.1.0",
+    "jest": "^29.7.0",
+    "nodemon": "^3.1.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.2"
   },
   "scripts": {
-    "start": "node ./index.js",
-    "dev": "nodemon --watch ./src/ index.js --no-opener --log-level debug",
-    "lint": "mryhryki-lint",
-    "lint:fix": "mryhryki-lint --fix",
+    "build": "tsc",
+    "dev": "nodemon --watch ./src/ --ext 'ts' --exec 'npm start -- --no-opener --log-level debug'",
+    "lint": "eslint ./src/",
+    "lint:fix": "eslint ./src/ --fix",
+    "release": "npm run build && npm publish",
+    "start": "npm run build && node ./index.js",
     "test": "jest",
-    "test:watch": "jest --watchAll"
+    "test:watch": "jest --watchAll",
+    "type": "tsc --noEmit",
+    "type:watch": "tsc --noEmit --watch"
+  },
+  "files": [
+    "index.js",
+    "src/**/*.js",
+    "static/**/*",
+    "template/**/*"
+  ],
+  "prettier": {
+    "printWidth": 120
+  },
+  "jest": {
+    "preset": "ts-jest",
+    "testEnvironment": "node"
   }
 }

package/src/index.js

@@ -1,46 +1,49 @@
 "use strict";
-
-const express = require("express");
-const expressWs = require("express-ws");
-const serveIndex = require("serve-index");
-const opener = require("opener");
-const getLogger = require("./lib/logger");
-const { showUsage, showVersion } = require("./lib/show");
-const MarkdownHandler = require("./markdown");
-const WebSocketHandler = require("./websocket");
-const { rootDir, staticDir } = require("./lib/directory");
-const Params = require("./lib/params");
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const express_1 = __importDefault(require("express"));
+const express_ws_1 = __importDefault(require("express-ws"));
+const serve_index_1 = __importDefault(require("serve-index"));
+const opener_1 = __importDefault(require("opener"));
+const logger_1 = require("./lib/logger");
+const show_1 = require("./lib/show");
+const markdown_1 = require("./markdown");
+const websocket_1 = require("./websocket");
+const directory_1 = require("./lib/directory");
+const params_1 = require("./lib/params");
 try {
-  const params = new Params(process.env, process.argv.slice(2));
-  if (params.help) showUsage();
-  if (params.version) showVersion();
-
-  const logger = getLogger(params.logLevel);
-  const previewUrl = `http://localhost:${params.port}`;
-
-  console.log("Root Directory :", rootDir);
-  console.log("Default File   :", params.filepath);
-  console.log("Extensions     :", params.extensions.join(", "));
-  console.log("Template File  :", params.template);
-  console.log(`Preview URL    : ${previewUrl}`);
-
-  const app = express();
-  expressWs(app);
-  app.get("/", (_req, res) => res.redirect(params.filepath));
-  app.ws("/ws", WebSocketHandler(logger));
-  params.extensions.forEach((ext) => {
-    app.get(new RegExp(`^/.+\.${ext}$`), MarkdownHandler(params.template));
-  });
-  app.use(express.static(rootDir, { index: false }));
-  app.use(express.static(staticDir, { index: false }));
-  app.use(serveIndex(rootDir, { icons: true, view: "details" }));
-  app.listen(params.port);
-
-  if (!params.noOpener) {
-    opener(previewUrl);
-  }
-} catch (err) {
-  console.error(err.message);
-  showUsage(true);
+    const params = new params_1.Params(process.env, process.argv.slice(2));
+    if (params.help)
+        (0, show_1.showUsage)();
+    if (params.version)
+        (0, show_1.showVersion)();
+    const logger = (0, logger_1.getLogger)(params.logLevel);
+    const previewUrl = `http://localhost:${params.port}`;
+    console.log("Root Directory :", directory_1.rootDir);
+    console.log("Default File   :", params.filepath);
+    console.log("Extensions     :", params.extensions.join(", "));
+    console.log("Template File  :", params.template);
+    console.log(`Preview URL    : ${previewUrl}`);
+    const app = (0, express_1.default)();
+    (0, express_ws_1.default)(app);
+    app.get("/", (_req, res) => res.redirect(params.filepath));
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    app.ws("/ws", (0, websocket_1.WebSocketHandler)(logger));
+    params.extensions.forEach((ext) => {
+        app.get(new RegExp(`^/.+\.${ext}$`), (0, markdown_1.MarkdownHandler)(params.template));
+    });
+    app.use(express_1.default.static(directory_1.rootDir, { index: false }));
+    app.use(express_1.default.static(directory_1.staticDir, { index: false }));
+    app.use((0, serve_index_1.default)(directory_1.rootDir, { icons: true, view: "details" }));
+    app.listen(params.port);
+    if (!params.noOpener) {
+        (0, opener_1.default)(previewUrl);
+    }
+}
+catch (err) {
+    console.error(err);
+    (0, show_1.showUsage)(true);
 }

package/src/lib/directory.js

@@ -1,15 +1,11 @@
 "use strict";
-
-const path = require("path");
-
-const rootDir = process.cwd();
-const projectDir = path.resolve(__dirname, "..", "..");
-const staticDir = path.resolve(projectDir, "static");
-const templateDir = path.resolve(projectDir, "template");
-
-module.exports = {
-  rootDir,
-  projectDir,
-  staticDir,
-  templateDir,
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templateDir = exports.staticDir = exports.projectDir = exports.rootDir = void 0;
+const path_1 = __importDefault(require("path"));
+exports.rootDir = process.cwd();
+exports.projectDir = path_1.default.resolve(__dirname, "..", "..");
+exports.staticDir = path_1.default.resolve(exports.projectDir, "static");
+exports.templateDir = path_1.default.resolve(exports.projectDir, "template");

package/src/lib/file.js

@@ -1,16 +1,17 @@
 "use strict";
-
-const fs = require("fs");
-
-const existsFile = (filepath) => {
-  try {
-    fs.statSync(filepath);
-    return true;
-  } catch (_) {
-    return false;
-  }
-};
-
-module.exports = {
-  existsFile,
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.existsFile = void 0;
+const fs_1 = __importDefault(require("fs"));
+function existsFile(filepath) {
+    try {
+        fs_1.default.statSync(filepath);
+        return true;
+    }
+    catch (_) {
+        return false;
+    }
+}
+exports.existsFile = existsFile;

package/src/lib/file_watcher.js

@@ -1,59 +1,59 @@
 "use strict";
-
-const fs = require("fs");
-const path = require("path");
-const { rootDir } = require("./directory");
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileWatcher = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const directory_1 = require("./directory");
 class FileWatcher {
-  constructor(logger) {
-    this.logger = logger;
-    this._target = {};
-    setInterval(() => {
-      Object.keys(this._target).forEach((filepath) => {
-        try {
-          const fileinfo = this._target[filepath];
-          const currentLastModified = this.getFileLastModified(filepath);
-          if (fileinfo.lastModified !== currentLastModified) {
-            this.logger.info("File update:", path.resolve(rootDir, filepath));
-            fileinfo.lastModified = currentLastModified;
-            if (this._onFileChanged != null) {
-              this._onFileChanged(this.getFileInfo(filepath));
-            }
-          }
-        } catch (err) {
-          console.error(err);
-        }
-      });
-    }, 250 /* check 4 times per second */);
-  }
-
-  onFileChanged(callback) {
-    this._onFileChanged = callback;
-  }
-
-  addTargetFile(filepath) {
-    if (this._target[filepath] != null) return;
-    this.logger.debug("Add watch target:", filepath);
-    this._target[filepath] = {
-      lastModified: this.getFileLastModified(filepath),
-    };
-  }
-
-  removeTargetFile(filepath) {
-    if (this._target[filepath] == null) return;
-    this.logger.debug("Remove watch target:", filepath);
-    delete this._target[filepath];
-  }
-
-  getFileLastModified(filepath) {
-    return fs.statSync(path.resolve(rootDir, filepath)).mtimeMs;
-  }
-
-  getFileInfo(filepath) {
-    const absolutePath = path.resolve(rootDir, filepath);
-    const markdown = fs.readFileSync(absolutePath, "utf-8");
-    return { filepath, markdown };
-  }
+    constructor(logger) {
+        this.logger = logger;
+        this._target = {};
+        setInterval(() => {
+            Object.keys(this._target).forEach((filepath) => {
+                try {
+                    const fileinfo = this._target[filepath];
+                    const currentLastModified = this.getFileLastModified(filepath);
+                    if (fileinfo.lastModified !== currentLastModified) {
+                        this.logger.info("File update:", path_1.default.resolve(directory_1.rootDir, filepath));
+                        fileinfo.lastModified = currentLastModified;
+                        if (this._onFileChanged != null) {
+                            this._onFileChanged(this.getFileInfo(filepath));
+                        }
+                    }
+                }
+                catch (err) {
+                    console.error(err);
+                }
+            });
+        }, 250 /* check 4 times per second */);
+    }
+    onFileChanged(callback) {
+        this._onFileChanged = callback;
+    }
+    addTargetFile(filepath) {
+        if (this._target[filepath] != null)
+            return;
+        this.logger.debug("Add watch target:", filepath);
+        this._target[filepath] = {
+            lastModified: this.getFileLastModified(filepath),
+        };
+    }
+    removeTargetFile(filepath) {
+        if (this._target[filepath] == null)
+            return;
+        this.logger.debug("Remove watch target:", filepath);
+        delete this._target[filepath];
+    }
+    getFileLastModified(filepath) {
+        return fs_1.default.statSync(path_1.default.resolve(directory_1.rootDir, filepath)).mtimeMs;
+    }
+    getFileInfo(filepath) {
+        const absolutePath = path_1.default.resolve(directory_1.rootDir, filepath);
+        const markdown = fs_1.default.readFileSync(absolutePath, "utf-8");
+        return { filepath, markdown };
+    }
 }
-
-module.exports = FileWatcher;
+exports.FileWatcher = FileWatcher;

package/src/lib/logger.js

@@ -1,23 +1,42 @@
-const log4js = require("log4js");
-
-const getLogger = (logLevel) => {
-  log4js.configure({
-    appenders: {
-      console: {
-        type: "console",
-        layout: {
-          type: "basic",
-        },
-      },
-    },
-    categories: {
-      default: {
-        appenders: ["console"],
-        level: logLevel,
-      },
-    },
-  });
-  return log4js.getLogger();
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-
-module.exports = getLogger;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLogger = exports.getLogLevel = void 0;
+const log4js_1 = __importDefault(require("log4js"));
+const LogLevels = ["trace", "debug", "info", "warn", "error", "fatal"];
+function getLogLevel(level) {
+    switch (level) {
+        case "trace":
+        case "debug":
+        case "info":
+        case "warn":
+        case "error":
+        case "fatal":
+            return level;
+        default:
+            throw new Error(`Undefined log level: ${level}`);
+    }
+}
+exports.getLogLevel = getLogLevel;
+function getLogger(logLevel) {
+    log4js_1.default.configure({
+        appenders: {
+            console: {
+                type: "console",
+                layout: {
+                    type: "basic",
+                },
+            },
+        },
+        categories: {
+            default: {
+                appenders: ["console"],
+                level: logLevel,
+            },
+        },
+    });
+    return log4js_1.default.getLogger();
+}
+exports.getLogger = getLogger;