Compare commits
47 Commits
Author | SHA1 | Date | |
---|---|---|---|
ae736d5dbb | |||
7686c417b1 | |||
65cb98d031 | |||
55fc30139f | |||
be85880e54 | |||
ebc523cb9f | |||
6fae04e92a | |||
de54eb828f | |||
bf6ed38083 | |||
b53d74cd55 | |||
7cc6127680 | |||
10bda971fb | |||
e578601b49 | |||
1558a9148b | |||
fad06e3c33 | |||
b51ccda39e | |||
071e17d8bf | |||
07e13ed9be | |||
e3f6c0a8a1 | |||
db7dc635f1 | |||
8bb10f45b3 | |||
68ccb0e708 | |||
fc51d498c7 | |||
6474016fc1 | |||
ea42dbd1c3 | |||
9e8ce8215c | |||
b02ab97d4f | |||
ecfefc250c | |||
dde9948404 | |||
d041d8de68 | |||
f03b3df55b | |||
ca387124ee | |||
027b3fe9ad | |||
1b4681c065 | |||
96168fd870 | |||
e81c37e60a | |||
87454d41da | |||
97ae2d87b1 | |||
e23624a93f | |||
7183fcc00a | |||
9fad6100f0 | |||
d0e3065d12 | |||
5245e50f3d | |||
00bb39b8fe | |||
ddfae30a18 | |||
618b3da86e | |||
482bc6c18e |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal 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
|
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal 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
|
@ -12,6 +12,9 @@ stages:
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
@ -19,23 +22,36 @@ mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
audit:
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
@ -50,9 +66,7 @@ testStable:
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
@ -63,9 +77,7 @@ testBuild:
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
release:
|
||||
stage: release
|
||||
@ -85,6 +97,8 @@ release:
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
@ -109,9 +123,9 @@ trigger:
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci node install stable
|
||||
- npmci npm prepare
|
||||
- npmci command npm install -g @git.zone/tsdoc
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
|
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@ -15,7 +15,7 @@
|
||||
"properties": {
|
||||
"projectType": {
|
||||
"type": "string",
|
||||
"enum": ["website", "element", "service", "npm"]
|
||||
"enum": ["website", "element", "service", "npm", "wcc"]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
@ -1,19 +1,36 @@
|
||||
{
|
||||
"npmci": {
|
||||
"npmGlobalTools": [
|
||||
"@gitzone/npmts"
|
||||
],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartpath",
|
||||
"shortDescription": "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"
|
||||
}
|
||||
}
|
1526
package-lock.json
generated
1526
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
48
package.json
48
package.json
@ -1,36 +1,49 @@
|
||||
{
|
||||
"name": "@pushrocks/smartpath",
|
||||
"version": "4.0.2",
|
||||
"name": "@push.rocks/smartpath",
|
||||
"version": "5.0.18",
|
||||
"private": false,
|
||||
"description": "offers smart ways to handle paths",
|
||||
"description": "A library offering smart ways to handle file and directory paths.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"test": "(tstest test)",
|
||||
"build": "(tsbuild)"
|
||||
"build": "(tsbuild --allowimplicitany)",
|
||||
"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",
|
||||
"dependencies": {},
|
||||
"homepage": "https://code.foss.global/push.rocks/smartpath",
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.17",
|
||||
"@gitzone/tsrun": "^1.2.8",
|
||||
"@gitzone/tstest": "^1.0.28",
|
||||
"@pushrocks/tapbundle": "^3.2.0",
|
||||
"@types/node": "^10.5.2"
|
||||
"@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/**/*",
|
||||
@ -43,5 +56,8 @@
|
||||
"cli.js",
|
||||
"npmextra.json",
|
||||
"readme.md"
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
}
|
||||
}
|
4814
pnpm-lock.yaml
generated
Normal file
4814
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
no specific hints here, should be easy to understand from the files.
|
107
readme.md
Normal file
107
readme.md
Normal file
@ -0,0 +1,107 @@
|
||||
# @push.rocks/smartpath
|
||||
|
||||
[@push.rocks/smartpath](https://github.com/pushrocks/smartpath) offers smart ways to handle paths.
|
||||
|
||||
## 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.
|
||||
|
||||
### Getting Started
|
||||
To begin utilizing `smartpath` in your project, start by importing it in your TypeScript file:
|
||||
|
||||
```typescript
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
```
|
||||
|
||||
### 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.
|
38
test/test.ts
38
test/test.ts
@ -1,11 +1,11 @@
|
||||
import { tap, expect } from '@pushrocks/tapbundle';
|
||||
import * as smartpath from '../ts/index';
|
||||
import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
|
||||
import * as smartpath from '../ts/index.js';
|
||||
|
||||
let mySmartpath: smartpath.Smartpath;
|
||||
tap.test('expect create a valid instance', async () => {
|
||||
mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
|
||||
expect(mySmartpath).to.be.instanceof(smartpath.Smartpath);
|
||||
expect(mySmartpath.pathLevelsBackwards).to.be.of.length(5);
|
||||
expect(mySmartpath).toBeInstanceOf(smartpath.Smartpath);
|
||||
expect(mySmartpath.pathLevelsBackwards.length === 5).toBeTrue();
|
||||
});
|
||||
|
||||
let filePathString = './somedir/somefile.json';
|
||||
@ -13,21 +13,21 @@ let dirPathString = './somedir/anotherdir';
|
||||
let dirPathString2 = './somedir/another.dir/';
|
||||
|
||||
tap.test('expect be true for a file path', async () => {
|
||||
expect(smartpath.check.isFile(filePathString)).to.be.true;
|
||||
expect(smartpath.check.isFile(filePathString)).toBeTrue();
|
||||
});
|
||||
tap.test('expect be false for a directory path', async () => {
|
||||
expect(smartpath.check.isFile(dirPathString)).to.be.false;
|
||||
expect(smartpath.check.isFile(dirPathString2)).to.be.false;
|
||||
expect(smartpath.check.isFile(dirPathString)).toBeFalse();
|
||||
expect(smartpath.check.isFile(dirPathString2)).toBeFalse();
|
||||
});
|
||||
|
||||
tap.test('expect be true for a directory path', async () => {
|
||||
expect(smartpath.check.isDir(dirPathString)).to.be.true;
|
||||
expect(smartpath.check.isDir(dirPathString)).toBeTrue();
|
||||
|
||||
expect(smartpath.check.isDir(dirPathString2)).to.be.true;
|
||||
expect(smartpath.check.isDir(dirPathString2)).toBeTrue();
|
||||
});
|
||||
|
||||
tap.test('expect be false for a file path', async () => {
|
||||
expect(smartpath.check.isDir(filePathString)).to.be.false;
|
||||
expect(smartpath.check.isDir(filePathString)).toBeFalse();
|
||||
});
|
||||
|
||||
let baseString = '/basedir';
|
||||
@ -35,25 +35,25 @@ let relativeString = 'somedir/somefile.txt';
|
||||
let relativeString2 = 'anotherdir/anotherfile.txt';
|
||||
let relativeArray = [relativeString, relativeString, relativeString2];
|
||||
tap.test('expect make a string absolute', async () => {
|
||||
expect(smartpath.transform.toAbsolute(relativeString)).startWith('/');
|
||||
expect(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString);
|
||||
expect(smartpath.transform.toAbsolute(relativeString, baseString)).equal(
|
||||
expect(smartpath.transform.toAbsolute(relativeString)).toStartWith('/');
|
||||
expect(smartpath.transform.toAbsolute(relativeString)).toEndWith(relativeString);
|
||||
expect(smartpath.transform.toAbsolute(relativeString, baseString)).toEqual(
|
||||
'/basedir/somedir/somefile.txt'
|
||||
);
|
||||
});
|
||||
tap.test('expect make an array of relative Strings an Array of absolute Strings', async () => {
|
||||
let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString);
|
||||
expect(absoluteArray[2]).to.startWith('/');
|
||||
expect(absoluteArray[2]).endWith(relativeString2);
|
||||
expect(absoluteArray[2]).toStartWith('/');
|
||||
expect(absoluteArray[2]).toEndWith(relativeString2);
|
||||
});
|
||||
|
||||
tap.test("expect return 'url' for an URL", async () => {
|
||||
expect(smartpath.get.type('https://push.rocks/some/url')).equal('url');
|
||||
expect(smartpath.get.type('https://push.rocks/some/url')).not.equal('local');
|
||||
expect(smartpath.get.type('https://push.rocks/some/url')).toEqual('url');
|
||||
expect(smartpath.get.type('https://push.rocks/some/url')).not.toEqual('local');
|
||||
});
|
||||
tap.test("expect return 'path' for a Path", async () => {
|
||||
expect(smartpath.get.type('/some/absolute/path/')).equal('local');
|
||||
expect(smartpath.get.type('./some/relative/path/')).not.equal('url');
|
||||
expect(smartpath.get.type('/some/absolute/path/')).toEqual('local');
|
||||
expect(smartpath.get.type('./some/relative/path/')).not.toEqual('url');
|
||||
});
|
||||
|
||||
tap.test('expect a absolute path for an home relative URL', async () => {
|
||||
|
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal 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.'
|
||||
}
|
12
ts/index.ts
12
ts/index.ts
@ -1,8 +1,12 @@
|
||||
import * as plugins from './smartpath.plugins.js';
|
||||
|
||||
// import modules
|
||||
import * as check from './smartpath.check';
|
||||
import * as get from './smartpath.get';
|
||||
import * as transform from './smartpath.transform';
|
||||
import * as check from './smartpath.check.js';
|
||||
import * as get from './smartpath.get.js';
|
||||
import * as transform from './smartpath.transform.js';
|
||||
|
||||
export { check, get, transform };
|
||||
|
||||
export * from './smartpath.classes.smartpath';
|
||||
export const join = (...args: string[]) => plugins.path.join(...args);
|
||||
|
||||
export * from './smartpath.classes.smartpath.js';
|
||||
|
@ -1,9 +1,9 @@
|
||||
import plugins = require('./smartpath.plugins');
|
||||
import * as plugins from './smartpath.plugins.js';
|
||||
|
||||
export let isDir = function(pathArg: string) {
|
||||
export let isDir = function (pathArg: string) {
|
||||
return !isFile(pathArg);
|
||||
};
|
||||
|
||||
export let isFile = function(pathArg) {
|
||||
export let isFile = function (pathArg) {
|
||||
return /\.[a-zA-Z]*$/.test(pathArg); // checks if there is a .anything at the end
|
||||
};
|
||||
|
@ -1,5 +1,5 @@
|
||||
import * as plugins from './smartpath.plugins';
|
||||
import * as getMod from './smartpath.get';
|
||||
import * as plugins from './smartpath.plugins.js';
|
||||
import * as getMod from './smartpath.get.js';
|
||||
|
||||
export class Smartpath {
|
||||
originalPath: string;
|
||||
|
@ -1,11 +1,12 @@
|
||||
import plugins = require('./smartpath.plugins');
|
||||
import * as plugins from './smartpath.plugins.js';
|
||||
export type TPathType = 'url' | 'local';
|
||||
|
||||
/**
|
||||
* returns the type of the given path. Can be "url" or "local"
|
||||
* returns the type of the given path.
|
||||
* Can be "url" or "local"
|
||||
*/
|
||||
export let type = function(pathStringArg: string): TPathType {
|
||||
let urlRegex = /http[s|\s]:\/\/.*/i;
|
||||
export const type = (pathStringArg: string): TPathType => {
|
||||
const urlRegex = /http[s|\s]:\/\/.*/i;
|
||||
if (urlRegex.exec(pathStringArg)) {
|
||||
return 'url';
|
||||
} else {
|
||||
@ -13,7 +14,23 @@ 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));
|
||||
};
|
||||
|
||||
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) {
|
||||
return pathArgument.replace('~', plugins.os.homedir());
|
||||
} else {
|
||||
@ -23,7 +40,7 @@ export let home = function(pathArgument?: string) {
|
||||
|
||||
export type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx';
|
||||
|
||||
export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
|
||||
export const pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
|
||||
let pathLevelArray: string[];
|
||||
if (systemArg === 'dynamic') {
|
||||
pathLevelArray = pathArg.split(plugins.path.sep);
|
||||
@ -31,6 +48,6 @@ export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') =>
|
||||
return pathLevelArray;
|
||||
};
|
||||
|
||||
export let pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
|
||||
export const pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
|
||||
return pathLevels(pathArg, systemArg).reverse();
|
||||
};
|
||||
|
@ -1,4 +1,5 @@
|
||||
import * as os from 'os';
|
||||
import * as path from 'path';
|
||||
import * as url from 'url';
|
||||
|
||||
export { os, path };
|
||||
export { os, path, url };
|
||||
|
@ -1,16 +1,24 @@
|
||||
import plugins = require('./smartpath.plugins');
|
||||
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?: strin
|
||||
'smartpath.absolute() could not make sense of the input. ' +
|
||||
'Input is neither String nor Array'
|
||||
);
|
||||
return false;
|
||||
return null;
|
||||
}
|
||||
};
|
||||
|
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
Loading…
x
Reference in New Issue
Block a user