2.0.7

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/
 
 # custom

.gitlab-ci.yml

@@ -19,22 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-snyk:
-  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -49,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "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"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -4,6 +4,7 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,10 +1,10 @@
 {
   "name": "@pushrocks/smartmarkdown",
-  "version": "2.0.5",
+  "version": "2.0.7",
   "private": false,
   "description": "do more with markdown files",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
@@ -12,30 +12,34 @@
     "build": "tsbuild --web"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^13.1.8",
-    "tslint": "^5.20.1",
+    "@gitzone/tsbuild": "^2.1.27",
+    "@gitzone/tsrun": "^1.2.17",
+    "@gitzone/tstest": "^1.0.57",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^16.10.2",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/marked": "^0.7.2",
-    "@types/turndown": "^5.0.0",
-    "marked": "^0.8.0",
-    "turndown": "^5.0.3",
+    "@types/turndown": "^5.0.1",
+    "remark": "^13.0.0",
+    "remark-html": "^13.0.0",
+    "turndown": "^7.1.1",
     "turndown-plugin-gfm": "^1.0.2"
   },
   "files": [
     "ts/**/*",
     "ts_web/**/*",
     "dist/**/*",
-    "dist_web/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
     "dist_ts_web/**/*",
     "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -8,16 +8,27 @@ do more with markdown files
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartmarkdown/)
 
 ## Status for master
-[![build status](https://gitlab.com/pushrocks/smartmarkdown/badges/master/build.svg)](https://gitlab.com/pushrocks/smartmarkdown/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartmarkdown/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartmarkdown/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartmarkdown.svg)](https://www.npmjs.com/package/@pushrocks/smartmarkdown)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartmarkdown/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartmarkdown)
-[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartmarkdown/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartmarkdown/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartmarkdown)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartmarkdown)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartmarkdown)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartmarkdown)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartmarkdown)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## 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). :)
+
 
 ## 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,14 +7,15 @@ 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).process(mdString);
+    return result.toString();
   }
 
-  public htmlToMarkdown(htmlString): string {
+  public htmlToMarkdown(htmlString: string): string {
     const turndownInstance = new plugins.turndown({
       headingStyle: 'atx',
-      codeBlockStyle: 'fenced'
+      codeBlockStyle: 'fenced',
     });
     turndownInstance.use(plugins.turndownPluginGfm.gfm);
     return turndownInstance.turndown(htmlString);

ts/smartmarkdown.plugins.ts

@@ -1,5 +1,16 @@
-import marked = require('marked');
+
+// third party remark
+import remark from 'remark';
+import remarkHtml from 'remark-html';
+
+export {
+  remark,
+  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 };