3.0.2

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -36,6 +39,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
@@ -96,10 +100,9 @@ codequality:
   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
@@ -120,7 +123,7 @@ pages:
   stage: metadata
   script:
     - npmci node install lts
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci command npm install -g @git.zone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc

.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.

npmextra.json

@@ -7,10 +7,10 @@
     "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
-      "gitscope": "pushrocks",
+      "gitscope": "push.rocks",
       "gitrepo": "smartmarkdown",
-      "shortDescription": "do more with markdown files",
-      "npmPackagename": "@pushrocks/smartmarkdown",
+      "description": "do more with markdown files",
+      "npmPackagename": "@push.rocks/smartmarkdown",
       "license": "MIT"
     }
   }

package.json

@@ -1,31 +1,35 @@
 {
-  "name": "@pushrocks/smartmarkdown",
-  "version": "2.0.6",
+  "name": "@push.rocks/smartmarkdown",
+  "version": "3.0.2",
   "private": false,
   "description": "do more with markdown files",
   "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.25",
-    "@gitzone/tsrun": "^1.2.12",
-    "@gitzone/tstest": "^1.0.52",
-    "@pushrocks/tapbundle": "^3.2.14",
-    "@types/node": "^14.14.37",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@git.zone/tsbuild": "^2.1.61",
+    "@git.zone/tsrun": "^1.2.37",
+    "@git.zone/tstest": "^1.0.86",
+    "@push.rocks/tapbundle": "^5.0.3",
+    "@types/node": "^20.11.5"
   },
   "dependencies": {
-    "@types/marked": "^2.0.1",
-    "@types/turndown": "^5.0.0",
-    "marked": "^2.0.3",
-    "turndown": "^7.0.0",
-    "turndown-plugin-gfm": "^1.0.2"
+    "@push.rocks/smartyaml": "^2.0.5",
+    "@types/turndown": "^5.0.1",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.0",
+    "remark-html": "^16.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-stringify": "^11.0.0",
+    "turndown": "^7.1.1",
+    "turndown-plugin-gfm": "^1.0.2",
+    "unified": "^11.0.4"
   },
   "files": [
     "ts/**/*",

readme.md

@@ -1,8 +1,8 @@
-# @pushrocks/smartmarkdown
+# @push.rocks/smartmarkdown
 do more with markdown files
 
 ## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartmarkdown)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartmarkdown)
 * [gitlab.com (source)](https://gitlab.com/pushrocks/smartmarkdown)
 * [github.com (source mirror)](https://github.com/pushrocks/smartmarkdown)
 * [docs (typedoc)](https://pushrocks.gitlab.io/smartmarkdown/)
@@ -13,22 +13,19 @@ 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)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/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)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@push.rocks/smartmarkdown)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartmarkdown)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/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). :)
-
+Use TypeScript for best in class intellisense.
 
 ## Contribution
 

test/test.both.ts

@@ -0,0 +1,37 @@
+import { expect, tap } from '@push.rocks/tapbundle';
+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).toBeInstanceOf(smartmarkdown.SmartMarkdown);
+});
+
+tap.test('should convert a markdown string to html', async () => {
+  const markdownString = '# Hi!';
+  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 () => {
+  const htmlString = '<h1 id="hi">Hi!</h1>\n<h2>This is it!</h2>';
+  const markdownString = smartMarkdownInstance.htmlToMarkdown(htmlString);
+  console.log(markdownString);
+});
+
+tap.start();

test/test.ts

@@ -1,23 +0,0 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartmarkdown from '../ts/index';
-
-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);
-});
-
-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');
-});
-
-tap.test('should convert a html string to markdown', async () => {
-  const htmlString = '<h1 id="hi">Hi!</h1>\n<h2>This is it!</h2>';
-  const markdownString = smartMarkdownInstance.htmlToMarkdown(htmlString);
-  console.log(markdownString);
-});
-
-tap.start();

ts/00_commitinfo_data.ts

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

ts/index.ts

@@ -1,17 +1,25 @@
-import * as plugins from './smartmarkdown.plugins';
+import * as plugins from './smartmarkdown.plugins.js';
+import { MdParsedResult } from './smartmarkdown.classes.mdparsedresult.js';
 
 export class SmartMarkdown {
+  public static async easyMarkdownToHtml(mdStringArg: string) {
+    const smartmarkdownInstance = new SmartMarkdown();
+    const mdParsedResult = await smartmarkdownInstance.getMdParsedResultFromMarkdown(mdStringArg);
+    return mdParsedResult.html;
+  }
+
   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',

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 '@push.rocks/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,14 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true
+  },
+  "exclude": [
+    "dist_*/**/*.d.ts"
+  ]
+}

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"
-}