diff --git a/README.md b/README.md index 9b2c14a..966b57b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Badger [badger logo](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 index 5ef9cd5..7f3c898 100644 --- 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 index d8bcd50..f98f7e4 100644 --- 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 %} diff --git a/docs/_commands/html.md b/docs/_commands/html.md index e7453b6..51a3926 100644 --- a/docs/_commands/html.md +++ b/docs/_commands/html.md @@ -1,58 +1,58 @@ --- h1: The html Command -title: 'html: Validate HTML files - Badger' -name: badger html +title: 'html: Validate HTML files - FFLint' +name: fflint html synopsis: Validate HTML files description: Check HTML files for errors -usage: badger html [options] files... [flags] +usage: fflint html [options] files... [flags] options: -- name: help - shorthand: h - default_value: "false" - usage: help for html + - name: help + shorthand: h + default_value: "false" + usage: help for html 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/ico.md b/docs/_commands/ico.md index eea96c7..e409d92 100644 --- a/docs/_commands/ico.md +++ b/docs/_commands/ico.md @@ -1,67 +1,67 @@ --- h1: The ico Command -title: 'ico: Validate icons - Badger' -name: badger ico +title: 'ico: Validate icons - FFLint' +name: fflint ico synopsis: Validate icons description: Check that your icons (.ico files) are valid -usage: badger ico [options] files... [flags] +usage: fflint ico [options] files... [flags] options: -- name: help - shorthand: h - default_value: "false" - usage: help for ico -- name: optional - default_value: '[48,64,96,128]' - usage: Optional sizes (only for `--strict`) -- name: required - default_value: '[16,32]' - usage: Required sizes -- name: strict - default_value: "true" - usage: Strict (sizes must be in `--required` or `--optional`) + - name: help + shorthand: h + default_value: "false" + usage: help for ico + - name: optional + default_value: '[48,64,96,128]' + usage: Optional sizes (only for `--strict`) + - name: required + default_value: '[16,32]' + usage: Required sizes + - name: strict + default_value: "true" + usage: Strict (sizes 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 %} diff --git a/docs/_commands/jpeg.md b/docs/_commands/jpeg.md index 7bdd569..3511b74 100644 --- a/docs/_commands/jpeg.md +++ b/docs/_commands/jpeg.md @@ -1,64 +1,64 @@ --- h1: The jpeg Command -title: 'jpeg: Validate JPEG images - Badger' -name: badger jpeg +title: 'jpeg: Validate JPEG images - FFLint' +name: fflint jpeg synopsis: Validate JPEG images description: Check that your JPEG files are valid -usage: badger jpeg [flags] +usage: fflint jpeg [options] files... [flags] options: -- name: height - default_value: any - usage: Range of allowed JPEG heights -- name: help - shorthand: h - default_value: "false" - usage: help for jpeg -- name: width - default_value: any - usage: Range of allowed JPEG widths + - name: height + default_value: any + usage: Range of allowed JPEG heights + - name: help + shorthand: h + default_value: "false" + usage: help for jpeg + - name: width + default_value: any + usage: Range of allowed JPEG widths 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/json.md b/docs/_commands/json.md index 38c504d..58ecd6e 100644 --- a/docs/_commands/json.md +++ b/docs/_commands/json.md @@ -1,58 +1,60 @@ --- h1: The json Command -title: 'json: Validate JSON files - Badger' -name: badger json +title: 'json: Validate JSON files - FFLint' +name: fflint json synopsis: Validate JSON files description: Check that your JSON files are valid -usage: badger json [flags] +usage: fflint json [options] files... [flags] options: -- name: help - shorthand: h - default_value: "false" - usage: help for json + - name: help + shorthand: h + default_value: "false" + usage: help for json + - name: schema + usage: JSON Schema to validate against 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/mimetype.md b/docs/_commands/mimetype.md index bdb4bf7..143f05a 100644 --- a/docs/_commands/mimetype.md +++ b/docs/_commands/mimetype.md @@ -1,66 +1,65 @@ --- h1: The mimetype Command -title: 'mimetype: Validate (or report) MIME content types - Badger' -name: badger mimetype +title: 'mimetype: Validate (or report) MIME content types - FFLint' +name: fflint mimetype synopsis: Validate (or report) MIME content types description: Check and report on the MIME content types in use -usage: badger mimetype [flags] files... +usage: fflint mimetype [options] files... [flags] options: -- name: allowUnknown - default_value: "true" - usage: Allow application/octet-stream -- name: help - shorthand: h - default_value: "false" - usage: help for mimetype -- name: report - default_value: "true" - usage: Print summary report (default is true) + - name: allowUnknown + default_value: "true" + usage: Allow application/octet-stream + - name: help + shorthand: h + default_value: "false" + usage: help for mimetype + - name: report + default_value: "true" + usage: Print summary report (default is true) 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 -example: Content type detection uses the Go standard library [http.DetectContentType](https://golang.org/pkg/net/http/#DetectContentType) - function. + - 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 +example: Content type detection uses the Go standard library [http.DetectContentType](https://golang.org/pkg/net/http/#DetectContentType) function. 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/png.md b/docs/_commands/png.md index da37558..80a8887 100644 --- a/docs/_commands/png.md +++ b/docs/_commands/png.md @@ -1,64 +1,64 @@ --- h1: The png Command -title: 'png: Validate png images - Badger' -name: badger png +title: 'png: Validate png images - FFLint' +name: fflint png synopsis: Validate png images description: Check that your PNG files are valid -usage: badger png [flags] +usage: fflint png [options] files... [flags] options: -- name: height - default_value: any - usage: Range of allowed PNG heights -- name: help - shorthand: h - default_value: "false" - usage: help for png -- name: width - default_value: any - usage: Range of allowed PNG widths + - name: height + default_value: any + usage: Range of allowed PNG heights + - name: help + shorthand: h + default_value: "false" + usage: help for png + - name: width + default_value: any + usage: Range of allowed PNG widths 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/svg.md b/docs/_commands/svg.md index f0890b6..e869bbb 100644 --- a/docs/_commands/svg.md +++ b/docs/_commands/svg.md @@ -1,77 +1,83 @@ --- h1: The svg Command -title: 'svg: Validate SVG images - Badger' -name: badger svg +title: 'svg: Validate SVG images - FFLint' +name: fflint svg synopsis: Validate SVG images description: | - Check that SVG files are error free and (optionally) don't have any undesirable things in them. -usage: badger svg [flags] + Check that SVG files are error free and (optionally) don't have any undesirable things in them. +usage: fflint svg [options] files... [flags] options: -- name: height - default_value: any - usage: Range of allowed SVG heights -- name: help - shorthand: h - default_value: "false" - usage: help for svg -- name: namespace - default_value: "true" - usage: Check namespaces -- name: namespaces - default_value: '[]' - usage: | - Additional namespaces allowed when checking namespaces (`*` for all) -- name: text - default_value: "false" - usage: Allow text nodes -- name: viewbox - usage: Ranges of allowed SVG viewBox values -- name: width - default_value: any - usage: Range of allowed SVG widths + - name: foreign + default_value: "false" + usage: Allow foreign objects + - name: height + default_value: any + usage: Range of allowed SVG heights + - name: help + shorthand: h + default_value: "false" + usage: help for svg + - name: images + default_value: none + usage: Embedded image control [ any | embedded | external | none ] + - name: namespace + default_value: "true" + usage: Check namespaces + - name: namespaces + default_value: '[]' + usage: | + Additional namespaces allowed when checking namespaces (`*` for all) + - name: text + default_value: "false" + usage: Allow text nodes + - name: viewbox + usage: Ranges of allowed SVG viewBox values + - name: width + default_value: any + usage: Range of allowed SVG widths 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/text.md b/docs/_commands/text.md index 2e1f221..d9e0b1e 100644 --- a/docs/_commands/text.md +++ b/docs/_commands/text.md @@ -1,71 +1,71 @@ --- h1: The text Command -title: 'text: Validate plain text files - Badger' -name: badger text +title: 'text: Validate plain text files - FFLint' +name: fflint text synopsis: Validate plain text files description: | - Checks that plain text files really are plain text, have the correct line endings and more -usage: badger text [flags] + Checks that plain text files really are plain text, have the correct line endings and more +usage: fflint text [options] files... [flags] options: -- name: ascii - default_value: "false" - usage: Must be valid ASCII -- name: control - default_value: "false" - usage: Allow control characters (other than newlines and tab) -- name: help - shorthand: h - default_value: "false" - usage: help for text -- name: nul - default_value: "false" - usage: Allow nul (0x00) bytes -- name: utf8 - default_value: "true" - usage: Must be valid UTF-8 + - name: ascii + default_value: "false" + usage: Must be valid ASCII + - name: control + default_value: "false" + usage: Allow control characters (other than newlines and tab) + - name: help + shorthand: h + default_value: "false" + usage: help for text + - name: nul + default_value: "false" + usage: Allow nul (0x00) bytes + - name: utf8 + default_value: "true" + usage: Must be valid UTF-8 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/version.md b/docs/_commands/version.md index e17bd2b..e8378b7 100644 --- a/docs/_commands/version.md +++ b/docs/_commands/version.md @@ -1,57 +1,57 @@ --- h1: The version Command -title: 'version: Prints badger version information - Badger' -name: badger version +title: 'version: Prints badger version information - FFLint' +name: fflint version synopsis: Prints badger version information -usage: badger version [flags] +usage: fflint version [flags] options: -- name: help - shorthand: h - default_value: "false" - usage: help for version + - name: help + shorthand: h + default_value: "false" + usage: help for version 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/xml.md b/docs/_commands/xml.md index 0259451..bcfc864 100644 --- a/docs/_commands/xml.md +++ b/docs/_commands/xml.md @@ -1,60 +1,60 @@ --- h1: The xml Command -title: 'xml: Validate XML files - Badger' -name: badger xml +title: 'xml: Validate XML files - FFLint' +name: fflint xml synopsis: Validate XML files description: Checks that your XML files are valid -usage: badger xml [flags] +usage: fflint xml [options] files... [flags] options: -- name: help - shorthand: h - default_value: "false" - usage: help for xml -- name: schema - usage: Schema (XSD) to use + - name: help + shorthand: h + default_value: "false" + usage: help for xml + - name: schema + usage: Schema (XSD) to use 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/yaml.md b/docs/_commands/yaml.md index cb64b09..156cd2d 100644 --- a/docs/_commands/yaml.md +++ b/docs/_commands/yaml.md @@ -1,64 +1,64 @@ --- h1: The yaml Command -title: 'yaml: Validate YAML files - Badger' -name: badger yaml +title: 'yaml: Validate YAML files - FFLint' +name: fflint yaml synopsis: Validate YAML files description: Check that your YAML files are valid -usage: badger yaml [flags] +usage: fflint yaml [options] files... [flags] options: -- name: help - shorthand: h - default_value: "false" - usage: help for yaml -- name: sorted - default_value: "false" - usage: Keys need to be in alphabetical order -- name: stringkeys - default_value: "true" - usage: Keys need to be strings + - name: help + shorthand: h + default_value: "false" + usage: help for yaml + - name: sorted + default_value: "false" + usage: Keys need to be in alphabetical order + - name: stringkeys + default_value: "true" + usage: Keys need to be strings 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 %}