5.0.1

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
   - release
   - metadata
 
+before_script:
+  - npm install -g @shipzone/npmci
+
 # ====================
 # security stage
 # ====================
@@ -19,23 +22,36 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+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
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +66,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +77,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +97,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

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

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

npmextra.json

@@ -1,8 +1,5 @@
 {
   "npmci": {
-    "npmGlobalTools": [
-      "@gitzone/npmts"
-    ],
     "npmAccessLevel": "public"
   },
   "gitzone": {
@@ -11,7 +8,7 @@
       "githost": "gitlab.com",
       "gitscope": "pushrocks",
       "gitrepo": "smartpath",
-      "shortDescription": "offers smart ways to handle paths",
+      "description": "offers smart ways to handle paths",
       "npmPackagename": "@pushrocks/smartpath",
       "license": "MIT"
     }

package.json

@@ -1,10 +1,11 @@
 {
   "name": "@pushrocks/smartpath",
-  "version": "4.0.2",
+  "version": "5.0.1",
   "private": false,
   "description": "offers smart ways to handle paths",
   "main": "dist_ts/index.js",
   "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test)",
     "build": "(tsbuild)"
@@ -24,13 +25,12 @@
     "url": "https://github.com/pushrocks/smartpath/issues"
   },
   "homepage": "https://github.com/pushrocks/smartpath",
-  "dependencies": {},
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^10.5.2"
+    "@gitzone/tsbuild": "^2.1.48",
+    "@gitzone/tsrun": "^1.2.31",
+    "@gitzone/tstest": "^1.0.67",
+    "@pushrocks/tapbundle": "^5.0.2",
+    "@types/node": "^17.0.21"
   },
   "files": [
     "ts/**/*",
@@ -43,5 +43,8 @@
     "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

@@ -1,11 +1,11 @@
-import { tap, expect } from '@pushrocks/tapbundle';
-import * as smartpath from '../ts/index';
+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).to.be.instanceof(smartpath.Smartpath);
-  expect(mySmartpath.pathLevelsBackwards).to.be.of.length(5);
+  expect(mySmartpath).toBeInstanceOf(smartpath.Smartpath);
+  expect(mySmartpath.pathLevelsBackwards.length === 5).toBeTrue();
 });
 
 let filePathString = './somedir/somefile.json';
@@ -13,21 +13,21 @@ let dirPathString = './somedir/anotherdir';
 let dirPathString2 = './somedir/another.dir/';
 
 tap.test('expect be true for a file path', async () => {
-  expect(smartpath.check.isFile(filePathString)).to.be.true;
+  expect(smartpath.check.isFile(filePathString)).toBeTrue();
 });
 tap.test('expect be false for a directory path', async () => {
-  expect(smartpath.check.isFile(dirPathString)).to.be.false;
-  expect(smartpath.check.isFile(dirPathString2)).to.be.false;
+  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)).to.be.true;
+  expect(smartpath.check.isDir(dirPathString)).toBeTrue();
 
-  expect(smartpath.check.isDir(dirPathString2)).to.be.true;
+  expect(smartpath.check.isDir(dirPathString2)).toBeTrue();
 });
 
 tap.test('expect be false for a file path', async () => {
-  expect(smartpath.check.isDir(filePathString)).to.be.false;
+  expect(smartpath.check.isDir(filePathString)).toBeFalse();
 });
 
 let baseString = '/basedir';
@@ -35,25 +35,25 @@ 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)).startWith('/');
-  expect(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString);
-  expect(smartpath.transform.toAbsolute(relativeString, baseString)).equal(
+  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]).to.startWith('/');
-  expect(absoluteArray[2]).endWith(relativeString2);
+  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')).equal('url');
-  expect(smartpath.get.type('https://push.rocks/some/url')).not.equal('local');
+  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/')).equal('local');
-  expect(smartpath.get.type('./some/relative/path/')).not.equal('url');
+  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 () => {

ts/index.ts

@@ -1,8 +1,8 @@
 // import modules
-import * as check from './smartpath.check';
-import * as get from './smartpath.get';
-import * as transform from './smartpath.transform';
+import * as check from './smartpath.check.js';
+import * as get from './smartpath.get.js';
+import * as transform from './smartpath.transform.js';
 
 export { check, get, transform };
 
-export * from './smartpath.classes.smartpath';
+export * from './smartpath.classes.smartpath.js';

ts/smartpath.check.ts

@@ -1,9 +1,9 @@
-import plugins = require('./smartpath.plugins');
+import * as plugins from './smartpath.plugins.js';
 
-export let isDir = function(pathArg: string) {
+export let isDir = function (pathArg: string) {
   return !isFile(pathArg);
 };
 
-export let isFile = function(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

@@ -1,5 +1,5 @@
-import * as plugins from './smartpath.plugins';
-import * as getMod from './smartpath.get';
+import * as plugins from './smartpath.plugins.js';
+import * as getMod from './smartpath.get.js';
 
 export class Smartpath {
   originalPath: string;

ts/smartpath.get.ts

@@ -1,11 +1,11 @@
-import plugins = require('./smartpath.plugins');
+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 let type = function(pathStringArg: string): TPathType {
-  let urlRegex = /http[s|\s]:\/\/.*/i;
+export const type = (pathStringArg: string): TPathType => {
+  const urlRegex = /http[s|\s]:\/\/.*/i;
   if (urlRegex.exec(pathStringArg)) {
     return 'url';
   } else {
@@ -13,7 +13,19 @@ export let type = function(pathStringArg: string): TPathType {
   }
 };
 
-export let home = function(pathArgument?: string) {
+/**
+ * gets the dirname from import.meta.url
+ */
+export const getDirnameFromImportMetaUrl = (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 {
@@ -23,7 +35,7 @@ export let home = function(pathArgument?: string) {
 
 export type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx';
 
-export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
+export const pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
   let pathLevelArray: string[];
   if (systemArg === 'dynamic') {
     pathLevelArray = pathArg.split(plugins.path.sep);
@@ -31,6 +43,6 @@ export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') =>
   return pathLevelArray;
 };
 
-export let pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
+export const pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
   return pathLevels(pathArg, systemArg).reverse();
 };

ts/smartpath.plugins.ts

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

ts/smartpath.transform.ts

@@ -1,11 +1,11 @@
-import plugins = require('./smartpath.plugins');
+import * as plugins from './smartpath.plugins.js';
 
 /* ------------------------------------------ *
  * ------------ helpers --------------------- *
  * ------------------------------------------ */
 
 // checks a file
-let makeAbsolute = function(localPathArg: string, baseArg?: string): string {
+let makeAbsolute = function (localPathArg: string, baseArg?: string): string {
   let absolutePath: string;
   let alreadyAbsolute = plugins.path.isAbsolute(localPathArg);
   if (baseArg && !alreadyAbsolute) {
@@ -21,7 +21,7 @@ let makeAbsolute = function(localPathArg: string, baseArg?: string): string {
 /* ------------------------------------------ *
  * ------- export functions ----------------- *
  * ------------------------------------------ */
-export let toAbsolute = function(relativeArg: string | string[], baseArg?: string): any {
+export let toAbsolute = function (relativeArg: string | string[], baseArg?: string): any {
   if (typeof relativeArg === 'string') {
     return makeAbsolute(relativeArg, baseArg);
   } else if (Array.isArray(relativeArg)) {

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