some fixes as description

.gitignore

@@ -5,4 +5,5 @@ tmp/
 .idea/
 coverage
 dist
-package-lock.json
+package-lock.json
+.vscode

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

lib/front_matter.ts

@@ -32,20 +32,31 @@ function split(str: string) {
  return { content: str };
 }
 
-function parse(str: string, options?: yaml.LoadOptions) {
+export type ParseResult = Record<string, any> &
+ Partial<{
+ _content: string;
+ title: string;
+ description: string;
+ thumbnail: string;
+ date: any;
+ updated: any;
+ permalink: string;
+ }>;
+
+function parse(str: string, options: yaml.LoadOptions = {}) {
  if (typeof str !== 'string') throw new TypeError('str is required!');
 
  const splitData = split(str);
  const raw = splitData.data;
 
  if (!raw) return { _content: str };
 
- let data;
+ let data: ParseResult;
 
  if (splitData.separator.startsWith(';')) {
  data = parseJSON(raw);
  } else {
- data = parseYAML(raw, options);
+ data = parseYAML(raw, options) as any;
  }
 
  if (!data) return { _content: str };
@@ -55,26 +66,28 @@ function parse(str: string, options?: yaml.LoadOptions) {
  const item = data[key];
 
  if (item instanceof Date) {
- data[key] = new Date(item.getTime() + (item.getTimezoneOffset() * 60 * 1000));
+ data[key] = new Date(
+ item.getTime() + (item.getTimezoneOffset() * 60 * 1000)
+ );
  }
  });
 
  data._content = splitData.content;
  return data;
 }
 
-function parseYAML(str, options: yaml.LoadOptions) {
+function parseYAML(str: string, options: yaml.LoadOptions) {
  const result = yaml.load(escapeYAML(str), options);
  if (typeof result !== 'object') return;
 
  return result;
 }
 
-function parseJSON(str) {
+function parseJSON(str: string) {
  try {
  return JSON.parse(`{${str}}`);
  } catch (err) {
- return; // eslint-disable-line
+ return; // eslint-disable-line
  }
 }
 
@@ -93,12 +106,12 @@ function escapeYAML(str: string) {
 }
 
 interface Options {
- mode?: 'json' | '',
- prefixSeparator?: boolean,
- separator?: string
+ mode?: 'json' | '';
+ prefixSeparator?: boolean;
+ separator?: string;
 }
 
-function stringify(obj, options: Options = {}) {
+function stringify(obj: Record<string, any>, options: Options = {}): string {
  if (!obj) throw new TypeError('obj is required!');
 
  const { _content: content = '' } = obj;
@@ -123,12 +136,14 @@ function stringify(obj, options: Options = {}) {
  return result;
 }
 
-function stringifyYAML(obj, options) {
+type YamlMergedOpts = Options & yaml.DumpOptions;
+
+function stringifyYAML(obj: Record<string, any>, options: YamlMergedOpts) {
  const keys = Object.keys(obj);
  const data = {};
  const nullKeys = [];
  const dateKeys = [];
- let key, value, i, len;
+ let key: string, value: any, i: number, len: number;
 
  for (i = 0, len = keys.length; i < len; i++) {
  key = keys[i];
@@ -162,24 +177,25 @@ function stringifyYAML(obj, options) {
 }
 
 function stringifyJSON(obj) {
- return JSON.stringify(obj, null, ' ')
+ return (
+ JSON.stringify(obj, null, ' ')
  // Remove indention
- .replace(/\n {2}/g, () => '\n')
+  .replace(/\n {2}/g, () => '\n')
  // Remove prefixing and trailing braces
- .replace(/^{\n|}$/g, '');
+ .replace(/^{\n|}$/g, '')
+ );
 }
 
-function doubleDigit(num) {
+function doubleDigit(num: number) {
  return num.toString().padStart(2, '0');
 }
 
-function formatDate(date) {
- return `${date.getFullYear()}-${doubleDigit(date.getMonth() + 1)}-${doubleDigit(date.getDate())} ${doubleDigit(date.getHours())}:${doubleDigit(date.getMinutes())}:${doubleDigit(date.getSeconds())}`;
+function formatDate(date: Date) {
+ return `${date.getFullYear()}-${doubleDigit(
+ date.getMonth() + 1
+ )}-${doubleDigit(date.getDate())} ${doubleDigit(
+ date.getHours()
+ )}:${doubleDigit(date.getMinutes())}:${doubleDigit(date.getSeconds())}`;
 }
 
-export {
- parse,
- split,
- escapeYAML as escape,
- stringify
-};
+export { parse, split, escapeYAML as escape, stringify };

lint-staged.config.js

@@ -0,0 +1,11 @@
+/**
+ * @type {{ [key: string]: import("lint-staged").Commands | import("lint-staged").ConfigFn }}
+ */
+const config = {
+ '*.ts': 'eslint --fix',
+ '*.js': 'eslint --fix',
+ '*.json': 'npx prettier --write',
+ '*.yml': 'npx prettier --write'
+};
+
+module.exports = config;

package.json

@@ -2,20 +2,21 @@
  "name": "hexo-front-matter",
  "version": "4.1.0",
  "description": "Front-matter parser.",
- "main": "dist/front_matter",
+ "main": "dist/front_matter.js",
+ "types": "./dist/front_matter.d.ts",
  "scripts": {
  "prepublish ": "npm run clean && npm run build",
  "build": "tsc -b",
  "clean": "tsc -b --clean",
  "eslint": "eslint .",
  "pretest": "npm run clean && npm run build",
  "test": "mocha test/index.js --require ts-node/register",
- "test-cov": "c8 --reporter=lcovonly npm run test"
+ "test-cov": "c8 --reporter=lcovonly npm run test",
+ "prepare": "husky install"
  },
  "files": [
- "dist/**"
+ "dist"
  ],
- "types": "./dist/front_matter.d.ts",
  "repository": "hexojs/hexo-front-matter",
  "keywords": [
  "front-matter",
@@ -32,13 +33,15 @@
  },
  "devDependencies": {
  "@types/js-yaml": "^4.0.5",
- "@types/node": "^18.11.7",
+ "@types/node": "^18.16.3",
  "@typescript-eslint/eslint-plugin": "^5.41.0",
  "@typescript-eslint/parser": "^5.41.0",
  "c8": "^7.12.0",
  "chai": "^4.3.6",
  "eslint": "^8.23.1",
  "eslint-config-hexo": "^5.0.0",
+ "husky": "^8.0.3",
+ "lint-staged": "^13.2.2",
  "mocha": "^10.0.0",
  "ts-node": "^10.9.1",
  "typescript": "^4.8.4"

tsconfig.json

@@ -1,19 +1,14 @@
 {
- "compilerOptions": {
- "module": "commonjs",
- "target": "es6",
- "sourceMap": true,
- "outDir": "dist",
- "declaration": true,
- "esModuleInterop": true,
- "types": [
- "node"
- ]
- },
- "include": [
- "lib/front_matter.ts"
- ],
- "exclude": [
- "node_modules"
- ]
-}
+ "compilerOptions": {
+ "module": "CommonJS",
+ "target": "ES6",
+ "sourceMap": true,
+ "outDir": "dist",
+ "declaration": true,
+ "esModuleInterop": true,
+ "skipDefaultLibCheck": true,
+ "skipLibCheck": true
+ },
+ "include": ["lib/front_matter.ts"],
+ "exclude": ["node_modules", "dist"]
+}