Compare commits

...

39 Commits

Author SHA1 Message Date
ff1e6242a3 feat(iso): add isomorphic path module with cross-platform utilities 2025-07-28 22:27:32 +00:00
ae736d5dbb update description 2024-05-29 14:15:19 +02:00
7686c417b1 5.0.18 2024-04-22 18:42:18 +02:00
65cb98d031 fix(core): update 2024-04-22 18:42:18 +02:00
55fc30139f 5.0.17 2024-04-22 18:41:58 +02:00
be85880e54 fix(core): update 2024-04-22 18:41:58 +02:00
ebc523cb9f 5.0.16 2024-04-20 10:17:51 +02:00
6fae04e92a fix(core): update 2024-04-20 10:17:51 +02:00
de54eb828f 5.0.15 2024-04-20 10:13:49 +02:00
bf6ed38083 fix(core): update 2024-04-20 10:13:48 +02:00
b53d74cd55 5.0.14 2024-04-14 00:53:54 +02:00
7cc6127680 fix(core): update 2024-04-14 00:53:53 +02:00
10bda971fb 5.0.13 2024-04-12 15:00:06 +02:00
e578601b49 fix(core): update 2024-04-12 15:00:06 +02:00
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
19 changed files with 10841 additions and 18485 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

@@ -1,141 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
before_script:
- npm install -g @shipzone/npmci
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
allow_failure: true
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install 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

18
changelog.md Normal file
View File

@@ -0,0 +1,18 @@
# Changelog
## [5.1.0] - 2025-01-28
### Added
- New isomorphic path module at `/iso` export path for cross-platform path operations
- `pathJoin()` function for joining paths across different platforms and environments
- `fileUrlToPath()` function for converting file:// URLs to system paths
- `pathToFileUrl()` function for converting system paths to file:// URLs
- `dirname()` function for extracting directory from paths and URLs
- Comprehensive test coverage for isomorphic path functions
### Changed
- Build system now uses tsfolders for multi-folder compilation
- Package exports now use modern exports field instead of main/typings
### Removed
- Removed .gitlab-ci.yml file

22
license Normal file
View File

@@ -0,0 +1,22 @@
The MIT License (MIT)
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
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@@ -5,12 +5,32 @@
"gitzone": {
"projectType": "npm",
"module": {
"githost": "gitlab.com",
"gitscope": "pushrocks",
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "smartpath",
"description": "offers smart ways to handle paths",
"npmPackagename": "@pushrocks/smartpath",
"license": "MIT"
"description": "A library offering smart ways to handle file and directory paths.",
"npmPackagename": "@push.rocks/smartpath",
"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"
}
}

18276
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,36 +1,51 @@
{
"name": "@pushrocks/smartpath",
"version": "5.0.2",
"name": "@push.rocks/smartpath",
"version": "5.1.0",
"private": false,
"description": "offers smart ways to handle paths",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"description": "A library offering smart ways to handle file and directory paths.",
"exports": {
".": "./dist_ts/index.js",
"./iso": "./dist_ts_iso/index.js"
},
"type": "module",
"scripts": {
"test": "(tstest test)",
"build": "(tsbuild)"
"test": "(tstest test/ --verbose)",
"build": "(tsbuild tsfolders)",
"buildDocs": "tsdoc"
},
"repository": {
"type": "git",
"url": "https://github.com/pushrocks/smartpath.git"
"url": "https://code.foss.global/push.rocks/smartpath.git"
},
"keywords": [
"json",
"jade",
"template"
"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"
],
"author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/pushrocks/smartpath/issues"
},
"homepage": "https://github.com/pushrocks/smartpath",
"homepage": "https://code.foss.global/push.rocks/smartpath",
"devDependencies": {
"@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"
"@git.zone/tsbuild": "^2.1.66",
"@git.zone/tsrun": "^1.2.44",
"@git.zone/tstest": "^1.0.90",
"@push.rocks/tapbundle": "^5.0.23",
"@types/node": "^20.12.7"
},
"files": [
"ts/**/*",
@@ -46,5 +61,6 @@
],
"browserslist": [
"last 1 chrome versions"
]
],
"packageManager": "pnpm@10.11.0+sha512.6540583f41cc5f628eb3d9773ecee802f4f9ef9923cc45b69890fb47991d4b092964694ec3a4f738a420c918a333062c8b925d312f42e4f0c263eb603551f977"
}

10038
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file
View File

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

157
readme.md
View File

@@ -1,45 +1,138 @@
# @pushrocks/smartpath
offers smart ways to handle paths
# @push.rocks/smartpath
## 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/)
[@push.rocks/smartpath](https://github.com/pushrocks/smartpath) offers smart ways to handle paths.
## 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)
## Install
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.
```bash
npm install @push.rocks/smartpath --save
```
## 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.
Use TypeScript for best in class instellisense.
### Getting Started
To begin utilizing `smartpath` in your project, start by importing it in your TypeScript file:
For further information read the linked docs at the top of this README.
```typescript
import * as smartpath from '@push.rocks/smartpath';
```
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
### Isomorphic Path Module
For cross-platform path operations that work in any JavaScript environment (Node.js, browsers, Deno, etc.), use the isomorphic module:
[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
```typescript
import * as isoPath from '@push.rocks/smartpath/iso';
## Contribution
// Join paths with automatic platform detection
const joinedPath = isoPath.pathJoin('/home/user', 'documents', 'file.txt');
// Unix: /home/user/documents/file.txt
// Windows: C:\Users\documents\file.txt
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). :)
// Convert file:// URLs to system paths
const systemPath = isoPath.fileUrlToPath('file:///home/user/file.txt');
// Unix: /home/user/file.txt
// Windows: C:\home\user\file.txt
For further information read the linked docs at the top of this readme.
// Convert system paths to file:// URLs
const fileUrl = isoPath.pathToFileUrl('/home/user/file.txt');
// Result: file:///home/user/file.txt
> MIT licensed | **&copy;** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
// Get directory from path or file URL
const dir = isoPath.dirname('/home/user/documents/file.txt');
// Result: /home/user/documents
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
The isomorphic module automatically detects the path style (Windows vs POSIX) and handles:
- file:// URL conversions
- Mixed path separators
- Cross-platform compatibility
- Proper handling of Windows drive letters and UNC paths
### Creating a Smartpath Instance
Instantiating a `Smartpath` object allows for the enrichment of path strings with additional context and manipulation capabilities:
```typescript
const mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
console.log(mySmartpath);
```
### Path Validation
Determining whether a path points to a file or directory is a common requirement. Here's how you can achieve this:
```typescript
if (smartpath.check.isFile('./path/to/file.txt')) {
console.log('This is a file.');
}
if (smartpath.check.isDir('./path/to/directory')) {
console.log('This is a directory.');
}
```
### Absolute Path Conversion
Converting a relative path to an absolute one is a frequent operation, especially in dynamic file handling scenarios:
```typescript
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.

145
test/test.iso.both.ts Normal file
View File

@@ -0,0 +1,145 @@
import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as smartpath from '../ts_iso/index.js';
tap.test('pathJoin - should join path segments correctly', async () => {
// Basic path joining
expect(smartpath.pathJoin('path', 'to', 'file.txt')).toEqual('path/to/file.txt');
expect(smartpath.pathJoin('/path', 'to', 'file.txt')).toEqual('/path/to/file.txt');
// Windows paths
expect(smartpath.pathJoin('C:', 'Users', 'test')).toEqual('C:\\Users\\test');
expect(smartpath.pathJoin('C:\\Users', 'test', 'file.txt')).toEqual('C:\\Users\\test\\file.txt');
// Empty segments
expect(smartpath.pathJoin('path', '', 'file.txt')).toEqual('path/file.txt');
expect(smartpath.pathJoin('', 'path', 'file.txt')).toEqual('path/file.txt');
// No segments
expect(smartpath.pathJoin()).toEqual('');
expect(smartpath.pathJoin('')).toEqual('');
// Single segment
expect(smartpath.pathJoin('path')).toEqual('path');
expect(smartpath.pathJoin('/path')).toEqual('/path');
// Multiple separators
expect(smartpath.pathJoin('path/', '/to/', '/file.txt')).toEqual('path/to/file.txt');
expect(smartpath.pathJoin('path\\\\', '\\\\to\\\\', '\\\\file.txt')).toEqual('path\\to\\file.txt');
// Root paths
expect(smartpath.pathJoin('/')).toEqual('/');
expect(smartpath.pathJoin('/', 'path')).toEqual('/path');
});
tap.test('pathJoin - should handle file:// URLs', async () => {
// Unix file URLs
expect(smartpath.pathJoin('file:///home/user', 'documents', 'file.txt')).toEqual('/home/user/documents/file.txt');
expect(smartpath.pathJoin('file:///home/user/', 'documents')).toEqual('/home/user/documents');
// Windows file URLs
expect(smartpath.pathJoin('file:///C:/Users', 'test', 'file.txt')).toEqual('C:\\Users\\test\\file.txt');
expect(smartpath.pathJoin('file:///D:/Projects/', 'app')).toEqual('D:\\Projects\\app');
// Mixed file URL and path
expect(smartpath.pathJoin('file:///home/user', '../test')).toEqual('/home/user/../test');
expect(smartpath.pathJoin('documents', 'file:///home/user/file.txt')).toEqual('documents/home/user/file.txt');
});
tap.test('fileUrlToPath - should convert file URLs to paths', async () => {
// Unix file URLs
expect(smartpath.fileUrlToPath('file:///home/user/file.txt')).toEqual('/home/user/file.txt');
expect(smartpath.fileUrlToPath('file:///home/user%20name/file.txt')).toEqual('/home/user name/file.txt');
// Windows file URLs
expect(smartpath.fileUrlToPath('file:///C:/Users/test/file.txt')).toEqual('C:\\Users\\test\\file.txt');
expect(smartpath.fileUrlToPath('file:///D:/My%20Documents/file.txt')).toEqual('D:\\My Documents\\file.txt');
// Not a file URL
expect(smartpath.fileUrlToPath('/home/user/file.txt')).toEqual('/home/user/file.txt');
expect(smartpath.fileUrlToPath('C:\\Users\\test\\file.txt')).toEqual('C:\\Users\\test\\file.txt');
expect(smartpath.fileUrlToPath('https://example.com')).toEqual('https://example.com');
});
tap.test('pathToFileUrl - should convert paths to file URLs', async () => {
// Unix paths
expect(smartpath.pathToFileUrl('/home/user/file.txt')).toEqual('file:///home/user/file.txt');
expect(smartpath.pathToFileUrl('/home/user name/file.txt')).toEqual('file:///home/user%20name/file.txt');
// Windows paths
expect(smartpath.pathToFileUrl('C:\\Users\\test\\file.txt')).toEqual('file:///C:/Users/test/file.txt');
expect(smartpath.pathToFileUrl('D:\\My Documents\\file.txt')).toEqual('file:///D:/My%20Documents/file.txt');
expect(smartpath.pathToFileUrl('C:/Users/test/file.txt')).toEqual('file:///C:/Users/test/file.txt');
// Already a file URL
expect(smartpath.pathToFileUrl('file:///home/user/file.txt')).toEqual('file:///home/user/file.txt');
// Relative paths (can't make file URLs from these)
expect(smartpath.pathToFileUrl('relative/path/file.txt')).toEqual('relative/path/file.txt');
expect(smartpath.pathToFileUrl('./file.txt')).toEqual('./file.txt');
// Special characters
expect(smartpath.pathToFileUrl('/path/with?query')).toEqual('file:///path/with%3Fquery');
expect(smartpath.pathToFileUrl('/path/with#hash')).toEqual('file:///path/with%23hash');
});
tap.test('dirname - should extract directory from paths and URLs', async () => {
// Unix paths
expect(smartpath.dirname('/home/user/file.txt')).toEqual('/home/user');
expect(smartpath.dirname('/home/user/')).toEqual('/home');
expect(smartpath.dirname('/file.txt')).toEqual('/');
expect(smartpath.dirname('/')).toEqual('/');
// Windows paths
expect(smartpath.dirname('C:\\Users\\test\\file.txt')).toEqual('C:\\Users\\test');
expect(smartpath.dirname('C:\\file.txt')).toEqual('C:\\');
expect(smartpath.dirname('C:\\')).toEqual('C:\\');
// File URLs
expect(smartpath.dirname('file:///home/user/file.txt')).toEqual('/home/user');
expect(smartpath.dirname('file:///C:/Users/test/file.txt')).toEqual('C:\\Users\\test');
// Relative paths
expect(smartpath.dirname('relative/path/file.txt')).toEqual('relative/path');
expect(smartpath.dirname('file.txt')).toEqual('.');
expect(smartpath.dirname('')).toEqual('.');
// Mixed separators
expect(smartpath.dirname('path\\to/file.txt')).toEqual('path\\to');
expect(smartpath.dirname('path/to\\file.txt')).toEqual('path/to');
});
tap.test('edge cases - should handle edge cases correctly', async () => {
// Non-string values filtered out
expect(smartpath.pathJoin('path', null as any, 'file.txt')).toEqual('path/file.txt');
expect(smartpath.pathJoin('path', undefined as any, 'file.txt')).toEqual('path/file.txt');
expect(smartpath.pathJoin('path', 123 as any, 'file.txt')).toEqual('path/file.txt');
// Very long paths
const longSegment = 'a'.repeat(100);
const result = smartpath.pathJoin(longSegment, longSegment, 'file.txt');
expect(result).toEqual(`${longSegment}/${longSegment}/file.txt`);
// Unicode characters
expect(smartpath.pathJoin('path', '文件夹', 'файл.txt')).toEqual('path/文件夹/файл.txt');
expect(smartpath.fileUrlToPath('file:///home/用户/文件.txt')).toEqual('/home/用户/文件.txt');
expect(smartpath.pathToFileUrl('/home/用户/文件.txt')).toEqual('file:///home/%E7%94%A8%E6%88%B7/%E6%96%87%E4%BB%B6.txt');
// Backslashes in Unix-style paths (should be preserved)
expect(smartpath.pathJoin('/home/user', 'path\\with\\backslashes')).toEqual('/home/user/path\\with\\backslashes');
});
tap.test('cross-platform behavior - should detect separators correctly', async () => {
// Should detect Windows paths and use backslashes
expect(smartpath.pathJoin('C:\\Users', 'test')).toEqual('C:\\Users\\test');
expect(smartpath.pathJoin('D:', 'Projects', 'app')).toEqual('D:\\Projects\\app');
// Should detect Unix paths and use forward slashes
expect(smartpath.pathJoin('/home', 'user')).toEqual('/home/user');
expect(smartpath.pathJoin('/var', 'log', 'app.log')).toEqual('/var/log/app.log');
// Mixed paths - first segment determines separator
expect(smartpath.pathJoin('C:\\Users', 'test/file.txt')).toEqual('C:\\Users\\test\\file.txt');
expect(smartpath.pathJoin('/home', 'user\\documents')).toEqual('/home/user\\documents');
});
await tap.start();

View File

@@ -1,4 +1,4 @@
import { tap, expect, expectAsync } from '@pushrocks/tapbundle';
import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
import * as smartpath from '../ts/index.js';
let mySmartpath: smartpath.Smartpath;

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.18',
description: 'A library offering smart ways to handle file and directory paths.'
}

View File

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

View File

@@ -1,8 +1,9 @@
import * as plugins from './smartpath.plugins.js'
import * as plugins from './smartpath.plugins.js';
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 const type = (pathStringArg: string): TPathType => {
const urlRegex = /http[s|\s]:\/\/.*/i;
@@ -16,8 +17,12 @@ export const type = (pathStringArg: string): TPathType => {
/**
* gets the dirname from import.meta.url
*/
export const getDirnameFromImportMetaUrl = (importMetaUrlArg: string) => {
export const dirnameFromImportMetaUrl = (importMetaUrlArg: string) => {
return plugins.path.dirname(plugins.url.fileURLToPath(importMetaUrlArg));
};
export const dirname = (pathArg: string) => {
return plugins.path.dirname(pathArg);
}
/**

View File

@@ -4,13 +4,21 @@ import * as plugins from './smartpath.plugins.js';
* ------------ 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 alreadyAbsolute = plugins.path.isAbsolute(localPathArg);
if (baseArg && !alreadyAbsolute) {
if (!alreadyAbsolute && baseArg && !baseArg.startsWith('.')) {
absolutePath = plugins.path.join(baseArg, localPathArg);
} else if (!alreadyAbsolute) {
if (baseArg) {
plugins.path.join(baseArg, localPathArg);
}
absolutePath = plugins.path.resolve(localPathArg);
} else {
absolutePath = localPathArg;
@@ -18,10 +26,10 @@ let makeAbsolute = function (localPathArg: string, baseArg?: string): string {
return absolutePath;
};
/* ------------------------------------------ *
* ------- export functions ----------------- *
* ------------------------------------------ */
export let toAbsolute = function (relativeArg: string | string[], baseArg?: string): any {
/*
* like makeAbsolute, but takes different complex contructs like arrays and objects
*/
export const toAbsolute = (relativeArg: string | string[], baseArg?: string): string | string[] => {
if (typeof relativeArg === 'string') {
return makeAbsolute(relativeArg, baseArg);
} else if (Array.isArray(relativeArg)) {
@@ -36,6 +44,6 @@ export let toAbsolute = function (relativeArg: string | string[], baseArg?: stri
'smartpath.absolute() could not make sense of the input. ' +
'Input is neither String nor Array'
);
return false;
return null;
}
};

191
ts_iso/index.ts Normal file
View File

@@ -0,0 +1,191 @@
/**
* Cross-platform path.join function that works in any JavaScript environment
* Handles regular paths and file:// URLs from import.meta.url
* @param segments - Path segments to join
* @returns Joined path string
*/
export function pathJoin(...segments: string[]): string {
// Filter out empty strings and non-string values
const validSegments = segments.filter(segment =>
typeof segment === 'string' && segment.length > 0
);
// If no valid segments, return empty string
if (validSegments.length === 0) {
return '';
}
// Convert file:// URLs to paths
const processedSegments = validSegments.map(segment => {
return fileUrlToPath(segment);
});
// Detect if we're dealing with Windows-style paths
const isWindowsPath = processedSegments.some(segment => {
// Check for Windows drive letter
if (/^[a-zA-Z]:/.test(segment)) return true;
// Check if first segment has backslashes (indicating Windows)
if (processedSegments[0] === segment && segment.includes('\\')) return true;
return false;
});
// Choose separator and normalize function based on path style
const separator = isWindowsPath ? '\\' : '/';
// Normalize segments based on path style
const normalizedSegments = processedSegments.map((segment) => {
if (isWindowsPath) {
// On Windows, both / and \ are separators
return segment.replace(/[\/\\]+/g, '\\');
} else {
// On POSIX, only / is a separator, \ is literal
return segment.replace(/\/+/g, '/');
}
});
// Join segments and handle edge cases
let result = '';
for (let i = 0; i < normalizedSegments.length; i++) {
const segment = normalizedSegments[i];
if (i === 0) {
result = segment;
} else {
// Remove leading separator from segment if result already ends with one
let cleanSegment = segment;
if (segment.startsWith(separator)) {
cleanSegment = segment.slice(1);
}
// Add separator if result doesn't end with one
if (result && !result.endsWith(separator)) {
result += separator;
}
result += cleanSegment;
}
}
// Handle edge cases
if (result === '' && validSegments.some(s => s === '/' || s === '\\')) {
result = separator;
}
// Clean up multiple consecutive separators
if (isWindowsPath) {
result = result.replace(/\\+/g, '\\');
// Special case for UNC paths
if (result.startsWith('\\\\') && !result.startsWith('\\\\\\')) {
// Keep double backslash for UNC paths
} else if (result.match(/^\\[^\\]/)) {
// Single leading backslash on Windows (unusual but valid)
}
} else {
result = result.replace(/\/+/g, '/');
// Preserve leading slash for absolute paths
if (processedSegments[0].startsWith('/') && !result.startsWith('/')) {
result = '/' + result;
}
}
return result;
}
/**
* Convert a file:// URL to a system path
* @param fileUrl - A file:// URL (e.g., from import.meta.url)
* @returns System path
*/
export function fileUrlToPath(fileUrl: string): string {
if (!fileUrl.startsWith('file://')) {
return fileUrl;
}
// Remove file:// protocol
let path = fileUrl.slice(7);
// Handle Windows file URLs: file:///C:/path -> C:\path
if (/^\/[a-zA-Z]:/.test(path)) {
path = path.slice(1);
// Convert forward slashes to backslashes for Windows
path = path.replace(/\//g, '\\');
}
// Decode URL encoding
path = decodeURIComponent(path);
return path;
}
/**
* Convert a system path to a file:// URL
* @param path - System path
* @returns file:// URL
*/
export function pathToFileUrl(path: string): string {
if (path.startsWith('file://')) {
return path;
}
// Normalize slashes to forward slashes for URL
let urlPath = path.replace(/\\/g, '/');
// Encode special characters
urlPath = encodeURI(urlPath).replace(/[?#]/g, encodeURIComponent);
// Check if it's a Windows absolute path
if (/^[a-zA-Z]:/.test(urlPath)) {
return `file:///${urlPath}`;
}
// Check if it's an absolute path
if (urlPath.startsWith('/')) {
return `file://${urlPath}`;
}
// Relative path - just return as-is (can't make a file URL from relative path)
return urlPath;
}
/**
* Get the directory from a file URL or path
* @param urlOrPath - File URL (like import.meta.url) or regular path
* @returns Directory path
*/
export function dirname(urlOrPath: string): string {
// Convert file URL to path if needed
let path = fileUrlToPath(urlOrPath);
// Remove trailing slashes (but keep root slashes)
if (path.length > 1 && (path.endsWith('/') || path.endsWith('\\'))) {
// Special case: don't remove trailing slash for Windows drive root
if (!(path.length === 3 && path[1] === ':')) {
path = path.slice(0, -1);
}
}
// Special case for Windows drive root (C:\ or C:)
if (path.match(/^[a-zA-Z]:\\?$/)) {
return path.endsWith('\\') ? path : path + '\\';
}
// Find the last separator
const lastSlash = Math.max(path.lastIndexOf('/'), path.lastIndexOf('\\'));
if (lastSlash === -1) {
return '.';
}
// Special case for root
if (lastSlash === 0) {
return '/';
}
// Special case for Windows drive root (C:\)
if (lastSlash === 2 && path[1] === ':') {
return path.slice(0, 3);
}
return path.slice(0, lastSlash);
}

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