Compare commits

..

No commits in common. "master" and "v4.0.3" have entirely different histories.

22 changed files with 1580 additions and 5281 deletions

View File

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

@ -1,124 +0,0 @@
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,9 +12,6 @@ stages:
- release - release
- metadata - metadata
before_script:
- npm install -g @shipzone/npmci
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
@ -22,36 +19,23 @@ mirror:
stage: security stage: security
script: script:
- npmci git mirror - npmci git mirror
only:
- tags
tags: tags:
- lossless - lossless
- docker - docker
- notpriv - notpriv
auditProductionDependencies: audit:
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 --only=dev - npmci command npm audit --audit-level=high
tags: tags:
- lossless
- docker - docker
allow_failure: true - notpriv
# ==================== # ====================
# test stage # test stage
@ -66,7 +50,9 @@ 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
@ -77,7 +63,9 @@ 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
@ -97,8 +85,6 @@ 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
@ -123,9 +109,9 @@ trigger:
pages: pages:
stage: metadata stage: metadata
script: script:
- npmci node install stable - npmci node install lts
- 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,10 +2,28 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"command": "npm test", "name": "current file",
"name": "Run npm test", "type": "node",
"request": "launch", "request": "launch",
"type": "node-terminal" "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"
} }
] ]
} }

View File

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

View File

View File

@ -1,36 +1,19 @@
{ {
"npmci": { "npmci": {
"npmGlobalTools": [
"@gitzone/npmts"
],
"npmAccessLevel": "public" "npmAccessLevel": "public"
}, },
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "code.foss.global", "githost": "gitlab.com",
"gitscope": "push.rocks", "gitscope": "pushrocks",
"gitrepo": "smartpath", "gitrepo": "smartpath",
"description": "A library offering smart ways to handle file and directory paths.", "shortDescription": "offers smart ways to handle paths",
"npmPackagename": "@push.rocks/smartpath", "npmPackagename": "@pushrocks/smartpath",
"license": "MIT", "license": "MIT"
"keywords": [
"path handling",
"file system",
"directory manipulation",
"file checks",
"path transformation",
"typescript",
"node.js development",
"URL handling",
"absolute paths",
"smart path resolution",
"programming",
"file management",
"software development",
"path utilities",
"cross-platform path management"
]
} }
},
"tsdoc": {
"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"
} }
} }

1437
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,49 +1,36 @@
{ {
"name": "@push.rocks/smartpath", "name": "@pushrocks/smartpath",
"version": "5.0.18", "version": "4.0.3",
"private": false, "private": false,
"description": "A library offering smart ways to handle file and directory 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 --allowimplicitany)", "build": "(tsbuild)"
"buildDocs": "tsdoc"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://code.foss.global/push.rocks/smartpath.git" "url": "https://github.com/pushrocks/smartpath.git"
}, },
"keywords": [ "keywords": [
"path handling", "json",
"file system", "jade",
"directory manipulation", "template"
"file checks",
"path transformation",
"typescript",
"node.js development",
"URL handling",
"absolute paths",
"smart path resolution",
"programming",
"file management",
"software development",
"path utilities",
"cross-platform path management"
], ],
"author": "Lossless GmbH <office@lossless.com> (https://lossless.com)", "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
"license": "MIT", "license": "MIT",
"bugs": { "bugs": {
"url": "https://github.com/pushrocks/smartpath/issues" "url": "https://github.com/pushrocks/smartpath/issues"
}, },
"homepage": "https://code.foss.global/push.rocks/smartpath", "homepage": "https://github.com/pushrocks/smartpath",
"dependencies": {},
"devDependencies": { "devDependencies": {
"@git.zone/tsbuild": "^2.1.66", "@gitzone/tsbuild": "^2.1.22",
"@git.zone/tsrun": "^1.2.44", "@gitzone/tsrun": "^1.2.8",
"@git.zone/tstest": "^1.0.90", "@gitzone/tstest": "^1.0.28",
"@push.rocks/tapbundle": "^5.0.23", "@pushrocks/tapbundle": "^3.2.1",
"@types/node": "^20.12.7" "@types/node": "^13.11.1"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -56,8 +43,5 @@
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
],
"browserslist": [
"last 1 chrome versions"
] ]
} }

4814
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -1 +0,0 @@
no specific hints here, should be easy to understand from the files.

119
readme.md
View File

@ -1,107 +1,38 @@
# @push.rocks/smartpath # @pushrocks/smartpath
offers smart ways to handle paths
[@push.rocks/smartpath](https://github.com/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/)
## Install ## Status for master
To install `@push.rocks/smartpath`, you'll need to run the following command using npm. Ensure you have Node.js and npm installed before you start. [![pipeline status](https://gitlab.com/pushrocks/smartpath/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartpath/commits/master)
```bash [![coverage report](https://gitlab.com/pushrocks/smartpath/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartpath/commits/master)
npm install @push.rocks/smartpath --save [![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpath.svg)](https://www.npmjs.com/package/@pushrocks/smartpath)
``` [![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpath/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpath)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
## Usage ## Usage
The `@push.rocks/smartpath` module provides a sophisticated yet straightforward approach to handle, manipulate, and evaluate file and directory paths within your TypeScript projects. By incorporating features like path normalization, transformation, and validation, `smartpath` facilitates powerful and efficient file system and URL path manipulation. This guide dives deep into the module's capabilities, showcasing a broad spectrum of use cases and demonstrating its versatility in handling paths.
### Getting Started Use TypeScript for best in class instellisense.
To begin utilizing `smartpath` in your project, start by importing it in your TypeScript file:
```typescript For further information read the linked docs at the top of this README.
import * as smartpath from '@push.rocks/smartpath';
```
### Creating a Smartpath Instance > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
Instantiating a `Smartpath` object allows for the enrichment of path strings with additional context and manipulation capabilities:
```typescript [![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
const mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
console.log(mySmartpath);
```
### Path Validation ## Contribution
Determining whether a path points to a file or directory is a common requirement. Here's how you can achieve this:
```typescript 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). :)
if (smartpath.check.isFile('./path/to/file.txt')) {
console.log('This is a file.');
}
if (smartpath.check.isDir('./path/to/directory')) { For further information read the linked docs at the top of this readme.
console.log('This is a directory.');
}
```
### Absolute Path Conversion > MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
Converting a relative path to an absolute one is a frequent operation, especially in dynamic file handling scenarios: | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
```typescript [![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
const absolutePath = smartpath.transform.makeAbsolute('./relative/path/to/file.txt');
console.log(`Absolute path: ${absolutePath}`);
```
### Handling Multiple Paths
`smartpath` shines when dealing with multiple paths, offering efficient bulk operations:
```typescript
const paths = ['./path/to/file1.txt', './another/path/to/file2.txt'];
const absolutePaths = smartpath.transform.toAbsolute(paths);
console.log(absolutePaths);
```
### Understanding Path Types
Identifying whether a path represents a local file system path or a URL is straightforward:
```typescript
const pathType = smartpath.get.type('https://example.com/resource');
console.log(`Path type: ${pathType}`); // 'url'
```
### Home Directory Paths
Easily manage paths relative to the user's home directory:
```typescript
const homePath = smartpath.get.home('~/path/to/resource');
console.log(`Home directory path: ${homePath}`);
```
### Analyzing Path Components
Breaking down a path into its components allows for detailed path analysis and manipulation:
```typescript
const pathLevels = smartpath.get.pathLevels('/path/to/resource');
console.log(pathLevels); // ['path', 'to', 'resource']
```
### Path Manipulation and More
Beyond the basics, `smartpath` offers a comprehensive set of tools for robust path manipulation, including normalizing paths across different operating systems, working with URL paths, and handling special path constructs like ".." and ".".
For more advanced use cases, such as transforming path lists, deriving relative paths, or integrating path handling into larger application workflows, `smartpath` provides both utility functions and object-oriented interfaces that streamline these operations.
By leveraging the full spectrum of `smartpath`'s features, developers can handle virtually any path-related task with ease, efficiency, and reliability. Whether you're building a complex file system utility, managing web application assets, or simply need reliable path manipulation in your TypeScript projects, `smartpath` offers the functionality and flexibility required to do the job right.
## License and Legal Information
This 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.
**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.
### Trademarks
This 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.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By 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.

View File

@ -1,11 +1,11 @@
import { tap, expect, expectAsync } from '@push.rocks/tapbundle'; import { tap, expect } from '@pushrocks/tapbundle';
import * as smartpath from '../ts/index.js'; import * as smartpath from '../ts/index';
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).toBeInstanceOf(smartpath.Smartpath); expect(mySmartpath).to.be.instanceof(smartpath.Smartpath);
expect(mySmartpath.pathLevelsBackwards.length === 5).toBeTrue(); expect(mySmartpath.pathLevelsBackwards).to.be.of.length(5);
}); });
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)).toBeTrue(); expect(smartpath.check.isFile(filePathString)).to.be.true;
}); });
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)).toBeFalse(); expect(smartpath.check.isFile(dirPathString)).to.be.false;
expect(smartpath.check.isFile(dirPathString2)).toBeFalse(); expect(smartpath.check.isFile(dirPathString2)).to.be.false;
}); });
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)).toBeTrue(); expect(smartpath.check.isDir(dirPathString)).to.be.true;
expect(smartpath.check.isDir(dirPathString2)).toBeTrue(); expect(smartpath.check.isDir(dirPathString2)).to.be.true;
}); });
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)).toBeFalse(); expect(smartpath.check.isDir(filePathString)).to.be.false;
}); });
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)).toStartWith('/'); expect(smartpath.transform.toAbsolute(relativeString)).startWith('/');
expect(smartpath.transform.toAbsolute(relativeString)).toEndWith(relativeString); expect(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString);
expect(smartpath.transform.toAbsolute(relativeString, baseString)).toEqual( expect(smartpath.transform.toAbsolute(relativeString, baseString)).equal(
'/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]).toStartWith('/'); expect(absoluteArray[2]).to.startWith('/');
expect(absoluteArray[2]).toEndWith(relativeString2); expect(absoluteArray[2]).endWith(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')).toEqual('url'); expect(smartpath.get.type('https://push.rocks/some/url')).equal('url');
expect(smartpath.get.type('https://push.rocks/some/url')).not.toEqual('local'); expect(smartpath.get.type('https://push.rocks/some/url')).not.equal('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/')).toEqual('local'); expect(smartpath.get.type('/some/absolute/path/')).equal('local');
expect(smartpath.get.type('./some/relative/path/')).not.toEqual('url'); expect(smartpath.get.type('./some/relative/path/')).not.equal('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 () => {

View File

@ -1,8 +0,0 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartpath',
version: '5.0.18',
description: 'A library offering smart ways to handle file and directory paths.'
}

View File

@ -1,12 +1,8 @@
import * as plugins from './smartpath.plugins.js';
// import modules // import modules
import * as check from './smartpath.check.js'; import * as check from './smartpath.check';
import * as get from './smartpath.get.js'; import * as get from './smartpath.get';
import * as transform from './smartpath.transform.js'; import * as transform from './smartpath.transform';
export { check, get, transform }; export { check, get, transform };
export const join = (...args: string[]) => plugins.path.join(...args); export * from './smartpath.classes.smartpath';
export * from './smartpath.classes.smartpath.js';

View File

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

View File

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

View File

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

View File

@ -1,5 +1,4 @@
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, url }; export { os, path };

View File

@ -1,24 +1,16 @@
import * as plugins from './smartpath.plugins.js'; import plugins = require('./smartpath.plugins');
/* ------------------------------------------ * /* ------------------------------------------ *
* ------------ helpers --------------------- * * ------------ helpers --------------------- *
* ------------------------------------------ */ * ------------------------------------------ */
/** // checks a file
* takes a path and makes it absolute let makeAbsolute = function(localPathArg: string, baseArg?: string): string {
* @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 (!alreadyAbsolute && baseArg && !baseArg.startsWith('.')) { if (baseArg && !alreadyAbsolute) {
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;
@ -26,10 +18,10 @@ export const makeAbsolute = (localPathArg: string, baseArg?: string): string =>
return absolutePath; return absolutePath;
}; };
/* /* ------------------------------------------ *
* like makeAbsolute, but takes different complex contructs like arrays and objects * ------- export functions ----------------- *
*/ * ------------------------------------------ */
export const toAbsolute = (relativeArg: string | string[], baseArg?: string): string | string[] => { export let toAbsolute = function(relativeArg: string | string[], baseArg?: string): any {
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)) {
@ -44,6 +36,6 @@ export const toAbsolute = (relativeArg: string | string[], baseArg?: string): st
'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 null; return false;
} }
}; };

View File

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

17
tslint.json Normal file
View File

@ -0,0 +1,17 @@
{
"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"
}