Compare commits

..

13 Commits

Author SHA1 Message Date
5245e50f3d 5.0.0 2022-03-14 13:27:15 +01:00
00bb39b8fe 4.0.4 2022-03-14 13:26:48 +01:00
ddfae30a18 fix(core): update 2022-03-14 13:26:48 +01:00
618b3da86e 4.0.3 2020-04-13 18:10:05 +00:00
482bc6c18e fix(core): update 2020-04-13 18:10:05 +00:00
ac988b9b09 4.0.2 2020-04-13 17:30:49 +00:00
0b6c83a806 fix(core): update 2020-04-13 17:30:49 +00:00
37cbf0f8c8 4.0.1 2018-07-21 23:33:54 +02:00
29decabf91 fix(dependencies): remove obsolete imports of typings-global 2018-07-21 23:33:54 +02:00
afcb5d5b0c 4.0.0 2018-07-21 23:26:11 +02:00
53905df003 BREAKING CHANGE(package): change scope 2018-07-21 23:26:11 +02:00
09d424e972 3.2.8 2017-02-19 03:29:58 +01:00
f66864d0af update to support latest deps 2017-02-19 03:29:54 +01:00
35 changed files with 18720 additions and 483 deletions

20
.gitignore vendored
View File

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

View File

@ -1,33 +1,141 @@
image: hosttoday/ht-docker-node:npmts
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- test
- release
testLEGACY:
stage: test
- security
- test
- release
- metadata
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci test legacy
tags:
- docker
allow_failure: true
testLTS:
stage: test
script:
- npmci test lts
tags:
- docker
testSTABLE:
stage: test
script:
- npmci test stable
tags:
- docker
release:
stage: release
environment: npm_registry
script:
- npmci publish
- 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 lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

View File

@ -1,4 +0,0 @@
docs/
coverage/
ts/
test/

11
.vscode/launch.json vendored Normal file
View File

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

26
.vscode/settings.json vendored Normal file
View File

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

View File

@ -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

View File

@ -1,24 +0,0 @@
# smartpath
offers smart ways to handle paths
## Availabililty
[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartpath)
[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/smartpath)
[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartpath)
[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartpath/)
## Status for master
[![build status](https://GitLab.com/pushrocks/smartpath/badges/master/build.svg)](https://GitLab.com/pushrocks/smartpath/commits/master)
[![coverage report](https://GitLab.com/pushrocks/smartpath/badges/master/coverage.svg)](https://GitLab.com/pushrocks/smartpath/commits/master)
[![npm downloads per month](https://img.shields.io/npm/dm/smartpath.svg)](https://www.npmjs.com/package/smartpath)
[![Dependency Status](https://david-dm.org/pushrocks/smartpath.svg)](https://david-dm.org/pushrocks/smartpath)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartpath/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartpath/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartpath/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartpath)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
## Usage
Use TypeScript for best in class instellisense.
[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

5
dist/index.d.ts vendored
View File

@ -1,5 +0,0 @@
import check = require('./smartpath.check');
import get = require('./smartpath.get');
import transform = require('./smartpath.transform');
export { check, get, transform };
export * from './smartpath.classes.smartpath';

13
dist/index.js vendored
View File

@ -1,13 +0,0 @@
"use strict";
function __export(m) {
for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
}
// import modules
const check = require("./smartpath.check");
exports.check = check;
const get = require("./smartpath.get");
exports.get = get;
const transform = require("./smartpath.transform");
exports.transform = transform;
__export(require("./smartpath.classes.smartpath"));
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7O0FBQUEsaUJBQWlCO0FBQ2pCLDJDQUEyQztBQU12QyxzQkFBSztBQUxULHVDQUF1QztBQU1uQyxrQkFBRztBQUxQLG1EQUFtRDtBQU0vQyw4QkFBUztBQUdiLG1EQUE2QyJ9

View File

@ -1,3 +0,0 @@
import 'typings-global';
export declare let isDir: (pathArg: string) => boolean;
export declare let isFile: (pathArg: any) => boolean;

View File

@ -1,9 +0,0 @@
"use strict";
require("typings-global");
exports.isDir = function (pathArg) {
return !exports.isFile(pathArg);
};
exports.isFile = function (pathArg) {
return /\.[a-zA-Z]*$/.test(pathArg); // checks if there is a .anything at the end
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRwYXRoLmNoZWNrLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRwYXRoLmNoZWNrLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBdUI7QUFHWixRQUFBLEtBQUssR0FBRyxVQUFTLE9BQWU7SUFDdkMsTUFBTSxDQUFDLENBQUMsY0FBTSxDQUFDLE9BQU8sQ0FBQyxDQUFBO0FBQzNCLENBQUMsQ0FBQTtBQUVVLFFBQUEsTUFBTSxHQUFHLFVBQVMsT0FBTztJQUNoQyxNQUFNLENBQUMsY0FBYyxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQSxDQUFDLDRDQUE0QztBQUNwRixDQUFDLENBQUEifQ==

View File

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

View File

@ -1,12 +0,0 @@
"use strict";
const getMod = require("./smartpath.get");
class Smartpath {
constructor(pathArg) {
this.originalPath = pathArg;
this.type = getMod.type(this.originalPath);
this.pathLevels = getMod.pathLevels(this.originalPath);
this.pathLevelsBackwards = getMod.pathLevelsBackwards(this.originalPath);
}
}
exports.Smartpath = Smartpath;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRwYXRoLmNsYXNzZXMuc21hcnRwYXRoLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvc21hcnRwYXRoLmNsYXNzZXMuc21hcnRwYXRoLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFDQSwwQ0FBeUM7QUFFekM7SUFLSSxZQUFZLE9BQWU7UUFDdkIsSUFBSSxDQUFDLFlBQVksR0FBRyxPQUFPLENBQUE7UUFDM0IsSUFBSSxDQUFDLElBQUksR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxZQUFZLENBQUMsQ0FBQTtRQUMxQyxJQUFJLENBQUMsVUFBVSxHQUFHLE1BQU0sQ0FBQyxVQUFVLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFBO1FBQ3RELElBQUksQ0FBQyxtQkFBbUIsR0FBRyxNQUFNLENBQUMsbUJBQW1CLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQzVFLENBQUM7Q0FDSjtBQVhELDhCQVdDIn0=

View File

@ -1,9 +0,0 @@
export declare type TPathType = 'url' | 'local';
/**
* returns the type of the given path. Can be "url" or "local"
*/
export declare let type: (pathStringArg: string) => TPathType;
export declare let home: (pathArgument?: string) => any;
export declare type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx';
export declare let pathLevels: (pathArg: string, systemArg?: TSystemArg) => string[];
export declare let pathLevelsBackwards: (pathArg: string, systemArg?: TSystemArg) => string[];

34
dist/smartpath.get.js vendored
View File

@ -1,34 +0,0 @@
"use strict";
const plugins = require("./smartpath.plugins");
/**
* returns the type of the given path. Can be "url" or "local"
*/
exports.type = function (pathStringArg) {
let urlRegex = /http[s|\s]:\/\/.*/i;
if (urlRegex.exec(pathStringArg)) {
return 'url';
}
else {
return 'local';
}
;
};
exports.home = function (pathArgument) {
if (pathArgument) {
return plugins.home.resolve(pathArgument);
}
else {
return plugins.home();
}
};
exports.pathLevels = (pathArg, systemArg = 'dynamic') => {
let pathLevelArray;
if (systemArg === 'dynamic') {
pathLevelArray = pathArg.split(plugins.path.sep);
}
return pathLevelArray;
};
exports.pathLevelsBackwards = (pathArg, systemArg) => {
return exports.pathLevels(pathArg, systemArg).reverse();
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRwYXRoLmdldC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0cGF0aC5nZXQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLCtDQUErQztBQUcvQzs7R0FFRztBQUNRLFFBQUEsSUFBSSxHQUFHLFVBQVUsYUFBcUI7SUFDN0MsSUFBSSxRQUFRLEdBQUcsb0JBQW9CLENBQUE7SUFDbkMsRUFBRSxDQUFDLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxhQUFhLENBQUMsQ0FBQyxDQUFDLENBQUM7UUFDL0IsTUFBTSxDQUFDLEtBQUssQ0FBQTtJQUNoQixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixNQUFNLENBQUMsT0FBTyxDQUFBO0lBQ2xCLENBQUM7SUFBQSxDQUFDO0FBQ04sQ0FBQyxDQUFBO0FBRVUsUUFBQSxJQUFJLEdBQUcsVUFBVSxZQUFxQjtJQUM3QyxFQUFFLENBQUMsQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDO1FBQ2YsTUFBTSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQzdDLENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLE1BQU0sQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLENBQUE7SUFDekIsQ0FBQztBQUNMLENBQUMsQ0FBQTtBQUlVLFFBQUEsVUFBVSxHQUFHLENBQUMsT0FBZSxFQUFFLFlBQXdCLFNBQVM7SUFDdkUsSUFBSSxjQUF3QixDQUFBO0lBQzVCLEVBQUUsQ0FBQyxDQUFDLFNBQVMsS0FBSyxTQUFTLENBQUMsQ0FBQyxDQUFDO1FBQzFCLGNBQWMsR0FBRyxPQUFPLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUE7SUFDcEQsQ0FBQztJQUNELE1BQU0sQ0FBQyxjQUFjLENBQUE7QUFDekIsQ0FBQyxDQUFBO0FBRVUsUUFBQSxtQkFBbUIsR0FBRyxDQUFDLE9BQWUsRUFBRSxTQUFzQjtJQUNyRSxNQUFNLENBQUMsa0JBQVUsQ0FBQyxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUMsT0FBTyxFQUFFLENBQUE7QUFDbkQsQ0FBQyxDQUFBIn0=

View File

@ -1,3 +0,0 @@
import 'typings-global';
export declare var home: any;
export import path = require('path');

View File

@ -1,5 +0,0 @@
"use strict";
require("typings-global");
exports.home = require('home');
exports.path = require("path");
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRwYXRoLnBsdWdpbnMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9zbWFydHBhdGgucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMEJBQXVCO0FBQ1osUUFBQSxJQUFJLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxDQUFBO0FBQ2pDLCtCQUFvQyJ9

View File

@ -1,2 +0,0 @@
import 'typings-global';
export declare let toAbsolute: (relativeArg: string | string[], baseArg?: string) => any;

View File

@ -1,43 +0,0 @@
"use strict";
require("typings-global");
const plugins = require("./smartpath.plugins");
/* ------------------------------------------ *
* ------------ helpers --------------------- *
* ------------------------------------------ */
// checks a file
let makeAbsolute = function (localPathArg, baseArg) {
let absolutePath;
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 ----------------- *
* ------------------------------------------ */
exports.toAbsolute = function (relativeArg, baseArg) {
if (typeof relativeArg === 'string') {
return makeAbsolute(relativeArg, baseArg);
}
else if (Array.isArray(relativeArg)) {
let relativeArray = relativeArg;
let absoluteArray = [];
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 false;
}
};
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRwYXRoLnRyYW5zZm9ybS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0cGF0aC50cmFuc2Zvcm0udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLDBCQUF1QjtBQUN2QiwrQ0FBK0M7QUFFL0M7O2dEQUVnRDtBQUVoRCxpQkFBaUI7QUFDakIsSUFBSSxZQUFZLEdBQUcsVUFBUyxZQUFvQixFQUFFLE9BQWdCO0lBQzlELElBQUksWUFBb0IsQ0FBQTtJQUN4QixJQUFJLGVBQWUsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxZQUFZLENBQUMsQ0FBQTtJQUMzRCxFQUFFLENBQUMsQ0FBQyxPQUFPLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQyxDQUFDO1FBQzlCLFlBQVksR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxPQUFPLEVBQUMsWUFBWSxDQUFDLENBQUE7SUFDMUQsQ0FBQztJQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxDQUFDLGVBQWUsQ0FBQyxDQUFDLENBQUM7UUFDekIsWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFBO0lBQ3RELENBQUM7SUFBQyxJQUFJLENBQUMsQ0FBQztRQUNKLFlBQVksR0FBRyxZQUFZLENBQUE7SUFDL0IsQ0FBQztJQUNELE1BQU0sQ0FBQyxZQUFZLENBQUE7QUFDdkIsQ0FBQyxDQUFBO0FBRUQ7O2dEQUVnRDtBQUNyQyxRQUFBLFVBQVUsR0FBRyxVQUFTLFdBQThCLEVBQUUsT0FBZ0I7SUFDN0UsRUFBRSxDQUFDLENBQUMsT0FBTyxXQUFXLEtBQUssUUFBUSxDQUFDLENBQUMsQ0FBQztRQUNsQyxNQUFNLENBQUMsWUFBWSxDQUFDLFdBQVcsRUFBQyxPQUFPLENBQUMsQ0FBQTtJQUM1QyxDQUFDO0lBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsV0FBVyxDQUFDLENBQUMsQ0FBQyxDQUFDO1FBQ3BDLElBQUksYUFBYSxHQUFHLFdBQVcsQ0FBQTtRQUMvQixJQUFJLGFBQWEsR0FBYSxFQUFFLENBQUE7UUFDaEMsR0FBRyxDQUFDLENBQUMsSUFBSSxHQUFHLElBQUksYUFBYSxDQUFDLENBQUMsQ0FBQztZQUM1QixhQUFhLENBQUMsSUFBSSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsR0FBRyxDQUFDLEVBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQTtRQUNoRSxDQUFDO1FBQ0QsTUFBTSxDQUFDLGFBQWEsQ0FBQTtJQUN4QixDQUFDO0lBQUMsSUFBSSxDQUFDLENBQUM7UUFDSixPQUFPLENBQUMsS0FBSyxDQUFDLDBEQUEwRDtZQUNwRSxtQ0FBbUMsQ0FBQyxDQUFBO1FBQ3hDLE1BQU0sQ0FBQyxLQUFLLENBQUE7SUFDaEIsQ0FBQztBQUNMLENBQUMsQ0FBQSJ9

16
npmextra.json Normal file
View File

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

View File

@ -1,4 +0,0 @@
{
"mode": "default",
"coveralls": "true"
}

18276
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,11 +1,14 @@
{
"name": "smartpath",
"version": "3.2.7",
"name": "@pushrocks/smartpath",
"version": "5.0.0",
"private": false,
"description": "offers smart ways to handle paths",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": {
"test": "(npmts)"
"test": "(tstest test)",
"build": "(tsbuild)"
},
"repository": {
"type": "git",
@ -22,14 +25,26 @@
"url": "https://github.com/pushrocks/smartpath/issues"
},
"homepage": "https://github.com/pushrocks/smartpath",
"dependencies": {
"home": "^1.0.1",
"typings-global": "^1.0.14"
},
"devDependencies": {
"@types/should": "^8.1.30",
"npmts-g": "^5.2.10",
"should": "^11.1.1",
"typings-test": "^1.0.3"
}
"@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/**/*",
"ts_web/**/*",
"dist/**/*",
"dist_*/**/*",
"dist_ts/**/*",
"dist_ts_web/**/*",
"assets/**/*",
"cli.js",
"npmextra.json",
"readme.md"
],
"browserslist": [
"last 1 chrome versions"
]
}

45
readme.md Normal file
View File

@ -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)

1
test/test.d.ts vendored
View File

@ -1 +0,0 @@
import 'typings-test';

View File

@ -1,79 +0,0 @@
"use strict";
require("typings-test");
const should = require("should");
const smartpath = require("../dist/index.js");
describe('smartpath', function () {
describe('class Smartpath', function () {
let mySmartpath;
it('should create a valid instance', function () {
mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
should(mySmartpath).be.instanceof(smartpath.Smartpath);
should(mySmartpath.pathLevelsBackwards).be.of.length(5);
});
});
describe('.check', function () {
let filePathString = './somedir/somefile.json';
let dirPathString = './somedir/anotherdir';
let dirPathString2 = './somedir/another.dir/';
describe('.isFile', function () {
it('should be true for a file path', function () {
should(smartpath.check.isFile(filePathString)).be.true();
});
it('should be false for a directory path', function () {
should(smartpath.check.isFile(dirPathString)).be.false();
should(smartpath.check.isFile(dirPathString2)).be.false();
});
});
describe('.isDir', function () {
it('should be true for a directory path', function () {
should(smartpath.check.isDir(dirPathString)).be.true();
should(smartpath.check.isDir(dirPathString2)).be.true();
});
it('should be false for a file path', function () {
should(smartpath.check.isDir(filePathString)).be.false();
});
});
});
describe('.transform', function () {
describe('toAbsolute()', function () {
let baseString = '/basedir';
let relativeString = 'somedir/somefile.txt';
let relativeString2 = 'anotherdir/anotherfile.txt';
let relativeArray = [relativeString, relativeString, relativeString2];
it('should make a string absolute', function () {
should(smartpath.transform.toAbsolute(relativeString)).startWith('/');
should(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString);
should(smartpath.transform.toAbsolute(relativeString, baseString)).equal('/basedir/somedir/somefile.txt');
});
it('should make an array of relative Strings an Array of absolute Strings', function () {
let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString);
should(absoluteArray[2]).startWith('/');
should(absoluteArray[2]).endWith(relativeString2);
});
it('should return false if neither String nor Array', function () {
should(smartpath.transform.toAbsolute(3)).be.false();
});
});
});
describe('.get', function () {
describe('.type()', function () {
it("should return 'url' for an URL", function () {
should(smartpath.get.type('https://push.rocks/some/url')).equal('url');
should(smartpath.get.type('https://push.rocks/some/url')).not.equal('local');
});
it("should return 'path' for a Path", function () {
should(smartpath.get.type('/some/absolute/path/')).equal('local');
should(smartpath.get.type('./some/relative/path/')).not.equal('url');
});
});
describe('.get()', function () {
it('should a absolute path for an home relative URL', function () {
console.log(smartpath.get.home('~/test'));
});
it('should return the home directory path when no argument is specified', function () {
console.log(smartpath.get.home());
});
});
});
});
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQixpQ0FBZ0M7QUFDaEMsOENBQTZDO0FBRTdDLFFBQVEsQ0FBQyxXQUFXLEVBQUU7SUFDbEIsUUFBUSxDQUFDLGlCQUFpQixFQUFFO1FBQ3hCLElBQUksV0FBZ0MsQ0FBQTtRQUNwQyxFQUFFLENBQUMsZ0NBQWdDLEVBQUU7WUFDakMsV0FBVyxHQUFHLElBQUksU0FBUyxDQUFDLFNBQVMsQ0FBQyx5QkFBeUIsQ0FBQyxDQUFBO1lBQ2hFLE1BQU0sQ0FBQyxXQUFXLENBQUMsQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsQ0FBQTtZQUN0RCxNQUFNLENBQUMsV0FBVyxDQUFDLG1CQUFtQixDQUFDLENBQUMsRUFBRSxDQUFDLEVBQUUsQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLENBQUE7UUFDM0QsQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxRQUFRLEVBQUU7UUFDZixJQUFJLGNBQWMsR0FBRyx5QkFBeUIsQ0FBQTtRQUM5QyxJQUFJLGFBQWEsR0FBRyxzQkFBc0IsQ0FBQTtRQUMxQyxJQUFJLGNBQWMsR0FBRyx3QkFBd0IsQ0FBQTtRQUM3QyxRQUFRLENBQUMsU0FBUyxFQUFFO1lBQ2hCLEVBQUUsQ0FBQyxnQ0FBZ0MsRUFBRTtnQkFDakMsTUFBTSxDQUNGLFNBQVMsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxDQUN6QyxDQUFDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsQ0FBQTtZQUNmLENBQUMsQ0FBQyxDQUFBO1lBQ0YsRUFBRSxDQUFDLHNDQUFzQyxFQUFFO2dCQUN2QyxNQUFNLENBQ0YsU0FBUyxDQUFDLEtBQUssQ0FBQyxNQUFNLENBQUMsYUFBYSxDQUFDLENBQ3hDLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFBO2dCQUNaLE1BQU0sQ0FDRixTQUFTLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsQ0FDekMsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7WUFDaEIsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDLENBQUMsQ0FBQTtRQUNGLFFBQVEsQ0FBQyxRQUFRLEVBQUU7WUFDZixFQUFFLENBQUMscUNBQXFDLEVBQUU7Z0JBQ3RDLE1BQU0sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxhQUFhLENBQUMsQ0FDMUMsQ0FBQyxFQUFFLENBQUMsSUFBSSxFQUFFLENBQUE7Z0JBQ1gsTUFBTSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsS0FBSyxDQUFDLGNBQWMsQ0FBQyxDQUMzQyxDQUFDLEVBQUUsQ0FBQyxJQUFJLEVBQUUsQ0FBQTtZQUNmLENBQUMsQ0FBQyxDQUFBO1lBQ0YsRUFBRSxDQUFDLGlDQUFpQyxFQUFFO2dCQUNsQyxNQUFNLENBQ0YsU0FBUyxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsY0FBYyxDQUFDLENBQ3hDLENBQUMsRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFBO1lBQ2hCLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtJQUNGLFFBQVEsQ0FBQyxZQUFZLEVBQUU7UUFDbkIsUUFBUSxDQUFDLGNBQWMsRUFBRTtZQUNyQixJQUFJLFVBQVUsR0FBRyxVQUFVLENBQUE7WUFDM0IsSUFBSSxjQUFjLEdBQUcsc0JBQXNCLENBQUE7WUFDM0MsSUFBSSxlQUFlLEdBQUcsNEJBQTRCLENBQUE7WUFDbEQsSUFBSSxhQUFhLEdBQUcsQ0FBQyxjQUFjLEVBQUUsY0FBYyxFQUFFLGVBQWUsQ0FBQyxDQUFBO1lBQ3JFLEVBQUUsQ0FBQywrQkFBK0IsRUFBRTtnQkFDaEMsTUFBTSxDQUFDLFNBQVMsQ0FBQyxTQUFTLENBQUMsVUFBVSxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxDQUFBO2dCQUNyRSxNQUFNLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsY0FBYyxDQUFDLENBQUE7Z0JBQzlFLE1BQU0sQ0FBQyxTQUFTLENBQUMsU0FBUyxDQUFDLFVBQVUsQ0FBQyxjQUFjLEVBQUUsVUFBVSxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsK0JBQStCLENBQUMsQ0FBQTtZQUM3RyxDQUFDLENBQUMsQ0FBQTtZQUNGLEVBQUUsQ0FBQyx1RUFBdUUsRUFBRTtnQkFDeEUsSUFBSSxhQUFhLEdBQUcsU0FBUyxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsYUFBYSxFQUFFLFVBQVUsQ0FBQyxDQUFBO2dCQUM3RSxNQUFNLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxDQUFBO2dCQUN2QyxNQUFNLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUMsT0FBTyxDQUFDLGVBQWUsQ0FBQyxDQUFBO1lBRXJELENBQUMsQ0FBQyxDQUFBO1lBQ0YsRUFBRSxDQUFDLGlEQUFpRCxFQUFFO2dCQUNsRCxNQUFNLENBQUMsU0FBUyxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUE7WUFDeEQsQ0FBQyxDQUFDLENBQUE7UUFDTixDQUFDLENBQUMsQ0FBQTtJQUNOLENBQUMsQ0FBQyxDQUFBO0lBQ0YsUUFBUSxDQUFDLE1BQU0sRUFBRTtRQUNiLFFBQVEsQ0FBQyxTQUFTLEVBQUU7WUFDaEIsRUFBRSxDQUFDLGdDQUFnQyxFQUFFO2dCQUNqQyxNQUFNLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsNkJBQTZCLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxLQUFLLENBQUMsQ0FBQTtnQkFDdEUsTUFBTSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLDZCQUE2QixDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLE9BQU8sQ0FBQyxDQUFBO1lBQ2hGLENBQUMsQ0FBQyxDQUFBO1lBQ0YsRUFBRSxDQUFDLGlDQUFpQyxFQUFFO2dCQUNsQyxNQUFNLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsc0JBQXNCLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQTtnQkFDakUsTUFBTSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLHVCQUF1QixDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsS0FBSyxDQUFDLEtBQUssQ0FBQyxDQUFBO1lBQ3hFLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQyxDQUFDLENBQUE7UUFDRixRQUFRLENBQUMsUUFBUSxFQUFFO1lBQ2YsRUFBRSxDQUFDLGlEQUFpRCxFQUFFO2dCQUNsRCxPQUFPLENBQUMsR0FBRyxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUE7WUFDN0MsQ0FBQyxDQUFDLENBQUE7WUFDRixFQUFFLENBQUMscUVBQXFFLEVBQUU7Z0JBQ3RFLE9BQU8sQ0FBQyxHQUFHLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxJQUFJLEVBQUUsQ0FBQyxDQUFBO1lBQ3JDLENBQUMsQ0FBQyxDQUFBO1FBQ04sQ0FBQyxDQUFDLENBQUE7SUFDTixDQUFDLENBQUMsQ0FBQTtBQUNOLENBQUMsQ0FBQyxDQUFBIn0=

View File

@ -1 +0,0 @@
{"version":3,"file":"test.js","sourceRoot":"","sources":["test.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,IAAI,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAC/B,IAAI,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAE5C,QAAQ,CAAC,WAAW,EAAC;IACjB,QAAQ,CAAC,YAAY,EAAC;QAClB,QAAQ,CAAC,cAAc,EAAC;YACpB,IAAI,UAAU,GAAG,UAAU,CAAC;YAC5B,IAAI,cAAc,GAAG,sBAAsB,CAAC;YAC5C,IAAI,eAAe,GAAG,4BAA4B,CAAC;YACnD,IAAI,aAAa,GAAG,CAAC,cAAc,EAAC,cAAc,EAAC,eAAe,CAAC,CAAC;YACpE,EAAE,CAAC,+BAA+B,EAAC;gBAC/B,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACrE,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBAC9E,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,cAAc,EAAC,UAAU,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;YAC5G,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,uEAAuE,EAAC;gBACvE,IAAI,aAAa,GAAG,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,aAAa,EAAC,UAAU,CAAC,CAAC;gBAC7E,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;gBACvC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YAErD,CAAC,CAAC,CAAA;YACF,EAAE,CAAC,iDAAiD,EAAC;gBACjD,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC;YACxD,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,MAAM,EAAC;QACZ,QAAQ,CAAC,SAAS,EAAC;YACf,EAAE,CAAC,gCAAgC,EAAC;gBAChC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACtE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAChF,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,iCAAiC,EAAC;gBACjC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACjE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YACxE,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QACH,QAAQ,CAAC,QAAQ,EAAC;YACd,EAAE,CAAC,iDAAiD,EAAC;gBACjD,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;YACH,EAAE,CAAC,qEAAqE,EAAC;gBACrE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACtC,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

View File

@ -1,89 +1,66 @@
import 'typings-test'
import * as should from 'should'
import * as smartpath from '../dist/index.js'
import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
import * as smartpath from '../ts/index.js';
describe('smartpath', function () {
describe('class Smartpath', function() {
let mySmartpath: smartpath.Smartpath
it('should create a valid instance', function() {
mySmartpath = new smartpath.Smartpath('/some/path/to/some.file')
should(mySmartpath).be.instanceof(smartpath.Smartpath)
should(mySmartpath.pathLevelsBackwards).be.of.length(5)
})
})
describe('.check', function () {
let filePathString = './somedir/somefile.json'
let dirPathString = './somedir/anotherdir'
let dirPathString2 = './somedir/another.dir/'
describe('.isFile', function () {
it('should be true for a file path', function () {
should(
smartpath.check.isFile(filePathString)
).be.true()
})
it('should be false for a directory path', function () {
should(
smartpath.check.isFile(dirPathString)
).be.false()
should(
smartpath.check.isFile(dirPathString2)
).be.false()
})
})
describe('.isDir', function () {
it('should be true for a directory path', function () {
should(smartpath.check.isDir(dirPathString)
).be.true()
should(smartpath.check.isDir(dirPathString2)
).be.true()
})
it('should be false for a file path', function () {
should(
smartpath.check.isDir(filePathString)
).be.false()
})
})
})
describe('.transform', function () {
describe('toAbsolute()', function () {
let baseString = '/basedir'
let relativeString = 'somedir/somefile.txt'
let relativeString2 = 'anotherdir/anotherfile.txt'
let relativeArray = [relativeString, relativeString, relativeString2]
it('should make a string absolute', function () {
should(smartpath.transform.toAbsolute(relativeString)).startWith('/')
should(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString)
should(smartpath.transform.toAbsolute(relativeString, baseString)).equal('/basedir/somedir/somefile.txt')
})
it('should make an array of relative Strings an Array of absolute Strings', function () {
let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString)
should(absoluteArray[2]).startWith('/')
should(absoluteArray[2]).endWith(relativeString2)
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();
});
})
it('should return false if neither String nor Array', function () {
should(smartpath.transform.toAbsolute(3)).be.false()
})
})
})
describe('.get', function () {
describe('.type()', function () {
it("should return 'url' for an URL", function () {
should(smartpath.get.type('https://push.rocks/some/url')).equal('url')
should(smartpath.get.type('https://push.rocks/some/url')).not.equal('local')
})
it("should return 'path' for a Path", function () {
should(smartpath.get.type('/some/absolute/path/')).equal('local')
should(smartpath.get.type('./some/relative/path/')).not.equal('url')
})
})
describe('.get()', function () {
it('should a absolute path for an home relative URL', function () {
console.log(smartpath.get.home('~/test'))
})
it('should return the home directory path when no argument is specified', function () {
console.log(smartpath.get.home())
})
})
})
})
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();

View File

@ -1,13 +1,8 @@
// import modules
import check = require('./smartpath.check')
import get = require('./smartpath.get')
import transform = require('./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 {
check,
get,
transform
}
export * from './smartpath.classes.smartpath'
export * from './smartpath.classes.smartpath.js';

View File

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

View File

@ -1,15 +1,15 @@
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
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)
}
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);
}
}

View File

@ -1,36 +1,48 @@
import plugins = require('./smartpath.plugins')
export type TPathType = 'url' | 'local'
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
if (urlRegex.exec(pathStringArg)) {
return 'url'
} else {
return '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 getDirnameFromImportMetaUrl = () => {
}
export let home = function (pathArgument?: string) {
if (pathArgument) {
return plugins.home.resolve(pathArgument)
} else {
return plugins.home()
}
}
/**
* 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 type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx';
export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
let pathLevelArray: string[]
if (systemArg === 'dynamic') {
pathLevelArray = pathArg.split(plugins.path.sep)
}
return pathLevelArray
}
export const pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
let pathLevelArray: string[];
if (systemArg === 'dynamic') {
pathLevelArray = pathArg.split(plugins.path.sep);
}
return pathLevelArray;
};
export let pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
return pathLevels(pathArg, systemArg).reverse()
}
export const pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
return pathLevels(pathArg, systemArg).reverse();
};

View File

@ -1,3 +1,5 @@
import 'typings-global'
export var home = require('home')
export import path = require('path')
import * as os from 'os';
import * as path from 'path';
import * as url from 'url';
export { os, path, url };

View File

@ -1,40 +1,41 @@
import 'typings-global'
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 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
}
// checks a file
let makeAbsolute = function (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 let toAbsolute = function(relativeArg: string | string[], baseArg?: string): any {
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 false
export let toAbsolute = function (relativeArg: string | string[], baseArg?: string): any {
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 false;
}
};

View File

@ -1,3 +0,0 @@
{
"extends": "tslint-config-standard"
}