Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danburzo/yamatter
Inspect and transform YAML frontmatter data from the command line.
https://github.com/danburzo/yamatter
cli yaml
Last synced: 4 months ago
JSON representation
Inspect and transform YAML frontmatter data from the command line.
- Host: GitHub
- URL: https://github.com/danburzo/yamatter
- Owner: danburzo
- License: mit
- Created: 2023-02-13T13:00:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T13:38:44.000Z (6 months ago)
- Last Synced: 2024-10-15T09:04:16.004Z (4 months ago)
- Topics: cli, yaml
- Language: JavaScript
- Homepage: https://danburzo.ro/projects/yamatter/
- Size: 165 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Yamatter is a command-line tool to inspect and transform YAML front-matter data using [`js-yaml`](https://github.com/nodeca/js-yaml).
## Installation
Install `yamatter` globally with `npm`:
```bash
npm install -g yamatter
```
Run `yamatter` without installing it with `npx`:
```bash
npx yamatter
```
## Usage
```bash
yamatter [OPTIONS] [PATTERN ...]
```
### Operands
The `yamatter` command accepts one or more glob patterns to match the files from which to read front-matter data.
The patterns are expanded by [`fast-glob`](https://github.com/mrmlnc/fast-glob). In order for the glob patterns to be expanded with `fast-glob` and not the shell that runs the command (e.g. `sh`, `bash`, `zsh`), make sure pass them enclosed in quotes:
```bash
yamatter 'content/**/*.md' 'notes/*.md'
```
`yamatter` looks for lines beginning with three or more hyphens (`---`) as the delimiter for front-matter data. Any matching files without front-matter data delimiters are ignored.
By default, `yamatter` ignores files matched by patterns inside `.gitignore`, if it finds one in the current working directory. It does not look for other `.gitignore` files neither up, nor down, the file system hierarchy. You can disable the ignore behavior with the `--no-ignore` flag.
Symbolic links (symlinks) are not followed. This helps avoid accidentally processing files outside the current working directory.
### Options
#### `--no-ignore`
Don’t ignore files based on patterns found in `.gitignore`.
#### `--silent`
Don’t output to the standard output.
#### `--no-filename`
Don’t output filenames to the standard output.
#### `--json`
When outputting to the standard output, serialize the data as JSON instead of YAML.
#### `-t , --transform=`
Point to a JavaScript module, relative to the current working directory, that performs a transformation on the front-matter data.
The module must export a function that receives these arguments:
* `data`: a JSON object corresponding to the original front-matter data
* `filepath`: the source file path, relative to the current working directory
You can alter `data` directly, or return a new object in its place.
```bash
yamatter '*.md' -t to-uppercase.js
```
__to-uppercase.js__:
```js
module.exports = function(data, filepath) {
data.title = data.title.toUpperCase();
};
```
#### `-w, --write`
Write the result of the transformation back to the file.
__Pro tip:__ Since this has the potential to be destructive, it is recommended that you run any `yamatter --write` commands in a folder that’s managed by a source control system such as Git, with any pending changes committed. This makes it easy to revert the files back to their original content.
#### `--glob.=`
Pass options to [`fast-glob`](https://github.com/mrmlnc/fast-glob) directly. These options are passed by default:
```json
{
"followSymbolicLinks": false
}
```
Boolean and numeric values are cast to their respective data types. Other values are passed as strings, which limits the amount of `fast-glob` customization available.
#### `--yaml.=`
Pass serialization options to [`js-yaml`](https://github.com/nodeca/js-yaml)’s `dump()` method. These options are passed by default:
```json
{
"lineWidth": -1
}
```
Boolean and numeric values are cast to their respective data types. Other values are passed as strings, which limits the amount of `js-yaml` customization available.
## See also
* [mikefarah/yq](https://github.com/mikefarah/yq)
* [dbohdan/structured-text-tools](https://github.com/dbohdan/structured-text-tools)