Explaining initial configuration setup in README.md

[rappie]

I just spend a couple of hours diagnosing why i could not get "format on save" to work. I wanted to share my experience here to save others going through the same.

At first it wasn't clear to me that you need to define a default formatter make format-all-buffer work. Eventually it turned out i just had to call format-all-ensure-formatter. This is already in the documentation but it's written in such a manner that I did not pick it up.

Suggestion: a rewrite of the "How to customize" chapter.
Adding a quickstart code example would help as well.

For example:

  (add-hook 'format-all-mode-hook 'format-all-ensure-formatter)
  (add-hook 'prog-mode-hook 'format-all-mode)

[scolej]

Yes please! I too just spent an hour in the same hole.

[nettoyoussef]

Here is a basic example that also sets the default formatters:

(use-package format-all 
  :hook
  (
   (ess-r-mode . format-all-mode)
   (python-mode . format-all-mode)
   (format-all-mode-hook . format-all-ensure-formatter)
  )
  :config
  (custom-set-variables
   '(format-all-formatters (quote (("Python" black) ("R" styler))))
  )
)

[jabirali]

One thing I was a bit stuck on was how to enable multiple formatters for a single language.

For me, this worked quite well. I think perhaps adding an example like this to the README could be useful?

(use-package format-all
  :hook
  (eglot-managed-mode . format-all-mode)
  :config
  (setq-default format-all-formatters
				'(("Python" (isort) (ruff) (black)))))

[lassik]

Sorry, I know the readme sucks. PRs to improve it are very welcome.