3.0.0

.gitignore

@@ -1,5 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
 public/
 pages/
-.nogit/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# 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,109 +18,114 @@ stages:
 mirror:
   stage: security
   script:
-  - npmci git mirror
+    - npmci git mirror
+  only:
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
-    - npmci command npm install -g snyk
+    - npmci npm prepare
-    - npmci command npm install --ignore-scripts
+    - npmci command npm install --production --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
   tags:
-  - docker
+    - docker
-  - notpriv
+
+auditDevDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=dev
+  tags:
+    - docker
+  allow_failure: true
 
 # ====================
 # 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:
+testStable:
   stage: test
   script:
-  - npmci node install lts
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
 
-testSTABLE:
+testBuild:
   stage: test
   script:
-  - npmci node install stable
+    - npmci npm prepare
-  - npmci npm install
+    - npmci node install stable
-  - npmci npm test
+    - npmci npm install
+    - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - 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:
+  only:
-    - docker:stable-dind
+    - tags
   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:
@@ -128,15 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - 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

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "globalNpmTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartyaml",
+      "shortDescription": "handle yaml in smart ways",
+      "npmPackagename": "@pushrocks/smartyaml",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,14 @@
 {
   "name": "@pushrocks/smartyaml",
-  "version": "2.0.3",
+  "version": "3.0.0",
   "private": false,
   "description": "handle yaml in smart ways",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(tstest test/)",
+    "test": "(tstest test/ --web)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -24,14 +25,29 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartyaml#README",
   "dependencies": {
-    "@types/js-yaml": "^3.11.2",
+    "@types/js-yaml": "^4.0.5",
-    "js-yaml": "^3.8.4"
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
+    "@gitzone/tsbuild": "^2.1.61",
-    "@gitzone/tsrun": "^1.1.12",
+    "@gitzone/tsrun": "^1.2.32",
-    "@gitzone/tstest": "^1.0.15",
+    "@gitzone/tstest": "^1.0.71",
-    "@pushrocks/tapbundle": "^3.0.5",
+    "@pushrocks/tapbundle": "^5.0.3",
-    "@types/node": "^10.9.2"
+    "@types/node": "^17.0.35"
-  }
+  },
+  "browserslist": [
+    "last 1 chrome versions"
+  ],
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -1,33 +1,39 @@
-# smartyaml
+# @pushrocks/smartyaml
-
 handle yaml in smart ways
 
-## Availabililty
+## Availabililty and Links
-
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartyaml)
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartyaml)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartyaml)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartyaml)
+* [github.com (source mirror)](https://github.com/pushrocks/smartyaml)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartyaml)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartyaml/)
-[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartyaml/)
 
 ## Status for master
 
-[![build status](https://GitLab.com/pushrocks/smartyaml/badges/master/build.svg)](https://GitLab.com/pushrocks/smartyaml/commits/master)
+Status Category | Status Badge
-[![coverage report](https://GitLab.com/pushrocks/smartyaml/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartyaml/commits/master)
+-- | --
-[![npm downloads per month](https://img.shields.io/npm/dm/smartyaml.svg)](https://www.npmjs.com/package/smartyaml)
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartyaml/badges/master/pipeline.svg)](https://lossless.cloud)
-[![Dependency Status](https://david-dm.org/pushrocks/smartyaml.svg)](https://david-dm.org/pushrocks/smartyaml)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartyaml/badges/master/coverage.svg)](https://lossless.cloud)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartyaml/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartyaml/master/dependencies/npm)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartyaml)](https://lossless.cloud)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/smartyaml/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartyaml)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartyaml)](https://lossless.cloud)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
+node Support | [![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-standard-brightgreen.svg)](http://standardjs.com/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartyaml)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartyaml)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartyaml)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 
 ## Usage
 
 Use TypeScript for best in class instellisense.
 
-For further information read the linked docs at the top of this README.
+## 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://push.rocks)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.both.ts

@@ -1,6 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
 
-import * as smartyaml from '../ts/index';
+import * as smartyaml from '../ts/index.js';
 
 let yamlString = `someKey: someValue
 someKey2: someValue2
@@ -8,21 +8,21 @@ someKey2: someValue2
 
 tap.test('should convert yaml string to object', async () => {
   let myObject = await smartyaml.yamlStringToObject(yamlString);
-  expect(myObject.someKey).to.equal('someValue');
+  expect(myObject.someKey).toEqual('someValue');
-  expect(myObject.someKey2).to.equal('someValue2');
+  expect(myObject.someKey2).toEqual('someValue2');
 });
 
 tap.test('should convert an object to a string', async () => {
   let myObject = await smartyaml.yamlStringToObject(yamlString);
   let myString = await smartyaml.objectToYamlString(myObject);
-  expect(myString).to.equal(yamlString);
+  expect(myString).toEqual(yamlString);
 });
 
 // test some behaviours
 tap.test('should allow dots in key', async () => {
   let testString = `myKey.with.dots: some`;
   let testObject = await smartyaml.yamlStringToObject(testString);
-  expect(testObject['myKey.with.dots']).to.equal('some');
+  expect(testObject['myKey.with.dots']).toEqual('some');
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartyaml',
+  version: '3.0.0',
+  description: 'handle yaml in smart ways'
+}

ts/index.ts

@@ -1,15 +1,15 @@
-import * as plugins from './smartyaml.plugins';
+import * as plugins from './smartyaml.plugins.js';
 
 export let yamlStringToObject = async (
   yamlStringArg,
   optionsArg: plugins.jsYaml.LoadOptions = {}
 ): Promise<any> => {
-  return plugins.jsYaml.safeLoad(yamlStringArg);
+  return plugins.jsYaml.load(yamlStringArg);
 };
 
 export let objectToYamlString = async (
   objectArg,
   optionsArg: plugins.jsYaml.DumpOptions = {}
 ): Promise<string> => {
-  return plugins.jsYaml.safeDump(objectArg);
+  return plugins.jsYaml.dump(objectArg);
 };

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}