search

vim-autoformat / vim-autoformat

Provide easy code formatting in Vim by integrating existing code formatters.
MIT License
2.25k stars 178 forks source link

[Docs] Default formatprograms - Deprecated installation methodologies: autopep8, gofumpt and shfmt #390

Open arnoldmashava opened 1 year ago

arnoldmashava commented 1 year ago
  1. autopep8

The PyPI link that is referenced for the installation of autopep8 as a Python package through pip3 install points to a deprecated version:

pip install autopep8==0.5.2

and this is flagged as "Released: Mar 12, 2012". The same PyPI link also advises: Newer version available (2.0.2) and this points to the rolling update of autopep8 on its PyPI Project Page.

I am recommending editing the documentation so that the existing PyPI link is amended to: https://pypi.org/project/autopep8/

  1. gofumpt

The Golang CLI installation methodology for gofumpt:

go install mvdan.cc/gofumpt latest

throws back the the error:

go: 'go install' requires a version when current directory is not in a module
        Try 'go install mvdan.cc/gofumpt@latest latest@latest' to install the latest version

I am recommending editing the documentation so that the existing go install mvdan.cc/gofumpt latest is amended to:

go install mvdan.cc/gofumpt@latest
  1. shfmt

The Golang CLI installation methodology for shfmt:

go get -u mvdan.cc/sh/cmd/shfmt

is flagged as deprecated:

go: go.mod file not found in current directory or any parent directory.
        'go get' is no longer supported outside a module.
        To build and install a command, use 'go install' with a version,
        like 'go install example.com/cmd@latest'
        For more information, see https://golang.org/doc/go-get-install-deprecation
        or run 'go help get' or 'go help install'.

I am recommending editing the documentation so that the existing go get -u mvdan.cc/sh/cmd/shfmt is amended to be in sync with the methodology that is specified on the shfmt project's GitHub Repository:

go install mvdan.cc/sh/v3/cmd/shfmt@latest

Gracias y Saludos Cordiales,

Arnold Mashava.

chtenb commented 1 year ago

Thanks for the detailed description. Feel free to open a PR that implements these changes. I will always merge documentation improvements.

arnoldmashava commented 1 year ago

Thank you so much @chtenb - for the generosity and grace, in granting me the opportunity to contribute to the refinement of the vim-autoformat project.

Yes, I can summon my Spirit and excogitate on how best I can technically frame the Pull Request so that the merging of the project's Documentation will be painless and somewhat automated.

Whilst I am at it, please bear with my ageing brain and fading mental faculties, if there are discernible time delays in my completion of the Pull Request.

Gracias.