File system on Katalyst Documentation

Extension in

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_extension_in

Purpose#

Allow only specific file extensions.

Configuration keys#

Field	Required	Default	Meaning
`values`	yes	-	Allowed extensions, including the leading dot.

Example#

collections:
 notes:
 path: notes
 pattern: "*"
 checks:
 - kind: filesystem_extension_in
 values: [.md, .markdown]

Index file required

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_index_file_required

Scope: collection, runs once per collection over all its items.

Purpose#

Require that every directory containing items has an index file.

Configuration keys#

Field	Required	Default	Meaning
`name`	no	`_index.md`	Index filename that must be present in each item directory.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_index_file_required

Name affix

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_name_affix

Purpose#

Require a name to start with a prefix and/or end with a suffix.

Configuration keys#

Field	Required	Default	Meaning
`prefix`	no	-	Required name prefix (at least one of prefix/suffix).
`suffix`	no	-	Required name suffix (at least one of prefix/suffix).
`target`	no	`filename`	What to test: `filename`, `filename-ext`, or `parent-dir`.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_name_affix
 prefix: book-

Name case

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_name_case

Purpose#

Require a name (or path segments) to follow a case style.

Configuration keys#

Field	Required	Default	Meaning
`style`	yes	-	One of `kebab`, `snake`, `screaming-snake`, `camel`, `pascal`, `point`, `lower`.
`target`	no	`filename`	What to test: `filename`, `filename-ext`, `parent-dir`, or `path-segments`.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_name_case
 style: kebab

Name length

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_name_length

Purpose#

Bound the character length of a name.

Configuration keys#

Field	Required	Default	Meaning
`min`	no	-	Minimum length (at least one of min/max).
`max`	no	-	Maximum length (at least one of min/max).
`target`	no	`filename`	What to test: `filename`, `filename-ext`, `parent-dir`, or `path-segments`.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_name_length
 max: 80

Name matches field

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_name_matches_field

Purpose#

Require a name to equal a frontmatter field, optionally slugified.

Configuration keys#

Field	Required	Default	Meaning
`field`	no	`slug`	Frontmatter key compared to the name.
`transform`	no	`none`	`none` or `slugify` (applied to the field value before comparison).
`target`	no	`filename`	What to test: `filename`, `filename-ext`, or `parent-dir`.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_name_matches_field
 field: slug

Name regex

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_name_regex

Purpose#

Require a name to match a regular expression (anchored).

Configuration keys#

Field	Required	Default	Meaning
`pattern`	yes	-	Regular expression; matched anchored (`^pattern$`).
`target`	no	`filename`	What to test: `filename`, `filename-ext`, `parent-dir`, or `path-segments`.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_name_regex
 pattern: '[0-9]{4}-[a-z-]+'

Parent directory in

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_parent_dir_in

Purpose#

Require that the file’s parent directory name is in an allowed set.

Configuration keys#

Field	Required	Default	Meaning
`values`	yes	-	Allowed parent directory names.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_parent_dir_in
 values: [books, people]

Parent directory matches field

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_parent_dir_matches_field

Purpose#

Require the parent directory name to equal a frontmatter field.

Configuration keys#

Field	Required	Default	Meaning
`field`	yes	-	Frontmatter key compared to the parent directory name.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_parent_dir_matches_field
 field: category

Path charset

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_path_charset

Purpose#

Constrain the characters allowed in the item’s path.

Configuration keys#

Field	Required	Default	Meaning
`deny`	no	-	Forbidden substrings (e.g. a space). Use `deny` or `allow`, not both.
`allow`	no	-	The only permitted characters; the path separator is always allowed.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_path_charset
 deny: [" "]

Path depth

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_path_depth

Purpose#

Bound directory nesting relative to the collection root.

Configuration keys#

Field	Required	Default	Meaning
`min`	no	-	Minimum depth (at least one of min/max).
`max`	no	-	Maximum depth; `0` means a flat collection (at least one of min/max).

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_path_depth
 max: 0

Referenced files exist

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_referenced_files_exist

Purpose#

Require path-valued frontmatter fields to resolve to real files.

Configuration keys#

Field	Required	Default	Meaning
`fields`	yes	-	Frontmatter keys holding a path (string) or list of paths, resolved relative to the item.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_referenced_files_exist
 fields: [cover, attachments]

Unique filename

Mon, 01 Jan 0001 00:00:00 +0000

Check type ID#

kind: filesystem_unique_filename

Scope: collection, runs once per collection over all its items.

Purpose#

Require that no two items in the collection share a basename.

Example#

collections:
 notes:
 path: notes
 checks:
 - kind: filesystem_unique_filename