Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joellefkowitz/fs-friend

Functional interface for path transformations and filesystem effects.
https://github.com/joellefkowitz/fs-friend

filesystem lstat path

Last synced: 20 days ago
JSON representation

Functional interface for path transformations and filesystem effects.

Host: GitHub
URL: https://github.com/joellefkowitz/fs-friend
Owner: JoelLefkowitz
License: mit
Created: 2024-04-30T13:40:36.000Z (7 months ago)
Default Branch: master
Last Pushed: 2024-06-27T18:06:06.000Z (5 months ago)
Last Synced: 2024-10-03T21:47:40.684Z (about 1 month ago)
Topics: filesystem, lstat, path
Language: TypeScript
Size: 104 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # FS friend

Functional interface for path transformations and filesystem effects.

![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/fs-friend/review.yml)

![Version](https://img.shields.io/npm/v/fs-friend)

![Downloads](https://img.shields.io/npm/dw/fs-friend)

![Size](https://img.shields.io/bundlephobia/min/fs-friend)

![Quality](https://img.shields.io/codacy/grade/_)

![Coverage](https://img.shields.io/codacy/coverage/_)

## Installing

```bash

npm install fs-friend

```

## Documentation

Documentation and more detailed examples are hosted on [Github Pages](https://joellefkowitz.github.io/fs-friend).

## Tooling

### Dependencies

To install dependencies:

```bash

yarn install

```

### Tests

To run tests:

```bash

yarn test

```

### Documentation

To generate the documentation locally:

```bash

yarn docs

```

### Linters

To run linters:

```bash

yarn lint

```

### Formatters

To run formatters:

```bash

yarn format

```

## Contributing

Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).

Bump2version is used to version and tag changes. For example:

```bash

bump2version patch

```

### Contributors

- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work

## Remarks

Lots of love to the open source community!