From 346fa18cde4cf1b23941830c346f26b5a04fcd7d Mon Sep 17 00:00:00 2001 From: Steve Morin Date: Thu, 23 Jan 2025 14:28:50 -0800 Subject: [PATCH 1/2] Added recommended vscode plugin and documentation --- .vscode/extensions.json | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .vscode/extensions.json diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..a686347 --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,13 @@ +{ + "recommendations": [ + "ms-python.python", + "ms-python.vscode-pylance", + "ms-python.black-formatter", + "charliermarsh.ruff", + "matangover.mypy", + "tamasfe.even-better-toml", + "redhat.vscode-yaml", + "eamodio.gitlens", + "streetsidesoftware.code-spell-checker" + ] +} \ No newline at end of file From a204e1eabcf52979384df2d3721906baab99db6c Mon Sep 17 00:00:00 2001 From: Steve Morin Date: Thu, 23 Jan 2025 14:30:01 -0800 Subject: [PATCH 2/2] vscode recommendations and documentations --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index d13b839..4b97d82 100644 --- a/README.md +++ b/README.md @@ -366,6 +366,22 @@ def process(handler: Handler) -> None: ... ``` +## Recommended Extensions + +This project comes with recommended VS Code extensions to enhance your development experience. When you open this project in VS Code, you'll be prompted to install these extensions: + +- **Python** (`ms-python.python`): Essential Python language support +- **Pylance** (`ms-python.vscode-pylance`): Fast, feature-rich language support for Python +- **Black Formatter** (`ms-python.black-formatter`): Official Black formatter integration +- **Ruff** (`charliermarsh.ruff`): Fast Python linter and formatter +- **MyPy** (`matangover.mypy`): Static type checking for Python +- **Even Better TOML** (`tamasfe.even-better-toml`): Improved TOML file support +- **YAML** (`redhat.vscode-yaml`): YAML language support +- **GitLens** (`eamodio.gitlens`): Enhanced Git integration +- **Code Spell Checker** (`streetsidesoftware.code-spell-checker`): Catch common spelling mistakes + +These extensions are configured to work seamlessly with the project's setup and will help maintain code quality standards. VS Code will automatically suggest installing these extensions when you open the project. + ## Precommit hooks Hooks are designed to maintain clean, consistent, and error-free code and configuration files. They save time by catching issues before they make it into your repository.