5.0.7

.gitignore

@@ -1,3 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
 node_modules/
-.settings/
+
-.idea/
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -0,0 +1,141 @@
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
+
+stages:
+  - security
+  - test
+  - 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
+  script:
+    - npmci npm prepare
+    - 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
+  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
+# ====================
+
+testStable:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - docker
+
+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 stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+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:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install stable
+    - npmci npm prepare
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true

.travis.yml

@@ -1,19 +0,0 @@
-language: node_js
-before_install:
-  - nvm install stable
-  - node -v
-  - npm -v
-  - npm install -g gulp
-  - npm install gulp
-  - npm install gulp-typescript
-deploy:
-  provider: npm
-  email: npm@smart-coordination.com
-  api_key:
-    secure: hfuRCg2RSNTvSe49w+rqx/fPt2OILDTjdYkga5BnGr0Rja5yL/2SpVNOP62lYNQBB61TfqfT8F4gQsQyAuygzhNT1ijZ4qCvSdqHqXki/0hzTVZAvfF2aoLxUnuCMAYawUyx5nibJKCmGXvH9MbMrEwV5Gh0uSf0HRmskp/GKuXw5epnMkOT2SEr9Mw7Hpu3VKLEALoKOI2hYBRv555sRFkI3Cd9v1n0384HEjCbQEwXhPwwki2XL2SXzGP8IOccE3xLK9zsQO2RDCqaKpIsK682ZtrvyqxmAJaivtO6VImkpBXcKniYOqJR6sWrsw5345er/iSSr30fgjw4I6LNyUcmF59Uw/dPAElvLN6jU6zxg/+GHM7xqz/J/HV3rlE4d20/9ZJB9IIm2761c3T7DraBMbA7ehj1lolTvCq1vx8oGbNEhkTVBj06V3ltdMPHMiNbeG2Tqs50h/lOgRy5+oqZ8ULWayWX1KXloM3LlddXJnnB31LzHbZUZw7m+q8QnfBlPCWuLd1JfluFrszr1YAR6YPciL9grBNV7beG+8wbh2G0gfMdCHZOzhDmoEHgt/y8liV0QdsFH6QLlEwt8UMPeZ8IO0sNYx5A2ffznZIzy9xEDmMySwl8J3/EdQxhS6FGrm000lu4BH+c2dVlCn/5va9fJLD+m6seSN8Yy40=
-  on:
-    tags: true
-    repo: pushrocks/smartpath
-notifications:
-  slack:
-    secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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,2 +0,0 @@
-# smartpath
-offers smart ways to handle paths

index.js

@@ -1,19 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var path = require("path");
-var bl = require("beautylog");
-/**
- *
- * @type {{getPath: (function(any): undefined)}}
- */
-var smartpath = {
-    getAbsPath: function (varPath, logBool) {
-        if (logBool === void 0) { logBool = false; }
-        var absPath = path.resolve(varPath);
-        if (logBool == true) {
-            bl.log('varPath is' + varPath);
-            bl.log('absPath is' + absPath);
-        }
-        return absPath;
-    }
-};
-module.exports = smartpath;

license

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Push.Rocks
+Copyright (c) 2015 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

npmextra.json

@@ -0,0 +1,16 @@
+{
+  "npmci": {
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "push.rocks",
+      "gitrepo": "smartpath",
+      "description": "offers smart ways to handle paths",
+      "npmPackagename": "@push.rocks/smartpath",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,10 +1,14 @@
 {
-  "name": "smartpath",
+  "name": "@push.rocks/smartpath",
-  "version": "1.0.2",
+  "version": "5.0.7",
+  "private": false,
   "description": "offers smart ways to handle paths",
-  "main": "index.js",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "cd ts/compile && gulp"
+    "test": "(tstest test)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -15,11 +19,32 @@
     "jade",
     "template"
   ],
-  "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
+  "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/pushrocks/smartpath/issues"
   },
   "homepage": "https://github.com/pushrocks/smartpath",
-  "dependencies": {}
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.56",
+    "@gitzone/tsrun": "^1.2.31",
+    "@gitzone/tstest": "^1.0.69",
+    "@pushrocks/tapbundle": "^5.0.2",
+    "@types/node": "^17.0.21"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,45 @@
+# @pushrocks/smartpath
+offers smart ways to handle paths
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpath)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartpath)
+* [github.com (source mirror)](https://github.com/pushrocks/smartpath)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartpath/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartpath/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartpath/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartpath)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartpath)](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/smartpath)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartpath)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartpath)](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.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.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

@@ -0,0 +1,66 @@
+import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
+import * as smartpath from '../ts/index.js';
+
+let mySmartpath: smartpath.Smartpath;
+tap.test('expect create a valid instance', async () => {
+  mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
+  expect(mySmartpath).toBeInstanceOf(smartpath.Smartpath);
+  expect(mySmartpath.pathLevelsBackwards.length === 5).toBeTrue();
+});
+
+let filePathString = './somedir/somefile.json';
+let dirPathString = './somedir/anotherdir';
+let dirPathString2 = './somedir/another.dir/';
+
+tap.test('expect be true for a file path', async () => {
+  expect(smartpath.check.isFile(filePathString)).toBeTrue();
+});
+tap.test('expect be false for a directory path', async () => {
+  expect(smartpath.check.isFile(dirPathString)).toBeFalse();
+  expect(smartpath.check.isFile(dirPathString2)).toBeFalse();
+});
+
+tap.test('expect be true for a directory path', async () => {
+  expect(smartpath.check.isDir(dirPathString)).toBeTrue();
+
+  expect(smartpath.check.isDir(dirPathString2)).toBeTrue();
+});
+
+tap.test('expect be false for a file path', async () => {
+  expect(smartpath.check.isDir(filePathString)).toBeFalse();
+});
+
+let baseString = '/basedir';
+let relativeString = 'somedir/somefile.txt';
+let relativeString2 = 'anotherdir/anotherfile.txt';
+let relativeArray = [relativeString, relativeString, relativeString2];
+tap.test('expect make a string absolute', async () => {
+  expect(smartpath.transform.toAbsolute(relativeString)).toStartWith('/');
+  expect(smartpath.transform.toAbsolute(relativeString)).toEndWith(relativeString);
+  expect(smartpath.transform.toAbsolute(relativeString, baseString)).toEqual(
+    '/basedir/somedir/somefile.txt'
+  );
+});
+tap.test('expect make an array of relative Strings an Array of absolute Strings', async () => {
+  let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString);
+  expect(absoluteArray[2]).toStartWith('/');
+  expect(absoluteArray[2]).toEndWith(relativeString2);
+});
+
+tap.test("expect return 'url' for an URL", async () => {
+  expect(smartpath.get.type('https://push.rocks/some/url')).toEqual('url');
+  expect(smartpath.get.type('https://push.rocks/some/url')).not.toEqual('local');
+});
+tap.test("expect return 'path' for a Path", async () => {
+  expect(smartpath.get.type('/some/absolute/path/')).toEqual('local');
+  expect(smartpath.get.type('./some/relative/path/')).not.toEqual('url');
+});
+
+tap.test('expect a absolute path for an home relative URL', async () => {
+  console.log(smartpath.get.home('~/test'));
+});
+tap.test('expect return the home directory path when no argument is specified', async () => {
+  console.log(smartpath.get.home());
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@push.rocks/smartpath',
+  version: '5.0.7',
+  description: 'offers smart ways to handle paths'
+}

ts/compile/compile.sh

@@ -1,2 +0,0 @@
-nvm use v0.12.7
-gulp

ts/compile/gulpfile.js

@@ -1,16 +0,0 @@
-// import gulp
-var gulp = require("gulp"),
-	gulpTypescript = require("gulp-typescript");
-
-gulp.task('compileTS', function() {
-	var stream = gulp.src('../index.ts')
-	  .pipe(gulpTypescript({
-	  	out: "index.js"
-	  }))
-	  .pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('default',['compileTS'], function() {
-	console.log('Typescript compiled');
-});

ts/compile/readme.md

@@ -1,2 +0,0 @@
-# How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.

ts/index.ts

@@ -1,22 +1,8 @@
-/// <reference path="typings/tsd.d.ts" />
+// import modules
+import * as check from './smartpath.check.js';
+import * as get from './smartpath.get.js';
+import * as transform from './smartpath.transform.js';
 
-var path = require("path");
+export { check, get, transform };
-var bl = require("beautylog");
 
-/**
+export * from './smartpath.classes.smartpath.js';
- *
- * @type {{getPath: (function(any): undefined)}}
- */
-var smartpath:any = {
-    getAbsPath: function(varPath,logBool = false) {
-        var absPath = path.resolve(varPath);
-        if (logBool == true) {
-            bl.log('varPath is' + varPath);
-            bl.log('absPath is' + absPath);
-        }
-        return absPath;
-    }
-};
-
-
-module.exports = smartpath;

ts/smartpath.check.ts

@@ -0,0 +1,9 @@
+import * as plugins from './smartpath.plugins.js';
+
+export let isDir = function (pathArg: string) {
+  return !isFile(pathArg);
+};
+
+export let isFile = function (pathArg) {
+  return /\.[a-zA-Z]*$/.test(pathArg); // checks if there is a .anything at the end
+};

ts/smartpath.classes.smartpath.ts

@@ -0,0 +1,15 @@
+import * as plugins from './smartpath.plugins.js';
+import * as getMod from './smartpath.get.js';
+
+export class Smartpath {
+  originalPath: string;
+  type: getMod.TPathType;
+  pathLevels: string[];
+  pathLevelsBackwards: string[];
+  constructor(pathArg: string) {
+    this.originalPath = pathArg;
+    this.type = getMod.type(this.originalPath);
+    this.pathLevels = getMod.pathLevels(this.originalPath);
+    this.pathLevelsBackwards = getMod.pathLevelsBackwards(this.originalPath);
+  }
+}

ts/smartpath.get.ts

@@ -0,0 +1,48 @@
+import * as plugins from './smartpath.plugins.js';
+export type TPathType = 'url' | 'local';
+
+/**
+ * returns the type of the given path. Can be "url" or "local"
+ */
+export const type = (pathStringArg: string): TPathType => {
+  const urlRegex = /http[s|\s]:\/\/.*/i;
+  if (urlRegex.exec(pathStringArg)) {
+    return 'url';
+  } else {
+    return 'local';
+  }
+};
+
+/**
+ * gets the dirname from import.meta.url
+ */
+export const dirnameFromImportMetaUrl = (importMetaUrlArg: string) => {
+  return plugins.path.dirname(plugins.url.fileURLToPath(importMetaUrlArg));
+};
+
+/**
+ * returns homedir as absolute path
+ * @param pathArgument if a pathargument is given, ~ is being replaced with the homedir
+ * @returns
+ */
+export const home = (pathArgument?: string) => {
+  if (pathArgument) {
+    return pathArgument.replace('~', plugins.os.homedir());
+  } else {
+    return plugins.os.homedir();
+  }
+};
+
+export type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx';
+
+export const pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
+  let pathLevelArray: string[];
+  if (systemArg === 'dynamic') {
+    pathLevelArray = pathArg.split(plugins.path.sep);
+  }
+  return pathLevelArray;
+};
+
+export const pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
+  return pathLevels(pathArg, systemArg).reverse();
+};

ts/smartpath.plugins.ts

@@ -0,0 +1,5 @@
+import * as os from 'os';
+import * as path from 'path';
+import * as url from 'url';
+
+export { os, path, url };

ts/smartpath.transform.ts

@@ -0,0 +1,41 @@
+import * as plugins from './smartpath.plugins.js';
+
+/* ------------------------------------------ *
+ * ------------ helpers --------------------- *
+ * ------------------------------------------ */
+
+// checks a file
+export const makeAbsolute = (localPathArg: string, baseArg?: string): string => {
+  let absolutePath: string;
+  let alreadyAbsolute = plugins.path.isAbsolute(localPathArg);
+  if (baseArg && !alreadyAbsolute) {
+    absolutePath = plugins.path.join(baseArg, localPathArg);
+  } else if (!alreadyAbsolute) {
+    absolutePath = plugins.path.resolve(localPathArg);
+  } else {
+    absolutePath = localPathArg;
+  }
+  return absolutePath;
+};
+
+/* ------------------------------------------ *
+ * ------- export functions ----------------- *
+ * ------------------------------------------ */
+export const toAbsolute =  (relativeArg: string | string[], baseArg?: string): string | string[] => {
+  if (typeof relativeArg === 'string') {
+    return makeAbsolute(relativeArg, baseArg);
+  } else if (Array.isArray(relativeArg)) {
+    let relativeArray = relativeArg;
+    let absoluteArray: string[] = [];
+    for (let key in relativeArray) {
+      absoluteArray.push(makeAbsolute(relativeArray[key], baseArg));
+    }
+    return absoluteArray;
+  } else {
+    console.error(
+      'smartpath.absolute() could not make sense of the input. ' +
+        'Input is neither String nor Array'
+    );
+    return null;
+  }
+};

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="node/node.d.ts" />