Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorskyflyer/npm-upath
🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬
https://github.com/igorskyflyer/npm-upath
back-end biome filepath igorskyflyer linux module node npm operating-system typescript unix upath vitest windows
Last synced: about 2 months ago
JSON representation
🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬
- Host: GitHub
- URL: https://github.com/igorskyflyer/npm-upath
- Owner: igorskyflyer
- License: mit
- Created: 2021-06-23T22:34:48.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-04T18:48:54.000Z (6 months ago)
- Last Synced: 2024-10-05T19:35:07.056Z (3 months ago)
- Topics: back-end, biome, filepath, igorskyflyer, linux, module, node, npm, operating-system, typescript, unix, upath, vitest, windows
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@igor.dvlpr/upath
- Size: 309 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# uPath
🎍 Provides a universal way of formatting file-paths in Unix-like and Windows operating systems as an alternative to the built-in path.normalize(). 🧬
💖 Support further development
I work hard for every project, including this one and your support means a lot to me!
Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊
@igorskyflyer
> Why `uPath`? Simple. Working with file paths inside `String`s in **Windows** + **JavaScript** is a hassle. By calling `u()`, the file path you provided is converted to your OS-preferred file path format, i.e. you can get away with writing "`C:/Users/JohnDoe/`" without having to worry about those backslashes that **Windows** uses. On the other hand, **UNIX-like** slashes in file paths are left as-is. An extra feature that `uPath` provides is redundant trailing slash removal.
✨Since version `1.2.0` support for UNC paths has been added, thanks to [unc-path](https://www.npmjs.com/package/@igor.dvlpr/unc-path).
## 🕵🏼 Usage
Install it by executing:
```shell
npm i "@igor.dvlpr/upath"
```
## 🤹🏼 API
`upath()` `=>` returns a proper file path depending on the host OS.
✨Note: `upath()` has an alias, named `u()` for your convenience.
Signature
```ts
upath(fsPath: string, addTrailingSlash: boolean = false): string
```
```ts
u(fsPath: string, addTrailingSlash: boolean = false): string
```
Parameters
```ts
fsPath: string // a string that represents the path to process,
addTrailingSlash: boolean = false
// a boolean that represents whether a trailing slash should be added to the fsPath or not
```
#### Example - Windows OS
```ts
import { u } from '@igor.dvlpr/upath'
console.log(u('C:/')) // returns 'C:\\'
console.log(u('C:/WINDOWS//////')) // returns 'C:\\WINDOWS\\'
console.log(u('C:/Users', true)) // returns 'C:\\Users\\'
console.log(u('\\\\ComputerName\\SharedFolder')) // returns '\\\\ComputerName\\SharedFolder'
console.log(u('//ComputerName/SharedFolder')) // returns '\\\\ComputerName\\SharedFolder'
```
#### Example - UNIX-like OS
```ts
import { u } from '@igor.dvlpr/upath'
console.log(u('/mnt/')) // returns '/mnt/'
console.log(u('/usr/bin/////////')) // returns '/usr/bin/'
console.log(u('/usr/bin', true)) // returns '/usr/bin/'
console.log(u('//ComputerName/SharedFolder')) // returns '//ComputerName/SharedFolder'
console.log(u('\\\\ComputerName\\SharedFolder')) // returns '//ComputerName/SharedFolder'
```
`uw()` `=>` returns a proper file path for Windows operating system.
Signature
```ts
uw(fsPath: string, addTrailingSlash: boolean = false): string
```
Parameters
```ts
fsPath: string // a string that represents the path to process,
addTrailingSlash: boolean = false
// a boolean that represents whether a trailing slash should be added to the fsPath or not
```
#### Example - Any OS
```ts
import { uw } from '@igor.dvlpr/upath'
console.log(uw('C:/WINDOWS/System32')) // returns 'C:\\WINDOWS\\System32'
console.log(uw('//ComputerName/SharedFolder')) // returns '\\\\ComputerName\\SharedFolder'
```
`ux()` `=>` returns a proper file path for UNIX-like operating systems.
Signature
```ts
ux(fsPath: string, addTrailingSlash: boolean = false): string
```
Parameters
```ts
fsPath: string // a string that represents the path to process,
addTrailingSlash: boolean = false
// a boolean that represents whether a trailing slash should be added to the fsPath or not
```
#### Example - Any OS
```ts
import { ux } from '@igor.dvlpr/upath'
console.log(ux('/usr/local')) // returns '/usr/local'
console.log(ux('\\\\ComputerName\\SharedFolder'))
// returns '//ComputerName/SharedFolder'
```
✨ Since `v.1.0.3` a string property named `slash` is exposed as well, provides an easy way to access file path OS-specific delimiter.
> On Windows `slash = '\\'`.
> On UNIX-like `slash = '/'`.
---
## 🪪 License
Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-upath/blob/main/LICENSE).
---
## 🧬 Related
[@igor.dvlpr/duoscribi](https://www.npmjs.com/package/@igor.dvlpr/duoscribi)
> _✒ DúöScríbî allows you to convert letters with diacritics to regular letters. 🤓_
[@igor.dvlpr/node-clone-js](https://www.npmjs.com/package/@igor.dvlpr/node-clone-js)
> _🧬 A lightweight JavaScript utility allowing deep copy-by-value of nested objects, arrays and arrays of objects. 🪁_
[@igor.dvlpr/str-is-in](https://www.npmjs.com/package/@igor.dvlpr/str-is-in)
> _🧵 Provides ways of checking whether a String is present in an Array of Strings using custom Comparators. 🔍_
[@igor.dvlpr/odin](https://www.npmjs.com/package/@igor.dvlpr/odin)
> _🔱 Odin is an Object wrapper that allows you to create objects and set their attributes - all at once! 🔺_
[@igor.dvlpr/mp3size](https://www.npmjs.com/package/@igor.dvlpr/mp3size)
> _🧮 Calculates an estimated file size of Mp3 files. 🎶_
>
> Provided by **Igor Dimitrijević** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).
>