2.0.0

.gitignore

@@ -1,6 +1,22 @@
 .nogit/
-node_modules/
+
+# artifacts
 coverage/
 public/
 pages/
+
+# installs
+node_modules/
+
+# caches
 .yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_web/
+dist_serve/
+dist_ts_web/
+
+# custom

.gitlab-ci.yml

@@ -1,4 +1,4 @@
-# gitzone standard
+# gitzone ci_default
 image: hosttoday/ht-docker-node:npmci
 
 cache:
@@ -37,18 +37,6 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true
 
 testLTS:
   stage: test
@@ -90,19 +78,11 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm install
-        --env SOURCE_CODE="$PWD"
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
   - docker
   - priv
@@ -121,10 +101,10 @@ pages:
   image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
+    - npmci command tsdoc
   tags:
     - docker
     - notpriv
@@ -135,13 +115,3 @@ pages:
     paths:
     - public
   allow_failure: true
-
-windowsCompatibility:
-  image: stefanscherer/node-windows:10-build-tools
-  stage: metadata
-  script:
-  - npm install & npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - windows
-  allow_failure: true

npmextra.json

@@ -2,5 +2,15 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartmarkdown",
+      "shortDescription": "do more with markdown files",
+      "npmPackagename": "@pushrocks/smartmarkdown",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pushrocks/smartmarkdown",
-  "version": "1.0.3",
+  "version": "2.0.0",
-  "private": true,
+  "private": false,
   "description": "do more with markdown files",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -9,18 +9,31 @@
   "license": "MIT",
   "scripts": {
     "test": "tstest test/",
-    "format": "(gitzone format)",
     "build": "tsbuild"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tsrun": "^1.2.6",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^10.10.3"
+    "@types/node": "^12.0.8",
+    "tslint": "^5.17.0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/marked": "^0.4.1",
+    "@types/marked": "^0.6.5",
-    "marked": "^0.5.0"
+    "@types/turndown": "^5.0.0",
-  }
+    "marked": "^0.6.2",
+    "turndown": "^5.0.3"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,26 @@
+# @pushrocks/smartmarkdown
+do more with markdown files
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/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/)
+
+## 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/)
+
+## Usage
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -1,9 +1,23 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartmarkdown from '../ts/index';
 
-tap.test('first test', async () => {
+let smartMarkdownInstance: smartmarkdown.SmartMarkdown;
-  const mdString = smartmarkdown.markdownToHtml('# Hi!');
+
-  expect(mdString).to.equal('<h1 id="hi-">Hi!</h1>\n');
+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/index.ts

@@ -1,3 +1,21 @@
 import * as plugins from './smartmarkdown.plugins';
 
-export const markdownToHtml = (mdString: string): string => plugins.marked(mdString);
+export class SmartMarkdown {
+  constructor() {}
+
+  /**
+   * converts markdown to html
+   * @param mdString
+   */
+  public markdownToHtml(mdString: string): string {
+    return plugins.marked(mdString);
+  }
+
+  public htmlToMarkdown(htmlString): string {
+    const turndownInstance = new plugins.turndown({
+      headingStyle: 'atx',
+      codeBlockStyle: 'fenced'
+    });
+    return turndownInstance.turndown(htmlString);
+  }
+}

ts/smartmarkdown.plugins.ts

@@ -1,3 +1,4 @@
 import marked = require('marked');
+import turndown from 'turndown';
 
-export { marked };
+export { marked, turndown };

tslint.json

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