https://github.com/stoplightio/path
https://github.com/stoplightio/path
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stoplightio/path
- Owner: stoplightio
- License: apache-2.0
- Created: 2019-06-20T02:35:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T10:25:31.000Z (over 1 year ago)
- Last Synced: 2025-04-05T22:43:22.036Z (about 1 year ago)
- Language: TypeScript
- Size: 1.2 MB
- Stars: 2
- Watchers: 16
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @stoplight/path
- View the changelog: [Releases](https://github.com/stoplightio/path/releases)
### Features
- **Awesome**: It is.
- .. more features
### Installation
Supported in modern browsers and node.
```bash
# latest stable
yarn add @stoplight/path
```
### Usage
```ts
import * as path from '@stoplight/path';
// ...example
```
### Contributing
1. Clone repo.
2. Create / checkout `feature/{name}`, `chore/{name}`, or `fix/{name}` branch.
3. Install deps: `yarn`.
4. Make your changes.
5. Run tests: `yarn test.prod`.
6. Stage relevant files to git.
7. Commit: `yarn commit`. _NOTE: Commits that don't follow the [conventional](https://github.com/marionebl/commitlint/tree/master/%40commitlint/config-conventional) format will be rejected. `yarn commit` creates this format for you, or you can put it together manually and then do a regular `git commit`._
8. Push: `git push`.
9. Open PR targeting the `master` branch.