chore: add prettier config and format (#1076)

Author: Jose Alvarez

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -7,15 +7,19 @@ body:
     attributes:
       label: FAQ
       options:
-        - label: I have checked the [FAQ](https://github.com/jose-elias-alvarez/null-ls.nvim#faq) and it didn't resolve my problem.
+        - label:
+            I have checked the [FAQ](https://github.com/jose-elias-alvarez/null-ls.nvim#faq) and it didn't resolve my
+            problem.
           required: true
 
   - type: checkboxes
     id: issue-prerequisite
     attributes:
       label: Issues
       options:
-        - label: I have checked [existing issues](https://github.com/jose-elias-alvarez/null-ls.nvim/issues?q=is%3Aissue) and there are no issues with the same problem.
+        - label:
+            I have checked [existing issues](https://github.com/jose-elias-alvarez/null-ls.nvim/issues?q=is%3Aissue) and
+            there are no issues with the same problem.
           required: true
 
   - type: input
@@ -35,14 +39,19 @@ body:
   - type: textarea
     attributes:
       label: "Minimal config"
-      description: "Download the minimal config using `curl -fLO https://raw.githubusercontent.com/jose-elias-alvarez/null-ls.nvim/main/scripts/minimal_init.lua`. Edit it to include the configuration necessary to reproduce your bug and paste it here. Do not use your personal null-ls config!"
+      description: "Download the minimal config using `curl -fLO
+        https://raw.githubusercontent.com/jose-elias-alvarez/null-ls.nvim/main/scripts/minimal_init.lua`. Edit it to
+        include the configuration necessary to reproduce your bug and paste it here. Do not use your personal null-ls
+        config!"
     validations:
       required: true
 
   - type: textarea
     attributes:
       label: "Steps to reproduce"
-      description: "Full reproduction steps, starting with `nvim --clean -u minimal_init.lua`. Include a sample file if your issue relates to a specific filetype."
+      description:
+        "Full reproduction steps, starting with `nvim --clean -u minimal_init.lua`. Include a sample file if your issue
+        relates to a specific filetype."
     validations:
       required: true
 
@@ -63,7 +72,9 @@ body:
   - type: textarea
     attributes:
       label: "Debug log"
-      description: "Debug log output from `:NullLsLog`, limited to the output from following your reproduction steps. Include this even if you think it's irrelevant."
+      description:
+        "Debug log output from `:NullLsLog`, limited to the output from following your reproduction steps. Include this
+        even if you think it's irrelevant."
     validations:
       required: true
 
@@ -82,7 +93,9 @@ body:
   - type: textarea
     attributes:
       label: "Implementation help"
-      description: "If you selected yes in the last question please specify in detail what you would need help with in order to implement this."
+      description:
+        "If you selected yes in the last question please specify in detail what you would need help with in order to
+        implement this."
     validations:
       required: false
 
@@ -91,5 +104,7 @@ body:
     attributes:
       label: Requirements
       options:
-        - label: I have read and followed the instructions above and understand that my issue will be closed if I did not provide the required information.
+        - label:
+            I have read and followed the instructions above and understand that my issue will be closed if I did not
+            provide the required information.
           required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -7,7 +7,9 @@ body:
     attributes:
       label: Issues
       options:
-        - label: I have checked [existing issues](https://github.com/jose-elias-alvarez/null-ls.nvim/issues) and there are no existing ones with the same request.
+        - label:
+            I have checked [existing issues](https://github.com/jose-elias-alvarez/null-ls.nvim/issues) and there are no
+            existing ones with the same request.
           required: true
 
   - type: textarea
@@ -31,6 +33,8 @@ body:
   - type: textarea
     attributes:
       label: "Implementation help"
-      description: "If you selected yes in the last question please specify in detail what you would need help with in order to implement this."
+      description:
+        "If you selected yes in the last question please specify in detail what you would need help with in order to
+        implement this."
     validations:
       required: false

.prettierignore

@@ -0,0 +1 @@
+doc/BUILTINS.md

.prettierrc

@@ -0,0 +1,13 @@
+{
+  "printWidth": 80,
+  "proseWrap": "always",
+  "overrides": [
+    {
+      "files": "*.yml",
+      "options": {
+        "printWidth": 120,
+        "proseWrap": "preserve"
+      }
+    }
+  ]
+}

README.md

@@ -1,3 +1,10 @@
+<!-- markdownlint-configure-file
+{
+  "line-length": false,
+  "no-inline-html": false
+}
+-->
+
 # null-ls.nvim
 
 Use Neovim as a language server to inject LSP diagnostics, code actions, and
@@ -190,8 +197,8 @@ plugin before sending anything upstream.
 
 1. Make sure your configuration is in line with the latest version of this
    document.
-2. Enable debug mode (see below) and check the output of your source(s). If
-   the CLI program is not properly configured or is otherwise not running as
+2. Enable debug mode (see below) and check the output of your source(s). If the
+   CLI program is not properly configured or is otherwise not running as
    expected, that's an issue with the program, not null-ls.
 3. Check the documentation for available configuration options that might solve
    your issue.
@@ -213,17 +220,18 @@ instructions).
 
 ### How do I format files on save?
 
-See [this wiki
-page](https://github.com/jose-elias-alvarez/null-ls.nvim/wiki/Formatting-on-save).
+See
+[this wiki page](https://github.com/jose-elias-alvarez/null-ls.nvim/wiki/Formatting-on-save).
 
 ### How do I stop Neovim from asking me which server I want to use for formatting?
 
-See [this wiki page](https://github.com/jose-elias-alvarez/null-ls.nvim/wiki/Avoiding-LSP-formatting-conflicts).
+See
+[this wiki page](https://github.com/jose-elias-alvarez/null-ls.nvim/wiki/Avoiding-LSP-formatting-conflicts).
 
 ### How do I view project-level diagnostics?
 
-For a built-in solution, use `:lua vim.diagnostic.setqflist()`. You can also
-use a plugin like [trouble.nvim](https://github.com/folke/trouble.nvim).
+For a built-in solution, use `:lua vim.diagnostic.setqflist()`. You can also use
+a plugin like [trouble.nvim](https://github.com/folke/trouble.nvim).
 
 ### How do I enable debug mode and get debug output?
 
@@ -248,8 +256,7 @@ possible, so it should work seamlessly with most LSP-related plugins. If you run
 into problems, please try to determine which plugin is causing them and open an
 issue.
 
-[This wiki
-page](https://github.com/jose-elias-alvarez/null-ls.nvim/wiki/Compatibility-with-other-plugins)
+[This wiki page](https://github.com/jose-elias-alvarez/null-ls.nvim/wiki/Compatibility-with-other-plugins)
 mentions plugins that require specific configuration options / tweaks to work
 with null-ls.
 
@@ -302,7 +309,8 @@ All tests expect the latest Neovim master.
 - [formatter.nvim](https://github.com/mhartington/formatter.nvim): a Lua plugin
   that (surprise) focuses on formatting.
 
-- [hover.nvim](https://github.com/lewis6991/hover.nvim): Hover plugin framework for Neovim.
+- [hover.nvim](https://github.com/lewis6991/hover.nvim): Hover plugin framework
+  for Neovim.
 
 ## Sponsors
 

doc/BUILTIN_CONFIG.md

@@ -122,7 +122,8 @@ local sources = {
 }
 ```
 
-You can also override a source's arguments entirely using `with({ args = your_args })`.
+You can also override a source's arguments entirely using
+`with({ args = your_args })`.
 
 Both `args` and `extra_args` can also be functions that accept a single
 argument, `params`, which is an object containing information about editor
@@ -175,8 +176,9 @@ local sources = {
 
 ### Filtering
 
-You can filter generator results using the `filter` option. The option should
-be a function that returns `true` to keep the result, and `false` or `nil` to ignore it.
+You can filter generator results using the `filter` option. The option should be
+a function that returns `true` to keep the result, and `false` or `nil` to
+ignore it.
 
 ```lua
 local sources = {
@@ -309,9 +311,9 @@ local sources = {
 }
 ```
 
-For diagnostics sources, you should also update the source to [run on
-save](#diagnostics-on-save), since otherwise diagnostics will go out of sync
-with buffer changes.
+For diagnostics sources, you should also update the source to
+[run on save](#diagnostics-on-save), since otherwise diagnostics will go out of
+sync with buffer changes.
 
 ## Using local executables
 

doc/CONFIG.md

@@ -148,9 +148,9 @@ Plugin logs messages on several logging levels to following destinations:
 
 ### notify_format (string, optional)
 
-Sets the default format for `vim.notify()` messages.
-Can be used to customize 3rd party notification plugins
-like [nvim-notify](https://github.com/rcarriga/nvim-notify).
+Sets the default format for `vim.notify()` messages. Can be used to customize
+3rd party notification plugins like
+[nvim-notify](https://github.com/rcarriga/nvim-notify).
 
 ### on_attach (function, optional)
 
@@ -217,7 +217,8 @@ to `true` if you don't experience performance issues with your sources.
 
 Note that by default, Neovim will not display updated diagnostics in insert
 mode. Together with the option above, you need to pass `update_in_insert = true`
-to `vim.diagnostic.config` for diagnostics to work as expected. See `:help vim.diagnostic.config` for more info.
+to `vim.diagnostic.config` for diagnostics to work as expected. See
+`:help vim.diagnostic.config` for more info.
 
 ## Explicitly defining the project root
 

doc/CONTRIBUTING.md

@@ -104,11 +104,11 @@ local diagnostic = {
 - Do not include the source's name or code in the message.
 
 - If at all possible, please add one or more tests to check whether your source
-  produces the correct output given an actual raw diagnostic. See [the
-  existing tests](../test/spec/builtins/diagnostics_spec.lua) for examples.
+  produces the correct output given an actual raw diagnostic. See
+  [the existing tests](../test/spec/builtins/diagnostics_spec.lua) for examples.
 
-- If your source can produce project-level diagnostics (i.e. diagnostics for more
-  than one file at a time), use the `multiple_files` option described in
+- If your source can produce project-level diagnostics (i.e. diagnostics for
+  more than one file at a time), use the `multiple_files` option described in
   [HELPERS](./HELPERS.md).
 
   - Specify that your source supports project diagnostics in its documentation.

doc/HELPERS.md

@@ -50,7 +50,8 @@ the first time.
 
 ### args
 
-A table containing the arguments passed when spawning the command. Defaults to `{}`.
+A table containing the arguments passed when spawning the command. Defaults to
+`{}`.
 
 null-ls will transform the following special arguments before spawning:
 
@@ -70,11 +71,11 @@ null-ls will transform the following special arguments before spawning:
 Can either be a table of valid exit codes (numbers) or a callback that receives
 two arguments:
 
-`code`: contains the exit code from the spawned command as a number
-`stderr`: error output from the job as a string
+`code`: contains the exit code from the spawned command as a number `stderr`:
+error output from the job as a string
 
-The callback should return a boolean value indicating whether the code
-indicates _success_.
+The callback should return a boolean value indicating whether the code indicates
+_success_.
 
 If not specified, null-ls will assume that a non-zero exit code indicates
 failure.
@@ -117,16 +118,16 @@ Supports the following options:
 - `"raw"`: passes command output directly as `params.output` (string) and error
   output as `params.err` (string).
 
-  This format will call `on_output(params, done)`, where `done()` is a callback that
-  `on_output` must call with its results (see _Generators_ in
+  This format will call `on_output(params, done)`, where `done()` is a callback
+  that `on_output` must call with its results (see _Generators_ in
   [MAIN](MAIN.md) for details).
 
 - `nil`: same as `raw`, but does not receive error output. Instead, any output
   to `stderr` will cause the generator to throw an error, unless `ignore_stderr`
   is also enabled (see below).
 
-- `"line"`: splits generator output into lines and calls `on_output(line, params)`
-  once for each line, where `line` is a string.
+- `"line"`: splits generator output into lines and calls
+  `on_output(line, params)` once for each line, where `line` is a string.
 
 - `"json"`: decodes generator output into JSON, sets `params.output` to the
   resulting JSON object, and calls `on_output(params)`. The wrapper will
@@ -140,11 +141,11 @@ To sum up:
 
 - If you want to handle each line of a source's output, use `format = "line"`.
 
-- If you are handling JSON output, use `format = "json"` if you don't intend on handling
-  errors and `format = "json_raw"` if you do.
+- If you are handling JSON output, use `format = "json"` if you don't intend on
+  handling errors and `format = "json_raw"` if you do.
 
-- If you are processing a source's entire output, use `format = nil` if you don't
-  intend on handling errors and `format = "raw"` if you do.
+- If you are processing a source's entire output, use `format = nil` if you
+  don't intend on handling errors and `format = "raw"` if you do.
 
 ### from_stderr
 
@@ -180,8 +181,8 @@ one file if this option is `true` and each diagnostic specifies a `bufnr` or
 ### on_output
 
 A callback function that receives a `params` object, which contains information
-about the current buffer and editor state (see _Generators_ in
-[MAIN](MAIN.md) for details).
+about the current buffer and editor state (see _Generators_ in [MAIN](MAIN.md)
+for details).
 
 Generators created by `generator_factory` have access to an extra parameter,
 `params.output`, which contains the output from the spawned command. The
@@ -326,7 +327,8 @@ null_ls.helpers.range_formatting_args_factory(base_args, start_arg, end_rag, opt
 - `opts` (table?): a table containing the following options:
   - `opts.use_rows` (boolean?): specifies whether to use rows over character
     offsets.
-  - `opts.use_length` (boolean?): used to specify the length of the range in `end_arg` instead of end the position.
+  - `opts.use_length` (boolean?): used to specify the length of the range in
+    `end_arg` instead of end the position.
   - `opts.row_offset` (number?): offset applied to row numbers.
   - `opts.col_offset` (number?): offset applied to column numbers.
   - `opts.delimiter` (string?): used to join range start and end into a single

doc/MAIN.md

@@ -11,8 +11,7 @@ Splits into the following documents:
 - [MAIN](MAIN.md) (this document), which describes general concepts and
   implementation details
 
-- [CONFIG](CONFIG.md), which describes the available configuration
-  options
+- [CONFIG](CONFIG.md), which describes the available configuration options
 
 - [BUILTINS](BUILTINS.md), an automatically generated list of available built-in
   sources
@@ -22,8 +21,8 @@ Splits into the following documents:
 
 - [SOURCES](SOURCES.md), which describes the source API
 
-- [HELPERS](HELPERS.md), which describes available helpers and how to use
-  them to make new sources
+- [HELPERS](HELPERS.md), which describes available helpers and how to use them
+  to make new sources
 
 - [TESTING](TESTING.md), which describes best practices for testing null-ls
   integrations
@@ -80,8 +79,8 @@ my_source.method = null_ls.methods.COMPLETION
 ### Filetypes
 
 A source has a list of filetypes, which define when the source is active. The
-list can contain a single filetype, more than one filetype, or nothing,
-which indicates that the source should activate for all filetypes.
+list can contain a single filetype, more than one filetype, or nothing, which
+indicates that the source should activate for all filetypes.
 
 ```lua
 local my_source = {}
@@ -150,8 +149,8 @@ null_ls.register({ name = "my-sources", ... })
 null_ls.register({ name = "my-sources", ... })
 ```
 
-null-ls also exposes a method, `is_registered()`, that returns a
-boolean value indicating whether it has already registered a source.
+null-ls also exposes a method, `is_registered()`, that returns a boolean value
+indicating whether it has already registered a source.
 
 ```lua
 local null_ls = require("null-ls")
@@ -358,8 +357,7 @@ Same as formatting.
 Note that getting range-formatted output requires converting the visually
 selected range into the required format and modifying the spawn arguments
 accordingly. See `range_formatting_args_factory` in [HELPERS](HELPERS.md) for an
-example of how null-ls handles this for built-in
-sources.
+example of how null-ls handles this for built-in sources.
 
 #### Hover
 

doc/SOURCES.md

@@ -82,8 +82,8 @@ local query = {
 }
 ```
 
-All keys in the query are optional, and passing an empty query will get
-all sources.
+All keys in the query are optional, and passing an empty query will get all
+sources.
 
 Note that special characters are automatically escaped when `query` is a string
 but not when it's an object, which allows using Lua string matchers.