Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/castastrophe/glob-concat-cli
A command-line interface for concatenating files supporting glob syntax
https://github.com/castastrophe/glob-concat-cli
Last synced: about 1 month ago
JSON representation
A command-line interface for concatenating files supporting glob syntax
- Host: GitHub
- URL: https://github.com/castastrophe/glob-concat-cli
- Owner: castastrophe
- License: apache-2.0
- Created: 2023-09-12T15:43:16.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-02T23:58:00.000Z (about 1 month ago)
- Last Synced: 2024-10-14T07:53:24.554Z (about 1 month ago)
- Language: JavaScript
- Size: 566 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# glob-concat-cli
> A command-line interface for concatenating files leveraging [fast-glob](https://github.com/mrmlnc/fast-glob#fast-glob).
## Key features
- Concatenates files on the command line
- Supports robust glob patterns via [fast-glob](https://github.com/mrmlnc/fast-glob#pattern-syntax)
- Allows empty files to be ignored (great for use with automated build tools)
- Can output to stdout or a file
- Provides a sourcemap for the concatenated files by default
## Install
```sh
npm install --dev glob-concat-cli
```
```sh
yarn add --dev glob-concat-cli
```
## API
### `files`
Type: `string[]`
Alias: `f`
Required: `true`
The files to concatenate. Supports glob patterns via fast-glob. This is the only required option.
### `output`
Type: `string`
Alias: `o`
Default: `stdout`
The file to output the concatenated files to. If not provided, the concatenated files will be output to stdout.
### `allowEmpty`
Type: `boolean`
Alias: `ae`
Default: `true`
Whether to fail the command if no files are found or if any of the provided inputs can't be found. If set to `true`, the command will exit with a status code of `0` and no output will be written.
### `sourcemap`
Type: `boolean`
Alias: `map`
Default: `true`
Whether to output a sourcemap for the concatenated files. If set to `false`, no sourcemap will be written to disk.
### Other supported options
When leveraging this package, you can also pass in any of the options supported by [fast-glob](https://github.com/mrmlnc/fast-glob#options-3).
Due to how this utility is built, the following options are not supported:
- `onlyDirectories` (this is always set to `false` because this utility is meant to concatenate files)
- `stats`
- `objectMode`
## Contributing
Contributions are welcome! Please open an [issue](https://github.com/castastrophe/glob-concat-cli/issues/new) or submit a pull request.
## License
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details. This means you can use this however you like as long as you provide attribution back to this one. It's nice to share but it's also nice to get credit for your work. 😉
## Funding ☕️
I am gainfully employed at the moment, however, if you find this plugin useful and would like to buy me a coffee/beer as a small thank you, I would greatly appreciate it! Funding links are available in the GitHub UI for this repo.