fix(core): update

2019-09-04 14:13:42 +02:00 · 2019-09-04 14:13:42 +02:00 · 67ef49ddce
commit 67ef49ddce
parent d6cf698327
9 changed files with 1141 additions and 369 deletions
--- a/.gitignore
+++ b/.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
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@ -1,5 +1,5 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci

 cache:
  paths:
@ -26,6 +26,7 @@ mirror:
 snyk:
  stage: security
  script:
+    - npmci npm prepare
    - npmci command npm install -g snyk
    - npmci command npm install --ignore-scripts
    - npmci command snyk test
@ -36,44 +37,35 @@ snyk:
 # ====================
 # test stage
 # ====================
-testLEGACY:
-  stage: test
-  script:
-  - npmci node install legacy
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-  allow_failure: true

-testLTS:
-  stage: test
-  script:
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
+testStable:
  stage: test
  script:
+  - npmci npm prepare
  - npmci node install stable
  - npmci npm install
  - npmci npm test
  coverage: /\d+.?\d+?\%\s*coverage/
  tags:
  - docker
+  - priv
+
+testBuild:
+  stage: test
+  script:
+  - npmci npm prepare
+  - npmci node install lts
+  - npmci npm install
+  - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+  - docker
  - notpriv

 release:
  stage: release
  script:
-  - npmci node install stable
+  - npmci node install lts
  - npmci npm publish
  only:
  - tags
@ -86,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/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --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]
+    - npmci command npm install -g tslint typescript
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
  tags:
  - docker
  - priv
@ -114,12 +98,15 @@ trigger:
  - notpriv

 pages:
-  image: hosttoday/ht-docker-node:npmci
+  image: hosttoday/ht-docker-dbase:npmci
+  services:
+   - docker:stable-dind
  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
@ -130,13 +117,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
--- a/README.md
+++ b/README.md
@ -1,47 +1,20 @@
-# smartfm
-
+# @pushrocks/smartfm
 frontmatter done right

-## Availabililty
-
-[![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)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfm)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfm/)
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/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)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfm/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfm/master/dependencies/npm)
-[![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-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.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-standard-brightgreen.svg)](http://standardjs.com/)
-
-## What is frontMatter?
-
-say you have the following markdown file:
-
-```markdown
---
-title: A Really Awesome Article
-date: 23-10-2020
-type: feature
---
-
-# An Awesome Title
-
-The world is cool. And here is why
-
- reason 1
- reason 2
-```
-
-The top part that is enclosed by `---` denotes frontmatter, usually written in yaml notation.
-Frontmatter is not exclusive to markdown.
-It can be used as prefix in any type of file when preprocessed with smartfm.
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartfm.svg)](https://www.npmjs.com/package/@pushrocks/smartfm)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartfm/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartfm)
+[![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

@ -80,4 +53,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 | **&copy;** [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)
--- a/npmextra.json
+++ b/npmextra.json
@ -2,5 +2,15 @@
  "npmci": {
    "npmGlobalTools": [],
    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartfm",
+      "shortDescription": "frontmatter done right",
+      "npmPackagename": "@pushrocks/smartfm",
+      "license": "MIT"
+    }
  }
 }
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@ -23,13 +23,24 @@
  },
  "homepage": "https://gitlab.com/pushrocks/smartfm#README",
  "dependencies": {
-    "gray-matter": "^4.0.1"
+    "gray-matter": "^4.0.2"
  },
  "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.5",
-    "@types/node": "^10.9.2"
-  }
-}
+    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsrun": "^1.2.8",
+    "@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"
+  ]
+}
--- a/test/test.ts
+++ b/test/test.ts
@ -15,11 +15,15 @@ testKey2: testValue2
  expect(parsedString.data).to.have.property('testKey2', 'testValue2');
  expect(parsedString.orig.toString()).to.equal(testString);
 });
-tap.test('.stringify', async () => {
+tap.test('should stringify data', async () => {
  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';
  expect(resultString).to.equal(testStringCombined);
 });

+tap.test('should parse a normal frontmatter file', async () => {
+  
+});
+
 tap.start();
--- a/ts/index.ts
+++ b/ts/index.ts
@ -1,4 +1,4 @@
-import * as grayMatter from 'gray-matter';
+import grayMatter from 'gray-matter';

 export type TFrontMatter = 'yaml' | 'json';

--- a/tslint.json
+++ b/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"
 }