3.0.3

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -97,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
@@ -121,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

dependencies.yml

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

license

@@ -1,6 +1,4 @@
-The MIT License (MIT)
+Copyright (c) 2014 Lossless GmbH (hello@lossless.com)
-
-Copyright (c) 2016 Push.Rocks
 
 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

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

package.json

@@ -1,31 +1,35 @@
 {
-  "name": "@pushrocks/smartmarkdown",
+  "name": "@push.rocks/smartmarkdown",
-  "version": "2.0.8",
+  "version": "3.0.3",
   "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"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.27",
+    "@git.zone/tsbuild": "^2.1.61",
-    "@gitzone/tsrun": "^1.2.17",
+    "@git.zone/tsrun": "^1.2.37",
-    "@gitzone/tstest": "^1.0.57",
+    "@git.zone/tstest": "^1.0.86",
-    "@pushrocks/tapbundle": "^3.2.14",
+    "@push.rocks/tapbundle": "^5.0.3",
-    "@types/node": "^16.10.2",
+    "@types/node": "^20.11.5"
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
+    "@push.rocks/smartyaml": "^2.0.5",
     "@types/turndown": "^5.0.1",
-    "remark": "^13.0.0",
+    "remark-frontmatter": "^5.0.0",
-    "remark-html": "^13.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"
+    "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,14 +13,14 @@ 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 (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/@pushrocks/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/@pushrocks/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

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 = await smartMarkdownInstance.markdownToHtml(markdownString);
-  expect(htmlString).to.equal('<h1>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.3',
+  description: 'do more with markdown files'
+}

ts/index.ts

@@ -1,15 +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 {
+  public static async easyMarkdownToHtml(mdStringArg: string) {
+    const smartmarkdownInstance = new SmartMarkdown();
+    const mdParsedResult = await smartmarkdownInstance.getMdParsedResultFromMarkdown(mdStringArg);
+    return mdParsedResult.html;
+  }
+
   constructor() {}
 
   /**
-   * converts markdown to html
+   * create a MdParsedResult from markdown
-   * @param mdString
+   * @param mdStringArg
    */
-  public async markdownToHtml(mdString: string): Promise<string> {
+  public async getMdParsedResultFromMarkdown(mdStringArg: string): Promise<MdParsedResult> {
-    const result = await plugins.remark().use(plugins.remarkHtml).process(mdString);
+    const result = await MdParsedResult.createFromMarkdownString(mdStringArg);
-    return result.toString();
+    return result;
   }
 
   public htmlToMarkdown(htmlString: string): string {

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,8 +1,19 @@
-// third party remark
+// pushrocks scope
-import remark from 'remark';
+import * as smartyaml from '@push.rocks/smartyaml';
-import remarkHtml from 'remark-html';
 
-export { remark, remarkHtml };
+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';

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