UPDATE: badger -> fflint for generated docs

FileFormatInfo · Nov 16, 2023 · 9ea8d2c · 9ea8d2c
1 parent c477a4a
commit 9ea8d2c
Show file tree

Hide file tree

Showing 14 changed files with 739 additions and 729 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # Badger [<img alt="badger logo" src="docs/favicon.svg" height="90" align="right" />](https://www.badger.sh/)
 
-[![build](https://github.com/fileformat/badger/actions/workflows/build.yaml/badge.svg)](https://github.com/fileformat/badger/actions/workflows/build.yaml)
-[![release](https://github.com/fileformat/badger/actions/workflows/release.yaml/badge.svg)](https://github.com/fileformat/badger/actions/workflows/release.yaml)
-[![dogfooding](https://github.com/fileformat/badger/actions/workflows/dogfooding.yaml/badge.svg)](https://github.com/fileformat/badger/actions/workflows/dogfooding.yaml)
+[![build](https://github.com/FileFormatInfo/fflint/actions/workflows/build.yaml/badge.svg)](https://github.com/FileFormatInfo/fflint/actions/workflows/build.yaml)
+[![release](https://github.com/FileFormatInfo/fflintactions/workflows/release.yaml/badge.svg)](https://github.com/FileFormatInfo/fflint/actions/workflows/release.yaml)
+[![dogfooding](https://github.com/FileFormatInfo/fflint/actions/workflows/dogfooding.yaml/badge.svg)](https://github.com/FileFormatInfo/fflint/actions/workflows/dogfooding.yaml)
 
 Badger is a linter for file formats. Are your files:
 * in the correct format?
@@ -14,11 +14,11 @@ Badger is a linter for file formats. Are your files:
 
 Perfect for your CI/CD pipeline to make sure bad files don't get committed.
 
-[**Documentation**](https://www.badger.sh)
+[**Documentation**](https://www.fflint.dev/)
 
 ## Installation
 
-The [latest releases](https://github.com/fileformat/badger/releases/latest) are available on Github. [Detailed instructions](https://www.badger.sh/install.html).
+The [latest releases](https://github.com/FileFormatInfo/fflint/releases/latest) are available on Github. [Detailed instructions](https://www.badger.sh/install.html).
 
 ## Usage
 
@@ -55,4 +55,4 @@ For anyone who cannot use AGPL software, an inexpensive commercial license is av
 * [GoReleaser](https://goreleaser.com/)
 * [mathiasbynens/small](https://github.com/mathiasbynens/small) - sample files for testing
 
-* See [`go.mod`](https://github.com/fileformat/badger/blob/main/go.mod) for the GoLang modules used
+* See [`go.mod`](https://github.com/FileFormatInfo/fflint/blob/main/go.mod) for the GoLang modules used
diff --git a/docs/_commands/ext.md b/docs/_commands/ext.md
@@ -1,73 +1,73 @@
 ---
 h1: The ext Command
-title: 'ext: Validate (or report) file extensions - Badger'
-name: badger ext
+title: 'ext: Validate (or report) file extensions - FFLint'
+name: fflint ext
 synopsis: Validate (or report) file extensions
 description: Check and report on the file extensions in use
-usage: badger ext [flags] filespec [filespec...]
+usage: fflint ext [options] files... [flags]
 options:
-- name: allowEmpty
-  default_value: "true"
-  usage: Allow files without an extension
-- name: allowed
-  default_value: '[]'
-  usage: Allowed extensions
-- name: caseSensitive
-  default_value: "false"
-  usage: Case sensitive
-- name: help
-  shorthand: h
-  default_value: "false"
-  usage: help for ext
-- name: length
-  default_value: any
-  usage: Range of allowed extension lengths
-- name: report
-  default_value: "true"
-  usage: Print summary report
+    - name: allowEmpty
+      default_value: "true"
+      usage: Allow files without an extension
+    - name: allowed
+      default_value: '[]'
+      usage: Allowed extensions
+    - name: caseSensitive
+      default_value: "false"
+      usage: Case sensitive
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for ext
+    - name: length
+      default_value: any
+      usage: Range of allowed extension lengths
+    - name: report
+      default_value: "true"
+      usage: Print summary report
 inherited_options:
-- name: config
-  usage: config file (default is $HOME/.badger.yaml)
-- name: debug
-  default_value: "false"
-  usage: Debugging output
-- name: fail-fast
-  default_value: "false"
-  usage: Stop as soon as any test fails
-- name: filesize
-  default_value: any
-  usage: Range of allowed file size
-- name: glob
-  default_value: doublestar
-  usage: |
-    How to expand [wildcards](/files.html) in file names [ doublestar | golang | none ]
-- name: ignore-dotfiles
-  default_value: "true"
-  usage: Ignore files/directories starting with a dot (.)
-- name: ignore-file
-  default_value: .gitignore
-  usage: ignore file
-- name: output
-  shorthand: o
-  default_value: text
-  usage: Output format [ filenames | json | markdown | text ]
-- name: progress
-  default_value: "true"
-  usage: Show progress bar (default is false when stderr is piped)
-- name: show-detail
-  default_value: "true"
-  usage: Show detailed data about each test
-- name: show-files
-  default_value: none
-  usage: Show each file [ all | failing | none ]
-- name: show-tests
-  default_value: failing
-  usage: Show each test [ all | failing | none ]
-- name: show-totals
-  default_value: "true"
-  usage: Show total files tested, passed and failed
+    - name: config
+      usage: config file (default is $HOME/.badger.yaml)
+    - name: debug
+      default_value: "false"
+      usage: Debugging output
+    - name: fail-fast
+      default_value: "false"
+      usage: Stop as soon as any test fails
+    - name: filesize
+      default_value: any
+      usage: Range of allowed file size
+    - name: glob
+      default_value: doublestar
+      usage: |
+        How to expand [wildcards](/files.html) in file names [ doublestar | golang | none ]
+    - name: ignore-dotfiles
+      default_value: "true"
+      usage: Ignore files/directories starting with a dot (.)
+    - name: ignore-file
+      default_value: .gitignore
+      usage: ignore file
+    - name: output
+      shorthand: o
+      default_value: text
+      usage: Output format [ filenames | json | markdown | text ]
+    - name: progress
+      default_value: "true"
+      usage: Show progress bar (default is false when stderr is piped)
+    - name: show-detail
+      default_value: "true"
+      usage: Show detailed data about each test
+    - name: show-files
+      default_value: none
+      usage: Show each file [ all | failing | none ]
+    - name: show-tests
+      default_value: failing
+      usage: Show each test [ all | failing | none ]
+    - name: show-totals
+      default_value: "true"
+      usage: Show total files tested, passed and failed
 see_also:
-- badger - Badgers you if your file formats are invalid
+    - fflint - A linter to make sure your files are valid
 ---
 {% comment %}NOTE: this file is auto-generated by bin/docgen.sh.  Manual edits will be overwritten!{% endcomment -%}
 {% include command.html %}
diff --git a/docs/_commands/frontmatter.md b/docs/_commands/frontmatter.md
@@ -1,73 +1,76 @@
 ---
 h1: The frontmatter Command
-title: 'frontmatter: Validate frontmatter - Badger'
-name: badger frontmatter
+title: 'frontmatter: Validate frontmatter - FFLint'
+name: fflint frontmatter
 synopsis: Validate frontmatter
 description: Checks that the frontmatter in your files is valid
-usage: badger frontmatter [flags]
+usage: fflint frontmatter [options] files... [flags]
 options:
-- name: forbidden
-  default_value: '[]'
-  usage: Forbidden keys
-- name: help
-  shorthand: h
-  default_value: "false"
-  usage: help for frontmatter
-- name: optional
-  default_value: '[]'
-  usage: Optional keys (only for `--strict`)
-- name: required
-  default_value: '[]'
-  usage: Required keys
-- name: sorted
-  default_value: "false"
-  usage: Keys need to be in alphabetical order
-- name: strict
-  default_value: "false"
-  usage: Strict (keys must be in `--required` or `--optional`)
+    - name: delimiters
+      default_value: '[]'
+      usage: Custom delimiters (if other than `---`, `+++` and `;;;`)
+    - name: forbidden
+      default_value: '[]'
+      usage: Forbidden keys
+    - name: help
+      shorthand: h
+      default_value: "false"
+      usage: help for frontmatter
+    - name: optional
+      default_value: '[]'
+      usage: Optional keys (only for `--strict`)
+    - name: required
+      default_value: '[]'
+      usage: Required keys
+    - name: sorted
+      default_value: "false"
+      usage: Keys need to be in alphabetical order
+    - name: strict
+      default_value: "false"
+      usage: Strict (keys must be in `--required` or `--optional`)
 inherited_options:
-- name: config
-  usage: config file (default is $HOME/.badger.yaml)
-- name: debug
-  default_value: "false"
-  usage: Debugging output
-- name: fail-fast
-  default_value: "false"
-  usage: Stop as soon as any test fails
-- name: filesize
-  default_value: any
-  usage: Range of allowed file size
-- name: glob
-  default_value: doublestar
-  usage: |
-    How to expand [wildcards](/files.html) in file names [ doublestar | golang | none ]
-- name: ignore-dotfiles
-  default_value: "true"
-  usage: Ignore files/directories starting with a dot (.)
-- name: ignore-file
-  default_value: .gitignore
-  usage: ignore file
-- name: output
-  shorthand: o
-  default_value: text
-  usage: Output format [ filenames | json | markdown | text ]
-- name: progress
-  default_value: "true"
-  usage: Show progress bar (default is false when stderr is piped)
-- name: show-detail
-  default_value: "true"
-  usage: Show detailed data about each test
-- name: show-files
-  default_value: none
-  usage: Show each file [ all | failing | none ]
-- name: show-tests
-  default_value: failing
-  usage: Show each test [ all | failing | none ]
-- name: show-totals
-  default_value: "true"
-  usage: Show total files tested, passed and failed
+    - name: config
+      usage: config file (default is $HOME/.badger.yaml)
+    - name: debug
+      default_value: "false"
+      usage: Debugging output
+    - name: fail-fast
+      default_value: "false"
+      usage: Stop as soon as any test fails
+    - name: filesize
+      default_value: any
+      usage: Range of allowed file size
+    - name: glob
+      default_value: doublestar
+      usage: |
+        How to expand [wildcards](/files.html) in file names [ doublestar | golang | none ]
+    - name: ignore-dotfiles
+      default_value: "true"
+      usage: Ignore files/directories starting with a dot (.)
+    - name: ignore-file
+      default_value: .gitignore
+      usage: ignore file
+    - name: output
+      shorthand: o
+      default_value: text
+      usage: Output format [ filenames | json | markdown | text ]
+    - name: progress
+      default_value: "true"
+      usage: Show progress bar (default is false when stderr is piped)
+    - name: show-detail
+      default_value: "true"
+      usage: Show detailed data about each test
+    - name: show-files
+      default_value: none
+      usage: Show each file [ all | failing | none ]
+    - name: show-tests
+      default_value: failing
+      usage: Show each test [ all | failing | none ]
+    - name: show-totals
+      default_value: "true"
+      usage: Show total files tested, passed and failed
 see_also:
-- badger - Badgers you if your file formats are invalid
+    - fflint - A linter to make sure your files are valid
 ---
 {% comment %}NOTE: this file is auto-generated by bin/docgen.sh.  Manual edits will be overwritten!{% endcomment -%}
 {% include command.html %}