2.0.14

.gitignore

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

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,22 +22,36 @@ 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
+  allow_failure: true
+
+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 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -62,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -84,11 +97,12 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
     - npmci npm prepare
     - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   tags:
     - lossless
     - docker

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

dependencies.yml

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

license

@@ -1,6 +1,4 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Push.Rocks
+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
@@ -18,4 +16,4 @@ 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.
+SOFTWARE.

npmextra.json

@@ -4,11 +4,12 @@
     "npmAccessLevel": "public"
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartmarkdown",
-      "shortDescription": "do more with markdown files",
+      "description": "do more with markdown files",
       "npmPackagename": "@pushrocks/smartmarkdown",
       "license": "MIT"
     }

package.json

@@ -1,41 +1,51 @@
 {
   "name": "@pushrocks/smartmarkdown",
-  "version": "2.0.5",
+  "version": "2.0.14",
   "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",
+  "type": "module",
   "author": "Lossless GmbH",
   "license": "MIT",
   "scripts": {
     "test": "tstest test/",
-    "build": "tsbuild --web"
+    "build": "tsbuild --web --allowimplicitany --skiplibcheck"
   },
   "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.61",
+    "@gitzone/tsrun": "^1.2.32",
+    "@gitzone/tstest": "^1.0.71",
+    "@pushrocks/tapbundle": "^5.0.3",
+    "@types/node": "^17.0.34",
+    "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",
-    "turndown-plugin-gfm": "^1.0.2"
+    "@pushrocks/smartyaml": "^2.0.5",
+    "@types/turndown": "^5.0.1",
+    "remark-frontmatter": "^4.0.1",
+    "remark-gfm": "^3.0.1",
+    "remark-html": "^15.0.1",
+    "remark-parse": "^10.0.1",
+    "remark-stringify": "^10.0.2",
+    "turndown": "^7.1.1",
+    "turndown-plugin-gfm": "^1.0.2",
+    "unified": "^10.1.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,24 @@ 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
 
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 

test/test.both.ts

@@ -1,17 +1,31 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartmarkdown from '../ts/index';
+import * as smartmarkdown from '../ts/index.js';
 
 let smartMarkdownInstance: smartmarkdown.SmartMarkdown;
 
 tap.test('should create a valid instance of SmartMarkdown', async () => {
   smartMarkdownInstance = new smartmarkdown.SmartMarkdown();
-  expect(smartMarkdownInstance).to.be.instanceOf(smartmarkdown.SmartMarkdown);
+  expect(smartMarkdownInstance).toBeInstanceOf(smartmarkdown.SmartMarkdown);
 });
 
 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 mdParsedResult = await smartMarkdownInstance.getMdParsedResultFromMarkdown(markdownString);
+  const htmlString = mdParsedResult.html;
+  expect(htmlString).toEqual('<h1>Hi!</h1>\n');
+});
+
+tap.test('should get frontmatter', async () => {
+  const markdownString = `---
+hello: yes
+---
+
+# hello there
+`;
+  const mdParsedResult = await smartMarkdownInstance.getMdParsedResultFromMarkdown(markdownString);
+  
+  expect(mdParsedResult.frontmatterData.hello).toEqual('yes');
+  
 });
 
 tap.test('should convert a html string to markdown', async () => {

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartmarkdown',
+  version: '2.0.14',
+  description: 'do more with markdown files'
+}

ts/index.ts

@@ -1,20 +1,22 @@
-import * as plugins from './smartmarkdown.plugins';
+import * as plugins from './smartmarkdown.plugins.js';
+import { MdParsedResult } from './smartmarkdown.classes.mdparsedresult.js';
 
 export class SmartMarkdown {
   constructor() {}
 
   /**
-   * converts markdown to html
-   * @param mdString
+   * create a MdParsedResult from markdown
+   * @param mdStringArg
    */
-  public markdownToHtml(mdString: string): string {
-    return plugins.marked(mdString);
-  }
+  public async getMdParsedResultFromMarkdown(mdStringArg: string): Promise<MdParsedResult> {
+    const result = await MdParsedResult.createFromMarkdownString(mdStringArg);
+    return result;
+  };
 
-  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.classes.mdparsedresult.ts

@@ -0,0 +1,38 @@
+import * as plugins from './smartmarkdown.plugins.js';
+
+export class MdParsedResult {
+  public static async createFromMarkdownString(mdStringArg: string): Promise<MdParsedResult> {
+    const mdParsedResult = new MdParsedResult();
+    await mdParsedResult.updateFromMarkdownString(mdStringArg);
+    return mdParsedResult;
+  }
+
+  public originalString: string;
+  public title: string;
+  public html: string;
+  public frontmatterData: {[key: string]: any};
+
+  public async updateFromMarkdownString(mdStringArg: string) {
+    let yamlString: string;
+    const result = await plugins.unified()
+      .use(plugins.remarkParse)
+      .use(plugins.remarkGfm)
+      .use(plugins.remarkFrontmatter, ['yaml', 'toml'])
+      .use(plugins.remarkStringify)
+      .use(plugins.remarkHtml)
+      .use(() => (tree) => {
+        console.dir(tree);
+        const yamlChild = tree.children.find(objectArg => objectArg.type === 'yaml');
+        if (yamlChild) {
+          yamlString = (yamlChild as any).value;
+        }
+      })
+      .process(mdStringArg);
+    this.html = result.toString();
+    if (yamlString) {
+      this.frontmatterData = await plugins.smartyaml.yamlStringToObject(yamlString);
+    } else {
+      this.frontmatterData = {};
+    }
+  }
+}

ts/smartmarkdown.plugins.ts

@@ -1,5 +1,23 @@
-import marked = require('marked');
+// pushrocks scope
+import * as smartyaml from '@pushrocks/smartyaml';
+
+export {
+  smartyaml
+}
+
+// third party remark
+import { unified } from 'unified';
+import remarkGfm from 'remark-gfm';
+import remarkParse from 'remark-parse';
+import remarkFrontmatter from 'remark-frontmatter';
+import remarkHtml from 'remark-html';
+import remarkStringify from 'remark-stringify';
+
+export { unified, remarkGfm, remarkParse, remarkFrontmatter, remarkHtml, remarkStringify };
+
+// other third party stuff
 import turndown from 'turndown';
+// @ts-ignore
 import * as turndownPluginGfm from 'turndown-plugin-gfm';
 
-export { marked, turndown, turndownPluginGfm };
+export { turndown, turndownPluginGfm };

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext"
+  }
+}

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}