https://github.com/static-dev/filewrap
:file_folder: A light file wrapper for easier path handling
https://github.com/static-dev/filewrap
Last synced: 9 months ago
JSON representation
:file_folder: A light file wrapper for easier path handling
- Host: GitHub
- URL: https://github.com/static-dev/filewrap
- Owner: static-dev
- License: other
- Created: 2016-05-26T22:36:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-04-24T15:56:23.000Z (almost 9 years ago)
- Last Synced: 2025-06-28T08:59:07.951Z (9 months ago)
- Language: JavaScript
- Homepage:
- Size: 42 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Filewrap
[](https://badge.fury.io/js/filewrap) [](https://travis-ci.org/static-dev/filewrap) [](https://david-dm.org/static-dev/filewrap) [](https://coveralls.io/github/static-dev/filewrap)
A light wrapper for files to make absolute and relative paths easier
> **Note:** This project is in early development, and versioning is a little different. [Read this](http://markup.im/#q4_cRZ1Q) for more details.
### Why should you care?
Sometimes you will have a project where you need to transform paths to and from relative/absolute frequently. It's super annoying to continuously run something like `absolutePath.replace(rootPath, '')` and `path.join(rootPath, relativePath)` whenever this is needed. To make this cleaner and easier, you can use a small wrapper around the file that exposes both paths.
### Installation
`npm install filewrap -S`
> **Note:** This project is compatible with node v6+ only
### Usage
```js
const File = require('filewrap')
const f = new File('/Users/doge/projects', 'personal-site/index.html')
f.relative // personal-site/index.html
f.absolute // /Users/doge/projects/personal-site/index.html
```
If you are starting with an absolute path, you can initialize with the absolute path in the same way, filewrap will figure out the relative path for you and make sure it's formatted consistently.
```js
const File = require('filewrap')
const f = new File('/Users/doge/projects', '/Users/doge/projects/personal-site/index.html')
f.relative // personal-site/index.html
f.absolute // /Users/doge/projects/personal-site/index.html
```
Note that your relative path will _never_ include a leading slash no matter how you initialize, so you can count on this being consistent. And your absolute path will be the `path.join` result of your root and relative paths. Platform-specific directory dividers will always be fully respected.
#### Map Helpers
Now if you have an array of these wrapped files, you may want to quickly unwrap them all into relative or absolute paths. Filewrap also exposes a couple convenient helpers that make this clear and simple:
```js
const {getRelative, getAbsolute} = require('filewrap')
arrayOfFilewrapObjects.map(getRelative)
arrayOfFilewrapObjects.map(getAbsolute)
```
### License & Contributing
- Details on the license [can be found here](LICENSE.md)
- Details on running tests and contributing [can be found here](contributing.md)