1.0.6

.gitlab-ci.yml

@@ -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
@@ -135,13 +123,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

@@ -1,8 +1,16 @@
 {
   "npmci": {
-    "npmGlobalTools": [
+    "npmGlobalTools": [],
-      "@gitzone/npmts",
+    "npmAccessLevel": "public"
-      "ts-node"
+  },
-    ]
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartmarkdown",
+      "shortDescription": "do more with markdown files",
+      "npmPackagename": "@pushrocks/smartmarkdown",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,6 +1,7 @@
 {
   "name": "@pushrocks/smartmarkdown",
-  "version": "1.0.2",
+  "version": "1.0.6",
+  "private": false,
   "description": "do more with markdown files",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -8,16 +9,17 @@
   "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.20",
-    "@pushrocks/tapbundle": "^3.0.7",
+    "@pushrocks/tapbundle": "^3.0.9",
-    "@types/node": "^10.10.3"
+    "@types/node": "^12.0.0"
   },
-  "dependencies": {},
+  "dependencies": {
-  "private": true
+    "@types/marked": "^0.6.5",
+    "marked": "^0.6.2"
+  }
 }

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

@@ -2,7 +2,8 @@ import { expect, tap } from '@pushrocks/tapbundle';
 import * as smartmarkdown from '../ts/index';
 
 tap.test('first test', async () => {
-  console.log(smartmarkdown.standardExport);
+  const mdString = smartmarkdown.markdownToHtml('# Hi!');
+  expect(mdString).to.equal('<h1 id="hi">Hi!</h1>\n');
 });
 
 tap.start();

ts/index.ts

@@ -1,3 +1,3 @@
 import * as plugins from './smartmarkdown.plugins';
 
-export let standardExport = 'Hi there! :) This is an exported string';
+export const markdownToHtml = (mdString: string): string => plugins.marked(mdString);

ts/smartmarkdown.plugins.ts

@@ -1,2 +1,3 @@
-const removeme = {};
+import marked = require('marked');
-export { removeme };
+
+export { marked };

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