1.0.1 • Published 8 months ago

glob-concat-cli v1.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
8 months ago

glob-concat-cli

A command-line interface for concatenating files leveraging fast-glob.

Key features

  • Concatenates files on the command line
  • Supports robust glob patterns via fast-glob
  • 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

npm install --dev glob-concat-cli
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.

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 or submit a pull request.

License

This project is licensed under the Apache 2.0 License - see the 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.

1.0.1

8 months ago

1.0.0

8 months ago