fix(core): update

2022-10-11 13:05:29 +02:00
parent f0b52c8da7
commit d577a82a7b
19 changed files with 4402 additions and 2395 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -15,8 +15,6 @@ node_modules/

 # builds
 dist/
-dist_web/
-dist_serve/
-dist_ts_web/
+dist_*/

 # custom
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -4,72 +4,79 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 cache:
  paths:
    - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'

 stages:
- security
- test
- release
- metadata
+  - security
+  - test
+  - release
+  - metadata
+
+before_script:
+  - npm install -g @shipzone/npmci

 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
  stage: security
  script:
    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
  tags:
    - docker
-  - notpriv
+  allow_failure: true
+
+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
 # ====================

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

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

 release:
  stage: release
  script:
-  - npmci node install lts
+    - npmci node install stable
    - npmci npm publish
  only:
    - tags
  tags:
+    - lossless
    - docker
    - notpriv

@@ -79,11 +86,14 @@ release:
 codequality:
  stage: metadata
  allow_failure: true
+  only:
+    - tags
  script:
-    - npmci command npm install -g tslint typescript
+    - npmci command npm install -g typescript
+    - npmci npm prepare
    - npmci npm install
-    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
  tags:
+    - lossless
    - docker
    - priv

@@ -94,18 +104,19 @@ trigger:
  only:
    - tags
  tags:
+    - lossless
    - docker
    - notpriv

 pages:
-  image: hosttoday/ht-docker-node:npmci
  stage: metadata
  script:
-    - npmci command npm install -g @gitzone/tsdoc
+    - npmci node install stable 
    - npmci npm prepare
    - npmci npm install
-    - npmci command tsdoc
+    - npmci command npm run buildDocs
  tags:
+    - lossless
    - docker
    - notpriv
  only:
--- a/.vscode/launch.json
+++ b/.vscode/launch.json
@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}
--- a/.vscode/settings.json
+++ b/.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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}
--- a/README.md
+++ b/README.md
@@ -1,56 +0,0 @@
-# @pushrocks/smartssh
-setups SSH quickly and in a painless manner
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartssh)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartssh)
-* [github.com (source mirror)](https://github.com/pushrocks/smartssh)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartssh/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartssh/badges/master/build.svg)](https://gitlab.com/pushrocks/smartssh/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartssh/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartssh/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartssh.svg)](https://www.npmjs.com/package/@pushrocks/smartssh)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartssh/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartssh)
-[![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
-
-```javascript
-var smartssh = require('smartssh');
-var sshInstance = new smartssh.sshInstance({
-  sshDir: '/some/path/.ssh', // the standard ssh directory, optional, defaults to "~./.ssh"
-  sshSync: true // sync ssh this instance will represent the status of an ssh dir if set to true;
-});
-
-sshInstance.addKey(
-  new smartssh.sshKey({
-    private: 'somestring',
-    public: 'somestring', // optional
-    host: 'github.com',
-    encoding: 'base64' // optional, defaults to "utf8", can be "utf8" or "base64", useful for reading ssh keys from environment variables
-  })
-);
-
-sshInstance.removeKey(sshInstance.getKey('github.com')); // removes key for host "github.com" is present
-
-sshInstance.createKey({
-  host: 'gitlab.com' // returns new key in the form sshKey, read more about the sshKey class below
-});
-
-sshInstance.getKey({
-  // returns ssh key in the form sshKey, read more about the sshKey class below
-  host: 'github.com'
-});
-
-sshInstance.getKeys(); // returns array of all available getKeys. Each key is in form of class sshKey
-```
-
-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.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
--- a/npmextra.json
+++ b/npmextra.json
@@ -4,11 +4,12 @@
    "npmAccessLevel": "public"
  },
  "gitzone": {
+    "projectType": "npm",
    "module": {
      "githost": "gitlab.com",
      "gitscope": "pushrocks",
      "gitrepo": "smartssh",
-      "shortDescription": "setups SSH quickly and in a painless manner",
+      "description": "setups SSH quickly and in a painless manner",
      "npmPackagename": "@pushrocks/smartssh",
      "license": "MIT"
    }
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -3,12 +3,14 @@
  "version": "1.2.4",
  "private": false,
  "description": "setups SSH quickly and in a painless manner",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
  "scripts": {
    "test": "(tstest test/)",
    "testDocker": "tsdocker",
-    "build": "(tsbuild)"
+    "build": "(tsbuild)",
+    "buildDocs": "tsdoc"
  },
  "repository": {
    "type": "git",
@@ -26,32 +28,36 @@
  },
  "homepage": "https://gitlab.com/pushrocks/smartssh#readme",
  "dependencies": {
-    "@pushrocks/smartfile": "^7.0.4",
-    "@pushrocks/smartpath": "^4.0.1",
+    "@pushrocks/smartfile": "^10.0.5",
+    "@pushrocks/smartpath": "^5.0.5",
    "@pushrocks/smartpromise": "^3.0.2",
    "@pushrocks/smartshell": "^2.0.23",
-    "@pushrocks/smartstring": "^3.0.10",
-    "@types/fs-extra": "^8.0.0",
-    "@types/minimatch": "^3.0.3",
-    "fs-extra": "^8.1.0",
-    "minimatch": "^3.0.4"
+    "@pushrocks/smartstring": "^4.0.5",
+    "@types/fs-extra": "^9.0.13",
+    "@types/minimatch": "^5.1.2",
+    "fs-extra": "^10.1.0",
+    "minimatch": "^5.1.0"
  },
  "devDependencies": {
    "@gitzone/tsbuild": "^2.1.11",
-    "@gitzone/tsdocker": "^1.2.39",
    "@gitzone/tsrun": "^1.2.6",
    "@gitzone/tstest": "^1.0.24",
-    "@pushrocks/tapbundle": "^3.0.11",
-    "@types/node": "^12.6.6"
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.8.4"
  },
  "files": [
-    "ts/*",
-    "ts_web/*",
-    "dist/*",
-    "dist_web/*",
-    "assets/*",
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
    "cli.js",
    "npmextra.json",
    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
  ]
 }
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
--- a/test/test.ts
+++ b/test/test.ts
@@ -1,6 +1,6 @@
 import { expect, tap } from '@pushrocks/tapbundle';
-import smartssh = require('../ts/index');
-import path = require('path');
+import * as smartssh from '../ts/index.js';
+import * as path from 'path';

 let testSshInstance: smartssh.SshInstance;
 let testSshKey: smartssh.SshKey;
@@ -8,18 +8,18 @@ tap.test('should create a valid SshKey object', async () => {
  testSshKey = new smartssh.SshKey({
    host: 'example.com',
    private: 'someExamplePrivateKey',
-    public: 'someExamplePublicKey'
+    public: 'someExamplePublicKey',
  });
-  expect(testSshKey).to.be.instanceof(smartssh.SshKey);
+  expect(testSshKey).toBeInstanceOf(smartssh.SshKey);
 });
 tap.test('.type should be a valid type', async () => {
-  expect(testSshKey.type).equal('duplex');
+  expect(testSshKey.type).toEqual('duplex');
 });
 tap.test('.publicKey should be public key', async () => {
-  expect(testSshKey.pubKey).equal('someExamplePublicKey');
+  expect(testSshKey.pubKey).toEqual('someExamplePublicKey');
 });
 tap.test('.privateKey should be private key', async () => {
-  expect(testSshKey.privKey).equal('someExamplePrivateKey');
+  expect(testSshKey.privKey).toEqual('someExamplePrivateKey');
 });
 tap.test('.publicKeyBase64 should be public key base 64 encoded', async () => {
  // tslint:disable-next-line:no-unused-expression
@@ -32,49 +32,49 @@ tap.test('.store() should store the file to disk', async () => {
 // SSH INstance
 tap.test("'new' keyword should create a new SshInstance object from class", async () => {
  testSshInstance = new smartssh.SshInstance({
-    sshDirPath: path.join(process.cwd(), 'test/temp/')
+    sshDirPath: path.join(process.cwd(), 'test/temp/'),
  });
-  expect(testSshInstance).be.instanceof(smartssh.SshInstance);
+  expect(testSshInstance).toBeInstanceOf(smartssh.SshInstance);
 });
 tap.test('.addKey() should accept a new SshKey object', async () => {
  testSshInstance.addKey(
    new smartssh.SshKey({
      public: 'somePublicKey',
      private: 'somePrivateKey',
-      host: 'gitlab.com'
+      host: 'gitlab.com',
    })
  );
  testSshInstance.addKey(
    new smartssh.SshKey({
      public: 'somePublicKey',
      private: 'somePrivateKey',
-      host: 'bitbucket.org'
+      host: 'bitbucket.org',
    })
  );
  testSshInstance.addKey(
    new smartssh.SshKey({
      public: 'someGitHubPublicKey',
      private: 'someGitHubPrivateKey',
-      host: 'github.com'
+      host: 'github.com',
    })
  );
 });

 tap.test('.sshKeys should point to an array of sshKeys', async () => {
  let sshKeyArray = testSshInstance.sshKeys;
-  expect(sshKeyArray).be.instanceOf(Array);
-  expect(sshKeyArray[0].host).equal('gitlab.com');
-  expect(sshKeyArray[1].host).equal('bitbucket.org');
-  expect(sshKeyArray[2].host).equal('github.com');
+  expect(sshKeyArray).toBeInstanceOf(Array);
+  expect(sshKeyArray[0].host).toEqual('gitlab.com');
+  expect(sshKeyArray[1].host).toEqual('bitbucket.org');
+  expect(sshKeyArray[2].host).toEqual('github.com');
 });

 tap.test('.getKey() should get a specific key selected by host', async () => {
-  expect(testSshInstance.getKey('github.com').pubKey).equal('someGitHubPublicKey');
+  expect(testSshInstance.getKey('github.com').pubKey).toEqual('someGitHubPublicKey');
 });

 tap.test('.removeKey() should remove a key', async () => {
  testSshInstance.removeKey(testSshInstance.getKey('bitbucket.org'));
-  expect(testSshInstance.sshKeys[1].host).equal('github.com');
+  expect(testSshInstance.sshKeys[1].host).toEqual('github.com');
 });

 tap.test('it should store to disk', async () => {
--- a/ts/00_commitinfo_data.ts
+++ b/ts/00_commitinfo_data.ts
@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartssh',
+  version: '1.2.5',
+  description: 'setups SSH quickly and in a painless manner'
+}
--- a/ts/index.ts
+++ b/ts/index.ts
@@ -1,6 +1,6 @@
-import * as plugins from './smartssh.plugins';
+import * as plugins from './smartssh.plugins.js';

-export { SshInstance } from './smartssh.classes.sshinstance';
-export { SshKey } from './smartssh.classes.sshkey';
-export { SshDir } from './smartssh.classes.sshdir';
-export { SshConfig } from './smartssh.classes.sshconfig';
+export { SshInstance } from './smartssh.classes.sshinstance.js';
+export { SshKey } from './smartssh.classes.sshkey.js';
+export { SshDir } from './smartssh.classes.sshdir.js';
+export { SshConfig } from './smartssh.classes.sshconfig.js';
--- a/ts/smartssh.classes.helpers.ts
+++ b/ts/smartssh.classes.helpers.ts
@@ -1,7 +1,7 @@
-import * as plugins from './smartssh.plugins';
-import { SshKey } from './smartssh.classes.sshkey';
+import * as plugins from './smartssh.plugins.js';
+import { SshKey } from './smartssh.classes.sshkey.js';

-export let sshKeyArrayFromDir = function(dirArg: string): SshKey[] {
+export let sshKeyArrayFromDir = function (dirArg: string): SshKey[] {
  let sshKeyArray = []; // TODO
  return sshKeyArray;
 };
--- a/ts/smartssh.classes.sshconfig.ts
+++ b/ts/smartssh.classes.sshconfig.ts
@@ -1,6 +1,6 @@
-import * as plugins from './smartssh.plugins';
-import * as helpers from './smartssh.classes.helpers';
-import { SshKey } from './smartssh.classes.sshkey';
+import * as plugins from './smartssh.plugins.js';
+import * as helpers from './smartssh.classes.helpers.js';
+import { SshKey } from './smartssh.classes.sshkey.js';

 export class SshConfig {
  private _sshKeyArray: SshKey[];
@@ -34,7 +34,7 @@ export class SshConfig {
      configArray.push({
        configString: configString,
        authorized: sshKey.authorized,
-        sshKey: sshKey
+        sshKey: sshKey,
      });
    }
    let configFile: string = '';
--- a/ts/smartssh.classes.sshdir.ts
+++ b/ts/smartssh.classes.sshdir.ts
@@ -1,8 +1,8 @@
-import * as plugins from './smartssh.plugins';
-import * as helpers from './smartssh.classes.helpers';
-import { SshInstance } from './smartssh.classes.sshinstance';
-import { SshKey } from './smartssh.classes.sshkey';
-import { SshConfig } from './smartssh.classes.sshconfig';
+import * as plugins from './smartssh.plugins.js';
+import * as helpers from './smartssh.classes.helpers.js';
+import { SshInstance } from './smartssh.classes.sshinstance.js';
+import { SshKey } from './smartssh.classes.sshkey.js';
+import { SshConfig } from './smartssh.classes.sshconfig.js';

 export class SshDir {
  // sshDir class -> NOT EXPORTED, ONLY FOR INTERNAL USE
@@ -23,7 +23,7 @@ export class SshDir {
    // syncs sshInstance to directory
    let path = this._path;
    if (dirPathArg) path = dirPathArg;
-    this._sshKeyArray.forEach(sshKeyArg => {
+    this._sshKeyArray.forEach((sshKeyArg) => {
      sshKeyArg.store(path);
    });
    this._sshConfig.store(path);
--- a/ts/smartssh.classes.sshinstance.ts
+++ b/ts/smartssh.classes.sshinstance.ts
@@ -1,9 +1,9 @@
-import * as plugins from './smartssh.plugins';
-import * as helpers from './smartssh.classes.helpers';
+import * as plugins from './smartssh.plugins.js';
+import * as helpers from './smartssh.classes.helpers.js';

-import { SshDir } from './smartssh.classes.sshdir';
-import { SshConfig } from './smartssh.classes.sshconfig';
-import { SshKey } from './smartssh.classes.sshkey';
+import { SshDir } from './smartssh.classes.sshdir.js';
+import { SshConfig } from './smartssh.classes.sshconfig.js';
+import { SshKey } from './smartssh.classes.sshkey.js';

 /**
 * SshInstance is the main class dealing with ssh management
@@ -45,7 +45,7 @@ export class SshInstance {
  // non altering methods
  getKey(hostArg: string): SshKey {
    this._syncAuto('from');
-    let filteredArray = this._sshKeyArray.filter(function(keyArg) {
+    let filteredArray = this._sshKeyArray.filter(function (keyArg) {
      return keyArg.host === hostArg;
    });
    if (filteredArray.length > 0) {
--- a/ts/smartssh.classes.sshkey.ts
+++ b/ts/smartssh.classes.sshkey.ts
@@ -1,5 +1,5 @@
-import * as plugins from './smartssh.plugins';
-import * as helpers from './smartssh.classes.helpers';
+import * as plugins from './smartssh.plugins.js';
+import * as helpers from './smartssh.classes.helpers.js';

 export class SshKey {
  private _privKey: string;
@@ -8,7 +8,7 @@ export class SshKey {
  private _authorized: boolean;

  private _smarthshellInstance = new plugins.shelljs.Smartshell({
-    executor: 'bash'
+    executor: 'bash',
  });

  /**
--- a/tsconfig.json
+++ b/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}
--- a/tslint.json
+++ b/tslint.json
@@ -1,17 +0,0 @@
-{
-  "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"
-}