Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wmfs/concrete-paths
An option-laden utility which takes general glob-paths, delimited paths etc. and returns an array of absolute paths.
https://github.com/wmfs/concrete-paths
glob package tymly
Last synced: 3 months ago
JSON representation
An option-laden utility which takes general glob-paths, delimited paths etc. and returns an array of absolute paths.
- Host: GitHub
- URL: https://github.com/wmfs/concrete-paths
- Owner: wmfs
- License: mit
- Created: 2018-05-24T09:39:47.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T14:49:36.000Z (3 months ago)
- Last Synced: 2024-10-23T18:12:05.806Z (3 months ago)
- Topics: glob, package, tymly
- Language: JavaScript
- Homepage:
- Size: 479 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# concrete-paths
[](https://www.npmjs.com/package/@wmfs/concrete-paths) [](https://circleci.com/gh/wmfs/concrete-paths) [](https://codecov.io/gh/wmfs/concrete-paths) [](https://www.codefactor.io/repository/github/wmfs/concrete-paths) [](https://dependabot.com/) [](http://commitizen.github.io/cz-cli/) [](https://standardjs.com) [](https://github.com/wmfs/tymly/blob/master/packages/concrete-paths/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fwmfs%2Fconcrete-paths?ref=badge_shield)
> An option-laden utility which takes general glob-paths, delimited paths etc. and returns an array of absolute paths.
## Install
```bash
$ npm install concrete-paths --save
```
__Given a directory containing:__
``` bash
/stuff
/lib
file1.js
file2.js
/logs
log1.txt
log2.txt
/node_modules
/some-package1
foo.txt
bar.txt
/some-package2
foo.txt
bar.txt
/test
test1.js
test2.js
```
Then `concrete-paths` can be used in the following ways:
### Usage 1: Simple glob-pattern string usage
> Please see the `glob` package's [Glob Primer](https://www.npmjs.com/package/glob#glob-primer) for more information with working with glob patterns.
```javascript
const concretePaths = require('concrete-paths')
concretePaths('/stuff/**/*.js').then(
function(result) {
// Result:
// [
// '/stuff/lib/file1.js',
// '/stuff/lib/file2.js',
// '/stuff/test/test1.js',
// '/stuff/test/test2.js'
// ]
}
)
```
### Usage 2: Single `;` delimited string
> Useful when working with values derived from environment variables.
```javascript
const concretePaths = require('concrete-paths')
concretePaths('/stuff/lib/*.js;/stuff/logs/*.js').then(
function(result) {
// Result:
// [
// '/stuff/lib/file1.js',
// '/stuff/lib/file2.js',
// '/stuff/logs/log1.txt',
// '/stuff/logs/log2.txt'
// ]
}
)
```
### Usage 3: Multiple strings via array
> Mix-and-match delimited strings, globs etc. in an array of strings.
```javascript
const concretePaths = require('concrete-paths')
concretePaths(
[
'/stuff/node_modules/some-package1/*',
'/stuff/lib/*.js;/stuff/logs/*.js'
]
).then(
function(result) {
// Result:
// [
// '/stuff/node_modules/some-package1/foo.txt',
// '/stuff/node_modules/some-package1/bar.txt',
// '/stuff/lib/file1.js',
// '/stuff/lib/file2.js',
// '/stuff/logs/log1.txt',
// '/stuff/logs/log2.txt'
// ]
}
)
```
### `concretePaths`(`sourcePaths`, `[options]`) returns `promise`
### `sourcePaths`
### `options`
| Option | Type | Notes |
| ------ | ----- | ------ |
```bash
$ npm test
```
## License
[MIT](https://github.com/wmfs/concrete-paths/blob/master/LICENSE)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fwmfs%2Fconcrete-paths?ref=badge_large)