3.0.0

.gitlab-ci.yml

@@ -12,20 +12,12 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
-mirror:
-  stage: security
-  script:
-    - npmci git mirror
-  only:
-    - tags
-  tags:
-    - lossless
-    - docker
-    - notpriv
-
 auditProductionDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
@@ -36,6 +28,7 @@ auditProductionDependencies:
     - npmci command npm audit --audit-level=high --only=prod --production
   tags:
     - docker
+  allow_failure: true
 
 auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
@@ -96,10 +89,9 @@ codequality:
   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
@@ -119,11 +111,10 @@ trigger:
 pages:
   stage: metadata
   script:
-    - npmci node install lts
-    - 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

.vscode/launch.json

@@ -2,28 +2,10 @@
   "version": "0.2.0",
   "configurations": [
     {
-      "name": "current file",
-      "type": "node",
+      "command": "npm test",
+      "name": "Run npm test",
       "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"
+      "type": "node-terminal"
     }
   ]
 }

npmextra.json

@@ -1,9 +1,4 @@
 {
-  "npmts": {
-    "mode": "default",
-    "codecov": true,
-    "coverageTreshold": 71
-  },
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
@@ -14,7 +9,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartgit",
-      "shortDescription": "smart wrapper for nodegit",
+      "description": "smart wrapper for nodegit",
       "npmPackagename": "@pushrocks/smartgit",
       "license": "MIT"
     }

package.json

@@ -1,12 +1,14 @@
 {
   "name": "@pushrocks/smartgit",
-  "version": "1.0.15",
+  "version": "3.0.0",
   "description": "smart wrapper for nodegit",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -24,21 +26,19 @@
   },
   "homepage": "https://gitlab.com/pushrocks/smartgit",
   "dependencies": {
-    "@pushrocks/smartfile": "^8.0.0",
-    "@pushrocks/smartpath": "^4.0.3",
-    "@pushrocks/smartpromise": "^3.0.6",
-    "@pushrocks/smartshell": "^2.0.26",
-    "@pushrocks/smartstring": "^3.0.18",
-    "@types/minimatch": "^3.0.3",
-    "@types/nodegit": "^0.26.7",
-    "nodegit": "^0.27.0"
+    "@pushrocks/smartenv": "^5.0.2",
+    "@pushrocks/smartfile": "^10.0.4",
+    "@pushrocks/smartpath": "^5.0.5",
+    "@pushrocks/smartpromise": "^3.1.7",
+    "@pushrocks/smartshell": "^2.0.30",
+    "@pushrocks/smartstring": "^4.0.2",
+    "@types/minimatch": "^3.0.5",
+    "isomorphic-git": "^1.19.1"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.25",
-    "@gitzone/tstest": "^1.0.44",
-    "@pushrocks/tapbundle": "^3.2.9",
-    "tslint": "^6.1.3",
-    "tslint-config-prettier": "^1.18.0"
+    "@gitzone/tsbuild": "^2.1.63",
+    "@gitzone/tstest": "^1.0.72",
+    "@pushrocks/tapbundle": "^5.0.4"
   },
   "private": false,
   "files": [

readme.md

@@ -0,0 +1,87 @@
+# @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

@@ -1,12 +1,29 @@
 import { tap, expect } from '@pushrocks/tapbundle';
-import * as smartgit from '../ts/index';
+import * as smartgit from '../ts/index.js';
 
+import * as smartpath from '@pushrocks/smartpath';
+const __dirname = smartpath.get.dirnameFromImportMetaUrl(import.meta.url);
 import * as path from 'path';
 
+let testSmartgitInstance: smartgit.Smartgit;
 const testRepoDir = path.join(__dirname, '../.nogit/testrepo');
+const testRepoDirSmartfile = path.join(__dirname, '../.nogit/pushrocks_smartfile');
+
+tap.test('should create a valid smartgit instance', async () => {
+  testSmartgitInstance = new smartgit.Smartgit();
+  await testSmartgitInstance.init();
+  expect(testSmartgitInstance).toBeInstanceOf(smartgit.Smartgit);
+});
 
 tap.test('should create a new repo at .nogit', async () => {
-  const gitRepo = await smartgit.GitRepo.fromCreatingRepoInDir(testRepoDir);
+  const gitRepo = await testSmartgitInstance.createRepoByOpen(testRepoDir);
+});
+
+tap.test('should clone a repo', async () => {
+  const gitRepo = await testSmartgitInstance.createRepoByClone(
+    'https://gitlab.com/pushrocks/smartfile.git',
+    testRepoDirSmartfile
+  );
 });
 
 tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/smartgit',
+  version: '3.0.0',
+  description: 'smart wrapper for nodegit'
+}

ts/index.ts

@@ -1,3 +1,2 @@
-import plugins = require('./smartgit.plugins');
-
-export * from './smartgit.classes.gitrepo';
+export * from './smartgit.classes.gitrepo.js';
+export * from './smartgit.classes.smartgit.js';

ts/smartgit.classes.gitrepo.ts

@@ -1,4 +1,6 @@
-import * as plugins from './smartgit.plugins';
+import * as plugins from './smartgit.plugins.js';
+
+import { Smartgit } from './smartgit.classes.smartgit.js';
 
 /**
  * class GitRepo allows access to git directories from node
@@ -8,39 +10,61 @@ export class GitRepo {
   /**
    * creates a new GitRepo Instance after cloning a project
    */
-  public static async fromCloningIntoDir(fromArg: string, toArg: string): Promise<GitRepo> {
+  public static async fromCloningIntoDir(
+    smartgitRefArg: Smartgit,
+    fromArg: string,
+    toArg: string
+  ): Promise<GitRepo> {
     const dirArg = plugins.path.resolve(toArg);
-    const ngRespository = await plugins.nodegit.Clone.clone(fromArg, toArg, {
-      bare: 0,
-      checkoutBranch: 'master',
+    await plugins.isomorphicGit.clone({
+      dir: toArg,
+      fs: smartgitRefArg.envDeps.fs,
+      http: smartgitRefArg.envDeps.http,
+      url: fromArg,
     });
-    return new GitRepo(ngRespository);
+    return new GitRepo(smartgitRefArg, toArg);
   }
 
-  public static async fromCreatingRepoInDir(dirArg: string): Promise<GitRepo> {
+  public static async fromCreatingRepoInDir(
+    smartgitRefArg: Smartgit,
+    dirArg: string
+  ): Promise<GitRepo> {
     dirArg = plugins.path.resolve(dirArg);
-    const ngRepository = await plugins.nodegit.Repository.init(dirArg, 0);
-    return new GitRepo(ngRepository);
+    await plugins.isomorphicGit.init({
+      dir: dirArg,
+      fs: smartgitRefArg.envDeps.fs,
+    });
+    return new GitRepo(smartgitRefArg, dirArg);
   }
 
-  public static async fromOpeningRepoDir(dirArg: string) {
+  public static async fromOpeningRepoDir(smartgitRefArg: Smartgit, dirArg: string) {
     dirArg = plugins.path.resolve(dirArg);
-    const ngRepository = await plugins.nodegit.Repository.open(dirArg);
-    return new GitRepo(ngRepository);
+    return new GitRepo(smartgitRefArg, dirArg);
   }
 
   // INSTANCE
-  public nodegitRepo: plugins.nodegit.Repository;
+  public smartgitRef: Smartgit;
+  public repoDir: string;
 
-  constructor(nodegitRepoArg: plugins.nodegit.Repository) {
-    this.nodegitRepo = nodegitRepoArg;
+  constructor(smartgitRefArg: Smartgit, repoDirArg: string) {
+    this.smartgitRef = smartgitRefArg;
+    this.repoDir = repoDirArg;
   }
 
   /**
    * lists remotes
    */
-  public async listRemotes(): Promise<plugins.nodegit.Remote[]> {
-    return this.nodegitRepo.getRemotes();
+  public async listRemotes(): Promise<
+    {
+      remote: string;
+      url: string;
+    }[]
+  > {
+    const remotes = await plugins.isomorphicGit.listRemotes({
+      fs: this.smartgitRef.envDeps.fs,
+      dir: this.repoDir,
+    });
+    return remotes;
   }
 
   /**
@@ -49,31 +73,41 @@ export class GitRepo {
    * @param remoteUrlArg
    */
   public async ensureRemote(remoteNameArg: string, remoteUrlArg: string): Promise<void> {
-    const existingUrl = await this.getUrlForRemote(remoteNameArg);
-    if (existingUrl === remoteUrlArg) {
-      return;
+    const remotes = await this.listRemotes();
+    const existingRemote = remotes.find((itemArg) => itemArg.remote === remoteNameArg);
+    if (existingRemote) {
+      if (existingRemote.url !== remoteUrlArg) {
+        await plugins.isomorphicGit.deleteRemote({
+          remote: remoteNameArg,
+          fs: this.smartgitRef.envDeps.fs,
+          dir: this.repoDir,
+        });
+      } else {
+        return;
+      }
     }
-    if (existingUrl) {
-      await plugins.nodegit.Remote.delete(this.nodegitRepo, remoteNameArg);
-    }
-    await plugins.nodegit.Remote.create(this.nodegitRepo, remoteNameArg, remoteUrlArg);
+    await plugins.isomorphicGit.addRemote({
+      remote: remoteNameArg,
+      fs: this.smartgitRef.envDeps.fs,
+      url: remoteUrlArg,
+    });
   }
 
   /**
    * gets the url for a specific remote
    */
   public async getUrlForRemote(remoteName: string): Promise<string> {
-    const ngRemote = await this.nodegitRepo.getRemote(remoteName);
-    if (ngRemote) {
-      return ngRemote.url();
-    } else {
-      return null;
-    }
+    const remotes = await this.listRemotes();
+    const existingRemote = remotes.find((remoteArg) => remoteArg.remote === remoteName);
+    return existingRemote?.url;
   }
 
   public async pushBranchToRemote(branchName: string, remoteName: string) {
-    await this.nodegitRepo.checkoutBranch(branchName);
-    const ngRemote = await this.nodegitRepo.getRemote(remoteName);
-    ngRemote.push([branchName]);
+    await plugins.isomorphicGit.push({
+      fs: this.smartgitRef.envDeps.fs,
+      http: this.smartgitRef.envDeps.http,
+      ref: branchName,
+      remote: remoteName,
+    });
   }
 }

ts/smartgit.classes.smartgit.ts

@@ -0,0 +1,40 @@
+import * as plugins from './smartgit.plugins.js';
+import { GitRepo } from './smartgit.classes.gitrepo.js';
+
+export class Smartgit {
+  public smartenvInstance = new plugins.smartenv.Smartenv();
+  public envDeps: {
+    fs: any;
+    http: any;
+  } = {
+    fs: null,
+    http: null,
+  };
+
+  constructor() {}
+
+  public async init() {
+    if (this.smartenvInstance.isNode) {
+      this.envDeps.fs = await this.smartenvInstance.getSafeNodeModule('fs');
+      this.envDeps.http = await this.smartenvInstance.getSafeNodeModule(
+        'isomorphic-git/http/node/index.js'
+      );
+    } else {
+      throw new Error('currently only node.js is supported.');
+    }
+  }
+
+  public async createRepoByClone(fromUrlArg: string, toDirArg: string) {
+    const repo = await GitRepo.fromCloningIntoDir(this, fromUrlArg, toDirArg);
+  }
+
+  public async createRepoByInit(dirArg: string) {
+    const repo = await GitRepo.fromCreatingRepoInDir(this, dirArg);
+    return repo;
+  }
+
+  public async createRepoByOpen(dirArg: string) {
+    const repo = await GitRepo.fromOpeningRepoDir(this, dirArg);
+    return repo;
+  }
+}

ts/smartgit.plugins.ts

@@ -3,14 +3,15 @@ import * as path from 'path';
 
 export { path };
 
+import * as smartenv from '@pushrocks/smartenv';
 import * as smartfile from '@pushrocks/smartfile';
 import * as smartpath from '@pushrocks/smartpath';
 import * as smartpromise from '@pushrocks/smartpromise';
 import * as smartstring from '@pushrocks/smartstring';
 
-export { smartfile, smartpath, smartpromise, smartstring };
+export { smartenv, smartfile, smartpath, smartpromise, smartstring };
 
 // third party
-import nodegit from 'nodegit';
+import isomorphicGit from 'isomorphic-git';
 
-export { nodegit };
+export { isomorphicGit };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

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"
-}