README.md

VSCode autoflake Extension

VSCode extension for removing unused imports using autoflake from the GUI.

Features

• Running autoflake for specific file(s) and folder(s).
• Running autoflake for the workspace.
• Running autoflake as a formatter.
• Displaying a prompt for one-click installation if autoflake is not installed.

Requirements

autoflake>=1.5.2

It may work with lower versions, but some of the options will not work.

If autoflake is not installed, it can be installed with one click by accepting the prompt from this extension. Alternatively, you can install it manually with the following command.

pip install -U autoflake

Extension Settings

This extension contributes the following settings: (Most of the available options in autoflake.)

• autoflake-extension.expand-star-imports: expand wildcard star imports with undefined names; this only triggers if there is only one star import in the file; this is skipped if there are any uses of __all__ or del in the file
• autoflake-extension.remove-all-unused-imports: remove all unused imports (not just those from the standard library)
• autoflake-extension.ignore-init-module-imports: exclude init.py when removing unused imports
• autoflake-extension.remove-duplicate-keys: remove all duplicate keys in objects
• autoflake-extension.remove-unused-variables: remove unused variables
• autoflake-extension.remove-rhs-for-unused-variables: remove RHS of statements when removing unused variables (unsafe)
• autoflake-extension.check: return error code if changes are needed
• autoflake-extension.jobs: number of parallel jobs; match CPU count if value is 0 (default: 0)
• autoflake-extension.exclude: exclude file/directory names that match these globs
• autoflake-extension.imports: by default, only unused standard library imports are removed; specify a list of additional modules/packages
• autoflake-extension.extension.useIntegratedTerminal: Whether to use integrated terminal instead of hidden terminal. (Not recommended)

Known Issues

If you are setting autoflake-extension.extension.useIntegratedTerminal to true and using venv and intentionally somewhat deactivate venv after this extension opened a teminal, it will not work unless you close the terminal.