1.0.16

.gitignore

@@ -15,8 +15,6 @@ node_modules/
 
 # builds
 dist/
-dist_web/
+dist_*/
-dist_serve/
-dist_ts_web/
 
 # custom

.gitlab-ci.yml

@@ -3,14 +3,14 @@ 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,48 +18,74 @@ 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 npm prepare
-    - npmci command npm install -g snyk
+    - npmci command npm install --production --ignore-scripts
-    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command snyk test
+    - 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
 # ====================
 
-testLTS:
+testStable:
   stage: test
   script:
-  - npmci npm prepare
+    - npmci npm prepare
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm install
+    - npmci npm install
-  - npmci npm test
+    - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-  - docker
+    - docker
-  - notpriv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
 
 release:
   stage: release
   script:
-  - npmci node install lts
+    - npmci node install stable
-  - npmci npm publish
+    - npmci npm publish
   only:
-  - tags
+    - tags
   tags:
-  - docker
+    - lossless
-  - notpriv
+    - docker
+    - notpriv
 
 # ====================
 # metadata stage
@@ -67,33 +93,39 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
+    - npmci npm prepare
     - npmci npm install
     - npmci command "tslint -c tslint.json ./ts/**/*.ts"
   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 node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:
@@ -101,5 +133,5 @@ pages:
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
   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"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,76 +0,0 @@
-# @pushrocks/smartgit
-smart wrapper for nodegit
-
-## Availabililty and Links
-* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartgit)
-* [gitlab.com (source)](https://gitlab.com/pushrocks/smartgit)
-* [github.com (source mirror)](https://github.com/pushrocks/smartgit)
-* [docs (typedoc)](https://pushrocks.gitlab.io/smartgit/)
-
-## Status for master
-[![build status](https://gitlab.com/pushrocks/smartgit/badges/master/build.svg)](https://gitlab.com/pushrocks/smartgit/commits/master)
-[![coverage report](https://gitlab.com/pushrocks/smartgit/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartgit/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartgit.svg)](https://www.npmjs.com/package/@pushrocks/smartgit)
-[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartgit/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartgit)
-[![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
-
-We recommend the use of TypeScript for best in class intellisense
-
-```javascript
-// import smartgit:
-import { GitRepo } from 'smartgit';
-
-// Initialize smartgit:
-// -- note: there are 3 ways to initialize smartgit
-// -- -- 1. with a existing Git repo
-// -- -- 2. with a cloned Git repo
-// -- -- 3. with a new Git repo
-
-// -- 1. existing Git Repo:
-let myExistingGitRepo = new GitRepo('/path/to/existing/git/repo/');
-
-// -- 2. cloned Git Repo:
-let myClonedGitRepo: GitRepo;
-smartgit.createRepoFromClone('git@github.com:username/reponame.git').then(gitRepo => {
-  // non blocking
-  myClonedGitRepo = gitRepo;
-});
-
-// -- 3. new Git Repo
-let myNewGitRepo: GitRepo;
-smartgit
-  .createRepoFromInit('/path/to/new/folder') // smartgit will create any new folder, be careful
-  .then(gitRepo => {
-    // non blocking
-    myNewGitRepo = gitRepo;
-  });
-
-// Using smartgit instance
-// -- most used actions
-// -- all actions return promises, so make sure to use promise chaining for any dependent tasks
-myExistingGitRepo.addAll(); // returns promise, stages all changed files
-myExistingGitRepo.add(['relative/path/to/file.txt', 'another/file2.txt']); // returns promise, stages specific files
-myExistingGitRepo.commit('my commit message'); // returns promise, commits staged files
-myExistingGitRepo
-  .status() // returns promise
-  .then(status => {
-    // Use TypeScript for status type information
-  });
-myExistingGitRepo.check(); // returns promise, checks repo health
-myExistingGitRepo.remoteAdd('git@github.com:username/reponame.git');
-```
-
-Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment
-
-[![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.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)

npmextra.json

@@ -7,9 +7,9 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
-
   },
   "gitzone": {
+    "projectType": "npm",
     "module": {
       "githost": "gitlab.com",
       "gitscope": "pushrocks",

package.json

@@ -1,9 +1,9 @@
 {
   "name": "@pushrocks/smartgit",
-  "version": "1.0.13",
+  "version": "1.0.16",
   "description": "smart wrapper for nodegit",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
     "test": "(tstest test/)",
     "build": "(tsbuild)"
@@ -24,31 +24,36 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartgit",
   "dependencies": {
-    "@pushrocks/smartfile": "^7.0.4",
+    "@pushrocks/smartfile": "^8.0.0",
-    "@pushrocks/smartpath": "^4.0.1",
+    "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.2",
+    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartshell": "^2.0.23",
+    "@pushrocks/smartshell": "^2.0.26",
-    "@pushrocks/smartstring": "^3.0.10",
+    "@pushrocks/smartstring": "^3.0.18",
     "@types/minimatch": "^3.0.3",
-    "@types/nodegit": "^0.24.10",
+    "@types/nodegit": "^0.26.7",
-    "nodegit": "^0.25.1"
+    "nodegit": "^0.27.0"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
+    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.24",
+    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.0.13",
+    "@pushrocks/tapbundle": "^3.2.9",
-    "tslint": "^5.19.0",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0"
   },
   "private": false,
   "files": [
-    "ts/*",
+    "ts/**/*",
-    "ts_web/*",
+    "ts_web/**/*",
-    "dist/*",
+    "dist/**/*",
-    "dist_web/*",
+    "dist_*/**/*",
-    "assets/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -0,0 +1,88 @@
+# @pushrocks/smartgit
+smart wrapper for nodegit
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartgit)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartgit)
+* [github.com (source mirror)](https://github.com/pushrocks/smartgit)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartgit/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartgit/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartgit/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartgit)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartgit)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+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/smartgit)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartgit)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartgit)](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
+
+We recommend the use of TypeScript for best in class intellisense
+
+```javascript
+// import smartgit:
+import { GitRepo } from 'smartgit';
+
+// Initialize smartgit:
+// -- note: there are 3 ways to initialize smartgit
+// -- -- 1. with a existing Git repo
+// -- -- 2. with a cloned Git repo
+// -- -- 3. with a new Git repo
+
+// -- 1. existing Git Repo:
+let myExistingGitRepo = new GitRepo('/path/to/existing/git/repo/');
+
+// -- 2. cloned Git Repo:
+let myClonedGitRepo: GitRepo;
+smartgit.createRepoFromClone('git@github.com:username/reponame.git').then((gitRepo) => {
+  // non blocking
+  myClonedGitRepo = gitRepo;
+});
+
+// -- 3. new Git Repo
+let myNewGitRepo: GitRepo;
+smartgit
+  .createRepoFromInit('/path/to/new/folder') // smartgit will create any new folder, be careful
+  .then((gitRepo) => {
+    // non blocking
+    myNewGitRepo = gitRepo;
+  });
+
+// Using smartgit instance
+// -- most used actions
+// -- all actions return promises, so make sure to use promise chaining for any dependent tasks
+myExistingGitRepo.addAll(); // returns promise, stages all changed files
+myExistingGitRepo.add(['relative/path/to/file.txt', 'another/file2.txt']); // returns promise, stages specific files
+myExistingGitRepo.commit('my commit message'); // returns promise, commits staged files
+myExistingGitRepo
+  .status() // returns promise
+  .then((status) => {
+    // Use TypeScript for status type information
+  });
+myExistingGitRepo.check(); // returns promise, checks repo health
+myExistingGitRepo.remoteAdd('git@github.com:username/reponame.git');
+```
+
+Tip: use [smartssh](https://npmjs.com/smartssh) to setup your SSH environment
+
+[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)
+
+
+## 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)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -7,6 +7,6 @@ const testRepoDir = path.join(__dirname, '../.nogit/testrepo');
 
 tap.test('should create a new repo at .nogit', async () => {
   const gitRepo = await smartgit.GitRepo.fromCreatingRepoInDir(testRepoDir);
-})
+});
 
 tap.start();

ts/smartgit.classes.gitrepo.ts

@@ -12,7 +12,7 @@ export class GitRepo {
     const dirArg = plugins.path.resolve(toArg);
     const ngRespository = await plugins.nodegit.Clone.clone(fromArg, toArg, {
       bare: 0,
-      checkoutBranch: 'master'
+      checkoutBranch: 'master',
     });
     return new GitRepo(ngRespository);
   }
@@ -39,14 +39,14 @@ export class GitRepo {
   /**
    * lists remotes
    */
-  public async listRemotes(): Promise<string[]> {
+  public async listRemotes(): Promise<plugins.nodegit.Remote[]> {
     return this.nodegitRepo.getRemotes();
   }
 
   /**
    * ensures the existance of a remote within a repository
    * @param remoteNameArg
-   * @param remoteUrlArg 
+   * @param remoteUrlArg
    */
   public async ensureRemote(remoteNameArg: string, remoteUrlArg: string): Promise<void> {
     const existingUrl = await this.getUrlForRemote(remoteNameArg);