From b02363790c07200b7f087f65cd5021b71c3ebfb3 Mon Sep 17 00:00:00 2001 From: Steven Arcangeli Date: Mon, 9 Oct 2023 14:17:40 -0700 Subject: doc: enforce period at end of formatter description --- README.md | 28 ++++++++++++++-------------- doc/conform.txt | 26 +++++++++++++------------- lua/conform/formatters/astyle.lua | 2 +- lua/conform/formatters/buf.lua | 2 +- lua/conform/formatters/fixjson.lua | 2 +- lua/conform/formatters/golines.lua | 2 +- lua/conform/formatters/indent.lua | 2 +- lua/conform/formatters/injected.lua | 2 +- lua/conform/formatters/just.lua | 2 +- lua/conform/formatters/perlimports.lua | 2 +- lua/conform/formatters/perltidy.lua | 2 +- lua/conform/formatters/shellharden.lua | 2 +- lua/conform/formatters/standardrb.lua | 2 +- lua/conform/formatters/taplo.lua | 2 +- lua/conform/formatters/trim_newlines.lua | 2 +- lua/conform/formatters/trim_whitespace.lua | 2 +- 16 files changed, 41 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index a8158a5..3a685a9 100644 --- a/README.md +++ b/README.md @@ -168,14 +168,14 @@ You can view this list in vim with `:help conform-formatters` - [alejandra](https://kamadorueda.com/alejandra/) - The Uncompromising Nix Code Formatter. -- [astyle](https://astyle.sourceforge.net/astyle.html) - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective-C, C#, and Java Source Code +- [astyle](https://astyle.sourceforge.net/astyle.html) - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective-C, C#, and Java Source Code. - [autoflake](https://github.com/PyCQA/autoflake) - Removes unused imports and unused variables as reported by pyflakes. - [autopep8](https://github.com/hhatto/autopep8) - A tool that automatically formats Python code to conform to the PEP 8 style guide. - [beautysh](https://github.com/lovesegfault/beautysh) - A Bash beautifier for the masses. - [bibtex-tidy](https://github.com/FlamingTempura/bibtex-tidy) - Cleaner and Formatter for BibTeX files. - [biome](https://github.com/biomejs/biome) - A toolchain for web projects, aimed to provide functionalities to maintain them. - [black](https://github.com/psf/black) - The uncompromising Python code formatter. -- [buf](https://buf.build/docs/reference/cli/buf/format) - A new way of working with Protocol Buffers +- [buf](https://buf.build/docs/reference/cli/buf/format) - A new way of working with Protocol Buffers. - [clang_format](https://www.kernel.org/doc/html/latest/process/clang-format.html) - Tool to format C/C++/… code according to a set of rules and heuristics. - [cljstyle](https://github.com/greglook/cljstyle) - Formatter for Clojure code. - [cmake_format](https://github.com/cheshirekow/cmake_format) - Parse cmake listfiles and format them nicely. @@ -191,20 +191,20 @@ You can view this list in vim with `:help conform-formatters` - [erb_format](https://github.com/nebulab/erb-formatter) - Format ERB files with speed and precision. - [eslint_d](https://github.com/mantoni/eslint_d.js/) - Like ESLint, but faster. - [fish_indent](https://fishshell.com/docs/current/cmds/fish_indent.html) - Indent or otherwise prettify a piece of fish code. -- [fixjson](https://github.com/rhysd/fixjson) - JSON Fixer for Humans using (relaxed) JSON5 +- [fixjson](https://github.com/rhysd/fixjson) - JSON Fixer for Humans using (relaxed) JSON5. - [gci](https://github.com/daixiang0/gci) - GCI, a tool that controls Go package import order and makes it always deterministic. - [gdformat](https://github.com/Scony/godot-gdscript-toolkit) - A formatter for Godot's gdscript. - [gofmt](https://pkg.go.dev/cmd/gofmt) - Formats go programs. - [gofumpt](https://github.com/mvdan/gofumpt) - Enforce a stricter format than gofmt, while being backwards compatible. That is, gofumpt is happy with a subset of the formats that gofmt is happy with. - [goimports](https://pkg.go.dev/golang.org/x/tools/cmd/goimports) - Updates your Go import lines, adding missing ones and removing unreferenced ones. -- [golines](https://github.com/segmentio/golines) - A golang formatter that fixes long lines +- [golines](https://github.com/segmentio/golines) - A golang formatter that fixes long lines. - [google-java-format](https://github.com/google/google-java-format) - Reformats Java source code according to Google Java Style. - [htmlbeautifier](https://github.com/threedaymonk/htmlbeautifier) - A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates. -- [indent](https://www.gnu.org/software/indent/) - GNU Indent -- [injected](lua/conform/formatters/injected.lua) - Format treesitter injected languages. +- [indent](https://www.gnu.org/software/indent/) - GNU Indent. +- [injected](doc/advanced_topics.md#injected-language-formatting-code-blocks) - Format treesitter injected languages. - [isort](https://github.com/PyCQA/isort) - Python utility / library to sort imports alphabetically and automatically separate them into sections and by type. - [jq](https://github.com/stedolan/jq) - Command-line JSON processor. -- [just](https://github.com/casey/just) - Format Justfile +- [just](https://github.com/casey/just) - Format Justfile. - [latexindent](https://github.com/cmhughes/latexindent.pl) - A perl script for formatting LaTeX files that is generally included in major TeX distributions. - [markdown-toc](https://github.com/jonschlinkert/markdown-toc) - API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files. - [markdownlint](https://github.com/DavidAnson/markdownlint) - A Node.js style checker and lint tool for Markdown/CommonMark files. @@ -213,8 +213,8 @@ You can view this list in vim with `:help conform-formatters` - [nixfmt](https://github.com/serokell/nixfmt) - nixfmt is a formatter for Nix code, intended to apply a uniform style. - [nixpkgs_fmt](https://github.com/nix-community/nixpkgs-fmt) - nixpkgs-fmt is a Nix code formatter for nixpkgs. - [ocamlformat](https://github.com/ocaml-ppx/ocamlformat) - Auto-formatter for OCaml code. -- [perlimports](https://github.com/perl-ide/App-perlimports) - Make implicit Perl imports explicit -- [perltidy](https://github.com/perltidy/perltidy) - Perl::Tidy, a source code formatter for Perl +- [perlimports](https://github.com/perl-ide/App-perlimports) - Make implicit Perl imports explicit. +- [perltidy](https://github.com/perltidy/perltidy) - Perl::Tidy, a source code formatter for Perl. - [pg_format](https://github.com/darold/pgFormatter) - PostgreSQL SQL syntax beautifier. - [php_cs_fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) - The PHP Coding Standards Fixer. - [phpcbf](https://phpqa.io/projects/phpcbf.html) - PHP Code Beautifier and Fixer fixes violations of a defined coding standard. @@ -227,21 +227,21 @@ You can view this list in vim with `:help conform-formatters` - [rustywind](https://github.com/avencera/rustywind) - A tool for formatting Tailwind CSS classes. - [scalafmt](https://github.com/scalameta/scalafmt) - Code formatter for Scala. - [shellcheck](https://github.com/koalaman/shellcheck) - A static analysis tool for shell scripts. -- [shellharden](https://github.com/anordal/shellharden) - The corrective bash syntax highlighter +- [shellharden](https://github.com/anordal/shellharden) - The corrective bash syntax highlighter. - [shfmt](https://github.com/mvdan/sh) - A shell parser, formatter, and interpreter with `bash` support. - [sql_formatter](https://github.com/sql-formatter-org/sql-formatter) - A whitespace formatter for different query languages. - [squeeze_blanks](https://www.gnu.org/software/coreutils/manual/html_node/cat-invocation.html#cat-invocation) - Squeeze repeated blank lines into a single blank line via `cat -s`. - [standardjs](https://standardjs.com) - JavaScript Standard style guide, linter, and formatter. -- [standardrb](https://github.com/standardrb/standard) - Ruby's bikeshed-proof linter and formatter +- [standardrb](https://github.com/standardrb/standard) - Ruby's bikeshed-proof linter and formatter. - [stylelint](https://github.com/stylelint/stylelint) - A mighty CSS linter that helps you avoid errors and enforce conventions. - [stylua](https://github.com/JohnnyMorganz/StyLua) - An opinionated code formatter for Lua. - [swift_format](https://github.com/apple/swift-format) - Swift formatter from apple. Requires building from source with `swift build`. - [swiftformat](https://github.com/nicklockwood/SwiftFormat) - SwiftFormat is a code library and command-line tool for reformatting `swift` code on macOS or Linux. -- [taplo](https://github.com/tamasfe/taplo) - A TOML toolkit written in Rust +- [taplo](https://github.com/tamasfe/taplo) - A TOML toolkit written in Rust. - [templ](https://templ.guide/commands-and-tools/cli/#formatting-templ-files) - Formats templ template files. - [terraform_fmt](https://www.terraform.io/docs/cli/commands/fmt.html) - The terraform-fmt command rewrites `terraform` configuration files to a canonical format and style. -- [trim_newlines](https://www.gnu.org/software/gawk/manual/gawk.html) - Trim new lines with awk -- [trim_whitespace](https://www.gnu.org/software/gawk/manual/gawk.html) - Trim whitespaces with awk +- [trim_newlines](https://www.gnu.org/software/gawk/manual/gawk.html) - Trim new lines with awk. +- [trim_whitespace](https://www.gnu.org/software/gawk/manual/gawk.html) - Trim whitespaces with awk. - [uncrustify](https://github.com/uncrustify/uncrustify) - A source code beautifier for C, C++, C#, ObjectiveC, D, Java, Pawn and Vala. - [xmlformat](https://github.com/pamoller/xmlformatter) - xmlformatter is an Open Source Python package, which provides formatting of XML documents. - [yamlfix](https://github.com/lyz-code/yamlfix) - A configurable YAML formatter that keeps comments. diff --git a/doc/conform.txt b/doc/conform.txt index 20a6f0b..56cbb39 100644 --- a/doc/conform.txt +++ b/doc/conform.txt @@ -156,7 +156,7 @@ FORMATTERS *conform-formatter `alejandra` - The Uncompromising Nix Code Formatter. `astyle` - A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, - Objective-C, C#, and Java Source Code + Objective-C, C#, and Java Source Code. `autoflake` - Removes unused imports and unused variables as reported by pyflakes. `autopep8` - A tool that automatically formats Python code to conform to the PEP @@ -166,7 +166,7 @@ FORMATTERS *conform-formatter `biome` - A toolchain for web projects, aimed to provide functionalities to maintain them. `black` - The uncompromising Python code formatter. -`buf` - A new way of working with Protocol Buffers +`buf` - A new way of working with Protocol Buffers. `clang_format` - Tool to format C/C++/… code according to a set of rules and heuristics. `cljstyle` - Formatter for Clojure code. @@ -189,7 +189,7 @@ FORMATTERS *conform-formatter `erb_format` - Format ERB files with speed and precision. `eslint_d` - Like ESLint, but faster. `fish_indent` - Indent or otherwise prettify a piece of fish code. -`fixjson` - JSON Fixer for Humans using (relaxed) JSON5 +`fixjson` - JSON Fixer for Humans using (relaxed) JSON5. `gci` - GCI, a tool that controls Go package import order and makes it always deterministic. `gdformat` - A formatter for Godot's gdscript. @@ -199,17 +199,17 @@ FORMATTERS *conform-formatter that gofmt is happy with. `goimports` - Updates your Go import lines, adding missing ones and removing unreferenced ones. -`golines` - A golang formatter that fixes long lines +`golines` - A golang formatter that fixes long lines. `google-java-format` - Reformats Java source code according to Google Java Style. `htmlbeautifier` - A normaliser/beautifier for HTML that also understands embedded Ruby. Ideal for tidying up Rails templates. -`indent` - GNU Indent +`indent` - GNU Indent. `injected` - Format treesitter injected languages. `isort` - Python utility / library to sort imports alphabetically and automatically separate them into sections and by type. `jq` - Command-line JSON processor. -`just` - Format Justfile +`just` - Format Justfile. `latexindent` - A perl script for formatting LaTeX files that is generally included in major TeX distributions. `markdown-toc` - API and CLI for generating a markdown TOC (table of contents) @@ -222,8 +222,8 @@ FORMATTERS *conform-formatter style. `nixpkgs_fmt` - nixpkgs-fmt is a Nix code formatter for nixpkgs. `ocamlformat` - Auto-formatter for OCaml code. -`perlimports` - Make implicit Perl imports explicit -`perltidy` - Perl::Tidy, a source code formatter for Perl +`perlimports` - Make implicit Perl imports explicit. +`perltidy` - Perl::Tidy, a source code formatter for Perl. `pg_format` - PostgreSQL SQL syntax beautifier. `php_cs_fixer` - The PHP Coding Standards Fixer. `phpcbf` - PHP Code Beautifier and Fixer fixes violations of a defined coding @@ -242,13 +242,13 @@ FORMATTERS *conform-formatter `rustywind` - A tool for formatting Tailwind CSS classes. `scalafmt` - Code formatter for Scala. `shellcheck` - A static analysis tool for shell scripts. -`shellharden` - The corrective bash syntax highlighter +`shellharden` - The corrective bash syntax highlighter. `shfmt` - A shell parser, formatter, and interpreter with `bash` support. `sql_formatter` - A whitespace formatter for different query languages. `squeeze_blanks` - Squeeze repeated blank lines into a single blank line via `cat -s`. `standardjs` - JavaScript Standard style guide, linter, and formatter. -`standardrb` - Ruby's bikeshed-proof linter and formatter +`standardrb` - Ruby's bikeshed-proof linter and formatter. `stylelint` - A mighty CSS linter that helps you avoid errors and enforce conventions. `stylua` - An opinionated code formatter for Lua. @@ -256,12 +256,12 @@ FORMATTERS *conform-formatter `swift build`. `swiftformat` - SwiftFormat is a code library and command-line tool for reformatting `swift` code on macOS or Linux. -`taplo` - A TOML toolkit written in Rust +`taplo` - A TOML toolkit written in Rust. `templ` - Formats templ template files. `terraform_fmt` - The terraform-fmt command rewrites `terraform` configuration files to a canonical format and style. -`trim_newlines` - Trim new lines with awk -`trim_whitespace` - Trim whitespaces with awk +`trim_newlines` - Trim new lines with awk. +`trim_whitespace` - Trim whitespaces with awk. `uncrustify` - A source code beautifier for C, C++, C#, ObjectiveC, D, Java, Pawn and Vala. `xmlformat` - xmlformatter is an Open Source Python package, which provides diff --git a/lua/conform/formatters/astyle.lua b/lua/conform/formatters/astyle.lua index 58db841..82743c4 100644 --- a/lua/conform/formatters/astyle.lua +++ b/lua/conform/formatters/astyle.lua @@ -3,7 +3,7 @@ local util = require("conform.util") return { meta = { url = "https://astyle.sourceforge.net/astyle.html", - description = "A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective-C, C#, and Java Source Code", + description = "A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI, Objective-C, C#, and Java Source Code.", }, command = "astyle", args = { "--quiet" }, diff --git a/lua/conform/formatters/buf.lua b/lua/conform/formatters/buf.lua index 9a4b776..e430bf6 100644 --- a/lua/conform/formatters/buf.lua +++ b/lua/conform/formatters/buf.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://buf.build/docs/reference/cli/buf/format", - description = "A new way of working with Protocol Buffers", + description = "A new way of working with Protocol Buffers.", }, command = "buf", args = { "format", "-w", "$FILENAME" }, diff --git a/lua/conform/formatters/fixjson.lua b/lua/conform/formatters/fixjson.lua index a29528a..fee611c 100644 --- a/lua/conform/formatters/fixjson.lua +++ b/lua/conform/formatters/fixjson.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/rhysd/fixjson", - description = "JSON Fixer for Humans using (relaxed) JSON5 ", + description = "JSON Fixer for Humans using (relaxed) JSON5.", }, command = "fixjson", } diff --git a/lua/conform/formatters/golines.lua b/lua/conform/formatters/golines.lua index e6a4b64..1f33668 100644 --- a/lua/conform/formatters/golines.lua +++ b/lua/conform/formatters/golines.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/segmentio/golines", - description = "A golang formatter that fixes long lines", + description = "A golang formatter that fixes long lines.", }, command = "golines", } diff --git a/lua/conform/formatters/indent.lua b/lua/conform/formatters/indent.lua index 7a854cc..cb4631c 100644 --- a/lua/conform/formatters/indent.lua +++ b/lua/conform/formatters/indent.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://www.gnu.org/software/indent/", - description = "GNU Indent", + description = "GNU Indent.", }, command = "indent", stdin = true, diff --git a/lua/conform/formatters/injected.lua b/lua/conform/formatters/injected.lua index 8140550..71005bc 100644 --- a/lua/conform/formatters/injected.lua +++ b/lua/conform/formatters/injected.lua @@ -71,7 +71,7 @@ end ---@type conform.InjectedFormatterConfig return { meta = { - url = "lua/conform/formatters/injected.lua", + url = "doc/advanced_topics.md#injected-language-formatting-code-blocks", description = "Format treesitter injected languages.", }, options = { diff --git a/lua/conform/formatters/just.lua b/lua/conform/formatters/just.lua index 5218fc7..d166484 100644 --- a/lua/conform/formatters/just.lua +++ b/lua/conform/formatters/just.lua @@ -1,7 +1,7 @@ return { meta = { url = "https://github.com/casey/just", - description = "Format Justfile", + description = "Format Justfile.", }, command = "just", args = { "--fmt", "--unstable", "-f", "$FILENAME" }, diff --git a/lua/conform/formatters/perlimports.lua b/lua/conform/formatters/perlimports.lua index d3e520c..8840508 100644 --- a/lua/conform/formatters/perlimports.lua +++ b/lua/conform/formatters/perlimports.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/perl-ide/App-perlimports", - description = "Make implicit Perl imports explicit", + description = "Make implicit Perl imports explicit.", }, command = "perlimports", args = { diff --git a/lua/conform/formatters/perltidy.lua b/lua/conform/formatters/perltidy.lua index 3b8be2c..5f6d857 100644 --- a/lua/conform/formatters/perltidy.lua +++ b/lua/conform/formatters/perltidy.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/perltidy/perltidy", - description = "Perl::Tidy, a source code formatter for Perl", + description = "Perl::Tidy, a source code formatter for Perl.", }, command = "perltidy", args = { "--quiet" }, diff --git a/lua/conform/formatters/shellharden.lua b/lua/conform/formatters/shellharden.lua index 309ea86..c775072 100644 --- a/lua/conform/formatters/shellharden.lua +++ b/lua/conform/formatters/shellharden.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/anordal/shellharden", - description = "The corrective bash syntax highlighter", + description = "The corrective bash syntax highlighter.", }, command = "shellharden", args = { "--transform", "" }, diff --git a/lua/conform/formatters/standardrb.lua b/lua/conform/formatters/standardrb.lua index 1a69cd6..ae860ea 100644 --- a/lua/conform/formatters/standardrb.lua +++ b/lua/conform/formatters/standardrb.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/standardrb/standard", - description = "Ruby's bikeshed-proof linter and formatter", + description = "Ruby's bikeshed-proof linter and formatter.", }, command = "standardrb", args = { diff --git a/lua/conform/formatters/taplo.lua b/lua/conform/formatters/taplo.lua index 675bed3..fb2d67a 100644 --- a/lua/conform/formatters/taplo.lua +++ b/lua/conform/formatters/taplo.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://github.com/tamasfe/taplo", - description = "A TOML toolkit written in Rust", + description = "A TOML toolkit written in Rust.", }, command = "taplo", args = { "format", "-" }, diff --git a/lua/conform/formatters/trim_newlines.lua b/lua/conform/formatters/trim_newlines.lua index 4397ac7..434f35b 100644 --- a/lua/conform/formatters/trim_newlines.lua +++ b/lua/conform/formatters/trim_newlines.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://www.gnu.org/software/gawk/manual/gawk.html", - description = "Trim new lines with awk", + description = "Trim new lines with awk.", }, command = "awk", args = { 'NF{print s $0; s=""; next} {s=s ORS}' }, diff --git a/lua/conform/formatters/trim_whitespace.lua b/lua/conform/formatters/trim_whitespace.lua index 7178e0e..3bbd89e 100644 --- a/lua/conform/formatters/trim_whitespace.lua +++ b/lua/conform/formatters/trim_whitespace.lua @@ -2,7 +2,7 @@ return { meta = { url = "https://www.gnu.org/software/gawk/manual/gawk.html", - description = "Trim whitespaces with awk", + description = "Trim whitespaces with awk.", }, command = "awk", args = { '{ sub(/[ \t]+$/, ""); print }' }, -- cgit v1.2.3-70-g09d2