Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

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

Open Beginner friendly
  • Is something wrong?
#390 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
go, python
Domain
documentation

Research direction

Locate the documentation entries for autopep8, gofumpt, and shfmt, then compare each installation instruction with the versions and commands described in the issue. Check the surrounding formatprograms documentation for consistent wording; done means the deprecated link and Go installation methods are updated and the rendered documentation is correct.

Written by the indexing model from the issue text.

Description

  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.

Dominant language
Vim Script
Stars
2.3k
Forks
178
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from vim-autoformat/vim-autoformat

All issues in vim-autoformat/vim-autoformat

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.