2.0.5

.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,16 +1,16 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
-  - .npmci_cache/
+    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- security
+  - security
-- test
+  - test
-- release
+  - release
-- metadata
+  - metadata
 
 # ====================
 # security stage
@@ -18,102 +18,103 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # test stage
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
-    
+    - priv
-testSTABLE:
+
+testBuild:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 release:
   stage: release
   script:
-  - npmci node install stable
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
 # ====================
 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 prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --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
+    - lossless
-  - priv
+    - docker
+    - priv
 
 trigger:
   stage: metadata
   script:
-  - npmci trigger
+    - npmci trigger
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
-    - npmci command npm install -g typedoc typescript
+    - npmci node install lts
+    - 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:
+    - lossless
     - docker
     - notpriv
   only:
@@ -121,5 +122,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   allow_failure: true

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartmarkdown",
-  "version": "1.0.6",
+  "version": "2.0.5",
   "private": false,
   "description": "do more with markdown files",
   "main": "dist/index.js",
@@ -9,17 +9,33 @@
   "license": "MIT",
   "scripts": {
     "test": "tstest test/",
-    "build": "tsbuild"
+    "build": "tsbuild --web"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.20",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^12.0.0"
+    "@types/node": "^13.1.8",
+    "tslint": "^5.20.1",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@types/marked": "^0.6.5",
+    "@types/marked": "^0.7.2",
-    "marked": "^0.6.2"
+    "@types/turndown": "^5.0.0",
-  }
+    "marked": "^0.8.0",
+    "turndown": "^5.0.3",
+    "turndown-plugin-gfm": "^1.0.2"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -18,9 +18,14 @@ do more with markdown files
 
 ## 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). :)
+
 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)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.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,22 @@
 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'
+    });
+    turndownInstance.use(plugins.turndownPluginGfm.gfm);
+    return turndownInstance.turndown(htmlString);
+  }
+}

ts/smartmarkdown.plugins.ts

@@ -1,3 +1,5 @@
 import marked = require('marked');
+import turndown from 'turndown';
+import * as turndownPluginGfm from 'turndown-plugin-gfm';
 
-export { marked };
+export { marked, turndown, turndownPluginGfm };