2.0.11

.gitlab-ci.yml

@@ -36,6 +36,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "request": "launch",
-      "args": [
-        "${relativeFile}"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
-    },
-    {
-      "name": "test.ts",
-      "type": "node",
-      "request": "launch",
-      "args": [
-        "test/test.ts"
-      ],
-      "runtimeArgs": ["-r", "@gitzone/tsrun"],
-      "cwd": "${workspaceRoot}",
-      "protocol": "inspector",
-      "internalConsoleOptions": "openOnSessionStart"
+      "type": "node-terminal"
     }
   ]
 }

dependencies.yml

@@ -1,3 +0,0 @@
-merge:
-  - ../gitignore
-  - ../ci_default

license

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Lossless GmbH (hello@lossless.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartmarkdown",
-  "version": "2.0.6",
+  "version": "2.0.11",
   "private": false,
   "description": "do more with markdown files",
   "main": "dist_ts/index.js",
@@ -12,19 +12,20 @@
     "build": "tsbuild --web"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.52",
+    "@gitzone/tsbuild": "^2.1.27",
+    "@gitzone/tsrun": "^1.2.17",
+    "@gitzone/tstest": "^1.0.57",
     "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^14.14.37",
+    "@types/node": "^16.10.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/marked": "^2.0.1",
-    "@types/turndown": "^5.0.0",
-    "marked": "^2.0.3",
-    "turndown": "^7.0.0",
+    "@types/turndown": "^5.0.1",
+    "remark": "^13.0.0",
+    "remark-frontmatter": "^3.0.0",
+    "remark-html": "^13.0.0",
+    "turndown": "^7.1.1",
     "turndown-plugin-gfm": "^1.0.2"
   },
   "files": [

readme.md

@@ -25,10 +25,7 @@ Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20W
 
 ## Usage
 
-## Contribution
-
-We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
-
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 

test/test.ts

@@ -10,8 +10,8 @@ tap.test('should create a valid instance of SmartMarkdown', async () => {
 
 tap.test('should convert a markdown string to html', async () => {
   const markdownString = '# Hi!';
-  const htmlString = smartMarkdownInstance.markdownToHtml(markdownString);
-  expect(htmlString).to.equal('<h1 id="hi">Hi!</h1>\n');
+  const htmlString = await smartMarkdownInstance.markdownToHtml(markdownString);
+  expect(htmlString).to.equal('<h1>Hi!</h1>\n');
 });
 
 tap.test('should convert a html string to markdown', async () => {

ts/index.ts

@@ -7,11 +7,16 @@ export class SmartMarkdown {
    * converts markdown to html
    * @param mdString
    */
-  public markdownToHtml(mdString: string): string {
-    return plugins.marked(mdString);
+  public async markdownToHtml(mdString: string): Promise<string> {
+    const result = await plugins
+      .remark()
+      .use(plugins.remarkHtml)
+      .use(plugins.remarkFrontmatter, ['yaml', 'toml'])
+      .process(mdString);
+    return result.toString();
   }
 
-  public htmlToMarkdown(htmlString): string {
+  public htmlToMarkdown(htmlString: string): string {
     const turndownInstance = new plugins.turndown({
       headingStyle: 'atx',
       codeBlockStyle: 'fenced',

ts/smartmarkdown.plugins.ts

@@ -1,5 +1,13 @@
-import marked = require('marked');
+// third party remark
+import remark from 'remark';
+import remarkFrontmatter from 'remark-frontmatter';
+import remarkHtml from 'remark-html';
+
+export { remark, remarkFrontmatter, remarkHtml };
+
+// other third party stuff
 import turndown from 'turndown';
+// @ts-ignore
 import * as turndownPluginGfm from 'turndown-plugin-gfm';
 
-export { marked, turndown, turndownPluginGfm };
+export { turndown, turndownPluginGfm };