Compare commits

..

34 Commits

Author SHA1 Message Date
1558a9148b 5.0.12 2024-04-12 14:59:49 +02:00
fad06e3c33 fix(core): update 2024-04-12 14:59:49 +02:00
b51ccda39e update npmextra.json: githost 2024-04-01 21:37:13 +02:00
071e17d8bf update npmextra.json: githost 2024-04-01 19:59:14 +02:00
07e13ed9be update npmextra.json: githost 2024-03-30 21:48:13 +01:00
e3f6c0a8a1 5.0.11 2023-07-12 10:01:46 +02:00
db7dc635f1 fix(core): update 2023-07-12 10:01:45 +02:00
8bb10f45b3 5.0.10 2023-07-12 00:44:21 +02:00
68ccb0e708 fix(core): update 2023-07-12 00:44:20 +02:00
fc51d498c7 5.0.9 2023-07-12 00:39:53 +02:00
6474016fc1 fix(core): update 2023-07-12 00:39:53 +02:00
ea42dbd1c3 5.0.8 2023-07-12 00:37:13 +02:00
9e8ce8215c fix(core): update 2023-07-12 00:37:13 +02:00
b02ab97d4f 5.0.7 2023-07-12 00:26:36 +02:00
ecfefc250c fix(core): update 2023-07-12 00:26:35 +02:00
dde9948404 switch to new org scheme 2023-07-11 01:23:53 +02:00
d041d8de68 switch to new org scheme 2023-07-10 10:17:16 +02:00
f03b3df55b 5.0.6 2022-03-17 16:19:23 +01:00
ca387124ee fix(core): update 2022-03-17 16:19:22 +01:00
027b3fe9ad 5.0.5 2022-03-16 11:35:25 +01:00
1b4681c065 fix(core): update 2022-03-16 11:35:25 +01:00
96168fd870 5.0.4 2022-03-14 15:24:17 +01:00
e81c37e60a fix(core): update 2022-03-14 15:24:16 +01:00
87454d41da 5.0.3 2022-03-14 15:15:23 +01:00
97ae2d87b1 fix(core): update 2022-03-14 15:15:23 +01:00
e23624a93f 5.0.2 2022-03-14 13:39:01 +01:00
7183fcc00a fix(core): update 2022-03-14 13:39:01 +01:00
9fad6100f0 5.0.1 2022-03-14 13:38:32 +01:00
d0e3065d12 fix(core): update 2022-03-14 13:38:32 +01:00
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
21 changed files with 5145 additions and 1635 deletions

View File

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

View File

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @shipzone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

View File

@ -12,6 +12,9 @@ stages:
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
@ -19,23 +22,36 @@ mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- lossless - lossless
- docker - docker
- notpriv - 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 image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci npm prepare
- npmci command npm install --ignore-scripts - npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org - 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: tags:
- lossless
- docker - docker
- notpriv allow_failure: true
# ==================== # ====================
# test stage # test stage
@ -50,9 +66,7 @@ testStable:
- npmci npm test - npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- priv
testBuild: testBuild:
stage: test stage: test
@ -63,9 +77,7 @@ testBuild:
- npmci command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- lossless
- docker - docker
- notpriv
release: release:
stage: release stage: release
@ -85,6 +97,8 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g tslint typescript
- npmci npm prepare - npmci npm prepare
@ -109,9 +123,9 @@ trigger:
pages: pages:
stage: metadata stage: metadata
script: script:
- npmci node install lts - npmci node install stable
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare - npmci npm prepare
- npmci command npm install -g @git.zone/tsdoc
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command tsdoc
tags: tags:

24
.vscode/launch.json vendored
View File

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

View File

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

View File

View File

@ -1,19 +1,19 @@
{ {
"npmci": { "npmci": {
"npmGlobalTools": [
"@gitzone/npmts"
],
"npmAccessLevel": "public" "npmAccessLevel": "public"
}, },
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartpath", "gitrepo": "smartpath",
"shortDescription": "offers smart ways to handle paths", "description": "offers smart ways to handle paths",
"npmPackagename": "@pushrocks/smartpath", "npmPackagename": "@push.rocks/smartpath",
"license": "MIT" "license": "MIT"
} }
},
"tsdocs": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

1526
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,13 +1,15 @@
{ {
"name": "@pushrocks/smartpath", "name": "@push.rocks/smartpath",
"version": "4.0.2", "version": "5.0.12",
"private": false, "private": false,
"description": "offers smart ways to handle paths", "description": "offers smart ways to handle paths",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"scripts": { "scripts": {
"test": "(tstest test)", "test": "(tstest test)",
"build": "(tsbuild)" "build": "(tsbuild --allowimplicitany)",
"buildDocs": "tsdoc"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@ -24,13 +26,12 @@
"url": "https://github.com/pushrocks/smartpath/issues" "url": "https://github.com/pushrocks/smartpath/issues"
}, },
"homepage": "https://github.com/pushrocks/smartpath", "homepage": "https://github.com/pushrocks/smartpath",
"dependencies": {},
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.17", "@git.zone/tsbuild": "^2.1.66",
"@gitzone/tsrun": "^1.2.8", "@git.zone/tsrun": "^1.2.44",
"@gitzone/tstest": "^1.0.28", "@git.zone/tstest": "^1.0.77",
"@pushrocks/tapbundle": "^3.2.0", "@push.rocks/tapbundle": "^5.0.8",
"@types/node": "^10.5.2" "@types/node": "^20.12.7"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -43,5 +44,8 @@
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
],
"browserslist": [
"last 1 chrome versions"
] ]
} }

4777
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

43
readme.md Normal file
View File

@ -0,0 +1,43 @@
# @push.rocks/smartpath
offers smart ways to handle paths
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartpath)
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartpath)
* [github.com (source mirror)](https://github.com/push.rocks/smartpath)
* [docs (typedoc)](https://push.rocks.gitlab.io/smartpath/)
## Status for master
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/smartpath/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/smartpath/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/smartpath)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/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/@push.rocks/smartpath)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/smartpath)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/smartpath)](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.
## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

View File

@ -1,11 +1,11 @@
import { tap, expect } from '@pushrocks/tapbundle'; import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
import * as smartpath from '../ts/index'; import * as smartpath from '../ts/index.js';
let mySmartpath: smartpath.Smartpath; let mySmartpath: smartpath.Smartpath;
tap.test('expect create a valid instance', async () => { tap.test('expect create a valid instance', async () => {
mySmartpath = new smartpath.Smartpath('/some/path/to/some.file'); mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
expect(mySmartpath).to.be.instanceof(smartpath.Smartpath); expect(mySmartpath).toBeInstanceOf(smartpath.Smartpath);
expect(mySmartpath.pathLevelsBackwards).to.be.of.length(5); expect(mySmartpath.pathLevelsBackwards.length === 5).toBeTrue();
}); });
let filePathString = './somedir/somefile.json'; let filePathString = './somedir/somefile.json';
@ -13,21 +13,21 @@ let dirPathString = './somedir/anotherdir';
let dirPathString2 = './somedir/another.dir/'; let dirPathString2 = './somedir/another.dir/';
tap.test('expect be true for a file path', async () => { 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 () => { tap.test('expect be false for a directory path', async () => {
expect(smartpath.check.isFile(dirPathString)).to.be.false; expect(smartpath.check.isFile(dirPathString)).toBeFalse();
expect(smartpath.check.isFile(dirPathString2)).to.be.false; expect(smartpath.check.isFile(dirPathString2)).toBeFalse();
}); });
tap.test('expect be true for a directory path', async () => { 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 () => { 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'; let baseString = '/basedir';
@ -35,25 +35,25 @@ let relativeString = 'somedir/somefile.txt';
let relativeString2 = 'anotherdir/anotherfile.txt'; let relativeString2 = 'anotherdir/anotherfile.txt';
let relativeArray = [relativeString, relativeString, relativeString2]; let relativeArray = [relativeString, relativeString, relativeString2];
tap.test('expect make a string absolute', async () => { tap.test('expect make a string absolute', async () => {
expect(smartpath.transform.toAbsolute(relativeString)).startWith('/'); expect(smartpath.transform.toAbsolute(relativeString)).toStartWith('/');
expect(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString); expect(smartpath.transform.toAbsolute(relativeString)).toEndWith(relativeString);
expect(smartpath.transform.toAbsolute(relativeString, baseString)).equal( expect(smartpath.transform.toAbsolute(relativeString, baseString)).toEqual(
'/basedir/somedir/somefile.txt' '/basedir/somedir/somefile.txt'
); );
}); });
tap.test('expect make an array of relative Strings an Array of absolute Strings', async () => { tap.test('expect make an array of relative Strings an Array of absolute Strings', async () => {
let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString); let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString);
expect(absoluteArray[2]).to.startWith('/'); expect(absoluteArray[2]).toStartWith('/');
expect(absoluteArray[2]).endWith(relativeString2); expect(absoluteArray[2]).toEndWith(relativeString2);
}); });
tap.test("expect return 'url' for an URL", async () => { 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')).toEqual('url');
expect(smartpath.get.type('https://push.rocks/some/url')).not.equal('local'); expect(smartpath.get.type('https://push.rocks/some/url')).not.toEqual('local');
}); });
tap.test("expect return 'path' for a Path", async () => { tap.test("expect return 'path' for a Path", async () => {
expect(smartpath.get.type('/some/absolute/path/')).equal('local'); expect(smartpath.get.type('/some/absolute/path/')).toEqual('local');
expect(smartpath.get.type('./some/relative/path/')).not.equal('url'); expect(smartpath.get.type('./some/relative/path/')).not.toEqual('url');
}); });
tap.test('expect a absolute path for an home relative URL', async () => { tap.test('expect a absolute path for an home relative URL', async () => {

8
ts/00_commitinfo_data.ts Normal file
View File

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

View File

@ -1,8 +1,8 @@
// import modules // import modules
import * as check from './smartpath.check'; import * as check from './smartpath.check.js';
import * as get from './smartpath.get'; import * as get from './smartpath.get.js';
import * as transform from './smartpath.transform'; 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,4 +1,4 @@
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); return !isFile(pathArg);

View File

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

View File

@ -1,11 +1,11 @@
import plugins = require('./smartpath.plugins'); import * as plugins from './smartpath.plugins.js';
export type TPathType = 'url' | 'local'; export type TPathType = 'url' | 'local';
/** /**
* returns the type of the given path. Can be "url" or "local" * returns the type of the given path. Can be "url" or "local"
*/ */
export let type = function(pathStringArg: string): TPathType { export const type = (pathStringArg: string): TPathType => {
let urlRegex = /http[s|\s]:\/\/.*/i; const urlRegex = /http[s|\s]:\/\/.*/i;
if (urlRegex.exec(pathStringArg)) { if (urlRegex.exec(pathStringArg)) {
return 'url'; return 'url';
} else { } 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 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) { if (pathArgument) {
return pathArgument.replace('~', plugins.os.homedir()); return pathArgument.replace('~', plugins.os.homedir());
} else { } else {
@ -23,7 +35,7 @@ export let home = function(pathArgument?: string) {
export type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx'; 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[]; let pathLevelArray: string[];
if (systemArg === 'dynamic') { if (systemArg === 'dynamic') {
pathLevelArray = pathArg.split(plugins.path.sep); pathLevelArray = pathArg.split(plugins.path.sep);
@ -31,6 +43,6 @@ export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') =>
return pathLevelArray; return pathLevelArray;
}; };
export let pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => { export const pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
return pathLevels(pathArg, systemArg).reverse(); return pathLevels(pathArg, systemArg).reverse();
}; };

View File

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

View File

@ -1,16 +1,24 @@
import plugins = require('./smartpath.plugins'); import * as plugins from './smartpath.plugins.js';
/* ------------------------------------------ * /* ------------------------------------------ *
* ------------ helpers --------------------- * * ------------ helpers --------------------- *
* ------------------------------------------ */ * ------------------------------------------ */
// checks a file /**
let makeAbsolute = function(localPathArg: string, baseArg?: string): string { * takes a path and makes it absolute
* @param localPathArg
* @param baseArg
* @returns
*/
export const makeAbsolute = (localPathArg: string, baseArg?: string): string => {
let absolutePath: string; let absolutePath: string;
let alreadyAbsolute = plugins.path.isAbsolute(localPathArg); let alreadyAbsolute = plugins.path.isAbsolute(localPathArg);
if (baseArg && !alreadyAbsolute) { if (!alreadyAbsolute && baseArg && !baseArg.startsWith('.')) {
absolutePath = plugins.path.join(baseArg, localPathArg); absolutePath = plugins.path.join(baseArg, localPathArg);
} else if (!alreadyAbsolute) { } else if (!alreadyAbsolute) {
if (baseArg) {
plugins.path.join(baseArg, localPathArg);
}
absolutePath = plugins.path.resolve(localPathArg); absolutePath = plugins.path.resolve(localPathArg);
} else { } else {
absolutePath = localPathArg; absolutePath = localPathArg;
@ -18,10 +26,10 @@ let makeAbsolute = function(localPathArg: string, baseArg?: string): string {
return absolutePath; return absolutePath;
}; };
/* ------------------------------------------ * /*
* ------- export functions ----------------- * * like makeAbsolute, but takes different complex contructs like arrays and objects
* ------------------------------------------ */ */
export let toAbsolute = function(relativeArg: string | string[], baseArg?: string): any { export const toAbsolute = (relativeArg: string | string[], baseArg?: string): string | string[] => {
if (typeof relativeArg === 'string') { if (typeof relativeArg === 'string') {
return makeAbsolute(relativeArg, baseArg); return makeAbsolute(relativeArg, baseArg);
} else if (Array.isArray(relativeArg)) { } else if (Array.isArray(relativeArg)) {
@ -36,6 +44,6 @@ export let toAbsolute = function(relativeArg: string | string[], baseArg?: strin
'smartpath.absolute() could not make sense of the input. ' + 'smartpath.absolute() could not make sense of the input. ' +
'Input is neither String nor Array' 'Input is neither String nor Array'
); );
return false; return null;
} }
}; };

14
tsconfig.json Normal file
View File

@ -0,0 +1,14 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

View File

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