2.0.3

.gitignore

@@ -1,4 +1,22 @@
-node_modules/
+.nogit/
+
+# 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,59 +1,119 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+  - .npmci_cache/
+  key: "$CI_BUILD_STAGE"
 
 stages:
+- security
 - test
 - release
-- trigger
+- metadata
-- pages
 
-testLEGACY:
+# ====================
-  stage: test
+# security stage
+# ====================
+mirror:
+  stage: security
   script:
-    - npmci test legacy
+  - npmci git mirror
   tags:
-    - docker
+  - docker
-  allow_failure: true
+  - notpriv
 
-testLTS:
+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
+  - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test lts
+  - npmci npm prepare
+  - npmci node install stable
+  - npmci npm install
+  - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
-    
+  - priv
-testSTABLE:
+
+testBuild:
   stage: test
   script:
-    - npmci test stable
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - docker
+  - docker
+  - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+  - npmci node install lts
+  - npmci npm publish
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+  - docker
+  - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
-    - npmci trigger
+  - npmci trigger
   only:
-    - tags
+  - tags
   tags:
-    - docker
+  - docker
+  - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  image: hosttoday/ht-docker-dbase:npmci
-  stage: pages
+  services:
+   - docker:stable-dind
+  stage: metadata
   script:
-    - npmci command npmpage --host gitlab
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
     - public
+  allow_failure: true

.snyk

@@ -0,0 +1,13 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.13.5
+# ignores vulnerabilities until expiry date; change duration by modifying expiry date
+ignore:
+  SNYK-JS-JSYAML-173999:
+    - gray-matter > js-yaml:
+        reason: None given
+        expires: '2019-10-04T12:19:33.385Z'
+  SNYK-JS-JSYAML-174129:
+    - gray-matter > js-yaml:
+        reason: None given
+        expires: '2019-10-04T12:19:33.385Z'
+patch: {}

README.md

@@ -1,36 +1,26 @@
-# smartfm
+# @pushrocks/smartfm
-smartfm handles frontmatter of files
+frontmatter done right
 
-## Availabililty
+> Please consider following us on https://beta.news/lossless to subscribe to infos on changes and updates.
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfm)
+
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartfm)
+## Availabililty and Links
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfm)
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfm)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfm/)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfm)
+* [github.com (source mirror)](https://github.com/pushrocks/smartfm)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartfm/)
 
 ## Status for master
 [![build status](https://gitlab.com/pushrocks/smartfm/badges/master/build.svg)](https://gitlab.com/pushrocks/smartfm/commits/master)
 [![coverage report](https://gitlab.com/pushrocks/smartfm/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartfm/commits/master)
-[![Dependency Status](https://david-dm.org/pushrocks/smartfm.svg)](https://david-dm.org/pushrocks/smartfm)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartfm.svg)](https://www.npmjs.com/package/@pushrocks/smartfm)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfm/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfm/master/dependencies/npm)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartfm/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartfm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartfm/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfm)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
 
 ## Usage
 
-say you have the following markdown file:
+We recommend TypeScript for best in class Intellisense.
-```markdown
----
-title: A really awesome article
-date: 23-10-2020
-type: feature
----
-# A Awesome Title
-The world is cool. And here is why
-* reason 1
-* reason 2
-```
 
 ```javascript
 import * as smartfm from * smartfm
@@ -65,4 +55,9 @@ let mySmartfm = new smartfm.Smartfm({
 })
 ```
 
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
+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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

dist/index.d.ts

@@ -1,33 +0,0 @@
-import 'typings-global';
-export declare type TFrontMatter = 'yaml' | 'json';
-export interface IParsedFM {
-    data: any;
-    content: string;
-    orig: string;
-}
-export interface ISmartfmContructorOptions {
-    fmType: TFrontMatter;
-}
-/**
- * class smartfm handles frontmatter
- */
-export declare class Smartfm {
-    fmType: TFrontMatter;
-    constructor(optionsArg: ISmartfmContructorOptions);
-    /**
-     * add frontmatter to a string
-     */
-    stringify(bodyString: string, frontmatterData: any): any;
-    /**
-     * parse a string that has frontmatter attached, YAML notation
-     */
-    parse(stringToParse: string): IParsedFM;
-}
-/**
- * parse a string that has frontmatter attached, YAML notation
- */
-export declare let parse: (stringToParse: string) => IParsedFM;
-/**
- * add frontmatter to a string
- */
-export declare let stringify: (bodyString: string, frontmatterData: any) => any;

dist/index.js

@@ -1,37 +0,0 @@
-"use strict";
-require("typings-global");
-let grayMatter = require('gray-matter');
-/**
- * class smartfm handles frontmatter
- */
-class Smartfm {
-    constructor(optionsArg) {
-        this.fmType = optionsArg.fmType;
-    }
-    /**
-     * add frontmatter to a string
-     */
-    stringify(bodyString, frontmatterData) {
-        return exports.stringify(bodyString, frontmatterData);
-    }
-    /**
-     * parse a string that has frontmatter attached, YAML notation
-     */
-    parse(stringToParse) {
-        return exports.parse(stringToParse);
-    }
-}
-exports.Smartfm = Smartfm;
-/**
- * parse a string that has frontmatter attached, YAML notation
- */
-exports.parse = (stringToParse) => {
-    return grayMatter(stringToParse);
-};
-/**
- * add frontmatter to a string
- */
-exports.stringify = (bodyString, frontmatterData) => {
-    return grayMatter.stringify(bodyString, frontmatterData);
-};
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ3ZCLElBQUksVUFBVSxHQUFHLE9BQU8sQ0FBQyxhQUFhLENBQUMsQ0FBQTtBQWN2Qzs7R0FFRztBQUNIO0lBR0ksWUFBWSxVQUFxQztRQUM3QyxJQUFJLENBQUMsTUFBTSxHQUFHLFVBQVUsQ0FBQyxNQUFNLENBQUE7SUFDbkMsQ0FBQztJQUVEOztPQUVHO0lBQ0gsU0FBUyxDQUFDLFVBQWtCLEVBQUUsZUFBb0I7UUFDOUMsTUFBTSxDQUFDLGlCQUFTLENBQUMsVUFBVSxFQUFFLGVBQWUsQ0FBQyxDQUFBO0lBQ2pELENBQUM7SUFFRDs7T0FFRztJQUNILEtBQUssQ0FBQyxhQUFxQjtRQUN2QixNQUFNLENBQUMsYUFBSyxDQUFDLGFBQWEsQ0FBQyxDQUFBO0lBQy9CLENBQUM7Q0FDSjtBQXBCRCwwQkFvQkM7QUFFRDs7R0FFRztBQUNRLFFBQUEsS0FBSyxHQUFHLENBQUMsYUFBcUI7SUFDckMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxhQUFhLENBQUMsQ0FBQTtBQUNwQyxDQUFDLENBQUE7QUFFRDs7R0FFRztBQUNRLFFBQUEsU0FBUyxHQUFHLENBQUMsVUFBa0IsRUFBRSxlQUFvQjtJQUM1RCxNQUFNLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxVQUFVLEVBQUUsZUFBZSxDQUFDLENBQUE7QUFDNUQsQ0FBQyxDQUFBIn0=

npmextra.json

@@ -0,0 +1,16 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartfm",
+      "shortDescription": "frontmatter done right",
+      "npmPackagename": "@pushrocks/smartfm",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,11 +1,13 @@
 {
-  "name": "smartfm",
+  "name": "@pushrocks/smartfm",
-  "version": "1.0.1",
+  "version": "2.0.3",
+  "private": false,
   "description": "frontmatter done right",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "tsbuild"
   },
   "repository": {
     "type": "git",
@@ -21,12 +23,24 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartfm#README",
   "dependencies": {
-    "gray-matter": "^2.1.0",
+    "gray-matter": "^4.0.2"
-    "typings-global": "^1.0.14"
   },
   "devDependencies": {
-    "@types/should": "^8.1.30",
+    "@gitzone/tsbuild": "^2.1.17",
-    "should": "^11.1.1",
+    "@gitzone/tsrun": "^1.2.8",
-    "typings-test": "^1.0.3"
+    "@gitzone/tstest": "^1.0.24",
-  }
+    "@pushrocks/tapbundle": "^3.0.13",
+    "@types/node": "^12.7.4"
+  },
+  "files": [
+    "ts/*",
+    "ts_web/*",
+    "dist/*",
+    "dist_web/*",
+    "dist_ts_web/*",
+    "assets/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,25 +0,0 @@
-"use strict";
-require("typings-test");
-const should = require("should");
-const smartfm = require("../dist/index");
-describe('smartfm', function () {
-    let testSmartfm = new smartfm.Smartfm({ fmType: 'yaml' });
-    it('.parse()', function () {
-        let testString = `---
-testKey: testValue
-testKey2: testValue2
----
-# some markdown`;
-        let parsedString = testSmartfm.parse(testString);
-        should(parsedString.data).have.property('testKey', 'testValue');
-        should(parsedString.data).have.property('testKey2', 'testValue2');
-        should(parsedString.orig).equal(testString);
-    });
-    it('.stringify', function () {
-        let testStringPure = `# some markdown heading\nsome first row`;
-        let testStringCombined = testSmartfm.stringify(testStringPure, { testData: 'hi' });
-        let resultString = '---\ntestData: hi\n---\n# some markdown heading\nsome first row\n';
-        should(resultString).equal(testStringCombined);
-    });
-});
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQixpQ0FBZ0M7QUFFaEMseUNBQXdDO0FBRXhDLFFBQVEsQ0FBQyxTQUFTLEVBQUU7SUFDaEIsSUFBSSxXQUFXLEdBQUcsSUFBSSxPQUFPLENBQUMsT0FBTyxDQUFDLEVBQUUsTUFBTSxFQUFFLE1BQU0sRUFBRSxDQUFDLENBQUE7SUFDekQsRUFBRSxDQUFDLFVBQVUsRUFBRTtRQUNYLElBQUksVUFBVSxHQUFHOzs7O2dCQUlULENBQUE7UUFDUixJQUFJLFlBQVksR0FBRyxXQUFXLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQ2hELE1BQU0sQ0FBQyxZQUFZLENBQUMsSUFBSSxDQUFDLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxTQUFTLEVBQUUsV0FBVyxDQUFDLENBQUE7UUFDL0QsTUFBTSxDQUFDLFlBQVksQ0FBQyxJQUFJLENBQUMsQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLFVBQVUsRUFBRSxZQUFZLENBQUMsQ0FBQTtRQUNqRSxNQUFNLENBQUMsWUFBWSxDQUFDLElBQUksQ0FBQyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUMvQyxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxZQUFZLEVBQUU7UUFDYixJQUFJLGNBQWMsR0FBRyx5Q0FBeUMsQ0FBQTtRQUM5RCxJQUFJLGtCQUFrQixHQUFHLFdBQVcsQ0FBQyxTQUFTLENBQUMsY0FBYyxFQUFFLEVBQUUsUUFBUSxFQUFFLElBQUksRUFBRSxDQUFDLENBQUE7UUFDbEYsSUFBSSxZQUFZLEdBQUcsbUVBQW1FLENBQUE7UUFDdEYsTUFBTSxDQUFDLFlBQVksQ0FBQyxDQUFDLEtBQUssQ0FBQyxrQkFBa0IsQ0FBQyxDQUFBO0lBQ2xELENBQUMsQ0FBQyxDQUFBO0FBQ04sQ0FBQyxDQUFDLENBQUEifQ==

test/test.ts

@@ -1,25 +1,29 @@
-import 'typings-test'
+import { tap, expect } from '@pushrocks/tapbundle';
-import * as should from 'should'
 
-import * as smartfm from '../dist/index'
+import * as smartfm from '../ts/index';
 
-describe('smartfm', function () {
+let testSmartfm = new smartfm.Smartfm({ fmType: 'yaml' });
-    let testSmartfm = new smartfm.Smartfm({ fmType: 'yaml' })
+tap.test('.parse()', async () => {
-    it('.parse()', function () {
+  let testString = `---
-        let testString = `---
 testKey: testValue
 testKey2: testValue2
 ---
-# some markdown`
+# some markdown
-        let parsedString = testSmartfm.parse(testString)
+`;
-        should(parsedString.data).have.property('testKey', 'testValue')
+  let parsedString = testSmartfm.parse(testString);
-        should(parsedString.data).have.property('testKey2', 'testValue2')
+  expect(parsedString.data).to.have.property('testKey', 'testValue');
-        should(parsedString.orig).equal(testString)
+  expect(parsedString.data).to.have.property('testKey2', 'testValue2');
-    })
+  expect(parsedString.orig.toString()).to.equal(testString);
-    it('.stringify', function () {
+});
-        let testStringPure = `# some markdown heading\nsome first row`
+tap.test('should stringify data', async () => {
-        let testStringCombined = testSmartfm.stringify(testStringPure, { testData: 'hi' })
+  let testStringPure = `# some markdown heading\nsome first row`;
-        let resultString = '---\ntestData: hi\n---\n# some markdown heading\nsome first row\n'
+  let testStringCombined = testSmartfm.stringify(testStringPure, { testData: 'hi' });
-        should(resultString).equal(testStringCombined)
+  let resultString = '---\ntestData: hi\n---\n# some markdown heading\nsome first row\n';
-    })
+  expect(resultString).to.equal(testStringCombined);
-})
+});
+
+tap.test('should parse a normal frontmatter file', async () => {
+  
+});
+
+tap.start();

ts/index.ts

@@ -1,53 +1,32 @@
-import 'typings-global'
+import grayMatter from 'gray-matter';
-let grayMatter = require('gray-matter')
 
-export type TFrontMatter = 'yaml' | 'json'
+export type TFrontMatter = 'yaml' | 'json';
-
-export interface IParsedFM {
-    data: any
-    content: string
-    orig: string
-}
 
 export interface ISmartfmContructorOptions {
-    fmType: TFrontMatter
+  fmType: TFrontMatter;
 }
 
 /**
  * class smartfm handles frontmatter
  */
 export class Smartfm {
-    fmType: TFrontMatter
+  fmType: TFrontMatter;
 
-    constructor(optionsArg: ISmartfmContructorOptions) {
+  constructor(optionsArg: ISmartfmContructorOptions) {
-        this.fmType = optionsArg.fmType
+    this.fmType = optionsArg.fmType;
-    }
+  }
 
-    /**
+  /**
-     * add frontmatter to a string
+   * add frontmatter to a string
-     */
+   */
-    stringify(bodyString: string, frontmatterData: any) {
+  stringify(bodyString: string, frontmatterData: any) {
-        return stringify(bodyString, frontmatterData)
+    return grayMatter.stringify(bodyString, frontmatterData);
-    }
+  }
 
-    /**
+  /**
-     * parse a string that has frontmatter attached, YAML notation
+   * parse a string that has frontmatter attached, YAML notation
-     */
+   */
-    parse(stringToParse: string): IParsedFM {
+  parse(stringToParse: string) {
-        return parse(stringToParse)
+    return grayMatter(stringToParse);
-    }
+  }
-}
-
-/**
- * parse a string that has frontmatter attached, YAML notation
- */
-export let parse = (stringToParse: string): IParsedFM => {
-    return grayMatter(stringToParse)
-}
-
-/**
- * add frontmatter to a string
- */
-export let stringify = (bodyString: string, frontmatterData: any) => {
-    return grayMatter.stringify(bodyString, frontmatterData)
 }

tslint.json

@@ -1,3 +1,17 @@
 {
-    "extends": "tslint-config-standard"
+  "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"
 }