autopep8 VS lint-staged

AutoPEP8: This tool automatically formats Python code to conform to the PEP 8 style guide. It uses pycodestyle, a library that encapsulates the functionality of the original pep8 tool.

autopep8

I found three, code-formatting tools when looking at that for IDE's: autopep8; black; yapf. One or more might be able to automatically fix those problems. They might also have an API or command line call for it where you could add it in your pipeline: prompt -> response -> code formatter -> formatted response.

autopep8

Your code isn't PEP-8 compliant. Use black or autopep8 on your code to auto-format your code, or at least use pylint to check for issues, before asking anyone else to read your code.

Is there a tool that automatically styles Julia code according to some style guide similar to autopep8 in Python (https://pypi.org/project/autopep8/) or styler in R (https://www.tidyverse.org/blog/2017/12/styler-1.0.0/)?

I use autopep8 most of the time, but it does not even attempt to split these long conditionals. 😅

Lint Staged: https://github.com/lint-staged/lint-staged

lint-staged is the second important tools we need here, install it via NPM.

We were already using lint-staged and have a pre-commit hook in place using Husky in our project for linter and prettier. So it made sense to add a check here.

Now you can config it in your package.json, here is the guide doc:

In the world of software development, maintaining consistent code quality and ensuring that the codebase adheres to predefined patterns and guidelines is crucial. However, manually enforcing these standards can be time-consuming and error-prone. This is where automation tools like Husky, Lint-Staged, Commitlint, and Commitizen come to the rescue. In this post, we will explore how these tools can be combined to streamline your development workflow.

This is wasted work that can and should be automated. Adding a linter and formatter on CI and a pre-commit hook such as lint-staged can do wonders.

lint-staged is a package that can be used to run formatting and linting commands on staged files in a Git repo.

To answer your next question: I lint and format on save, and I use Git hooks installed by Husky and executed through Lint-Staged (this tool helps ensure your Git hooks only run on modified files, etc) to ensure there are no lint or formatting errors whenever making a commit or pushing code. This is helpful for teams, as some developers tend to forget to run lint tasks, or don't have the Prettier extension installed in their IDE. If there are lint errors, the commit is rejected until fixed. YMMV - you'll need to fine-tune the strictness of this based on the team's needs.

Uses Husky Git hooks and Lint-staged pre-commit hooks.

Something else to consider is applying linting and formatting before every git commit. A package like Lint-staged only lints and formats on staged items, ensuring all pushed code follows the standards in the repo. This allows developers to have their own formatting preferences when developing, while the code homogenizes on push. Linting pre-commit also avoids strict rules like no-console or no-unused-vars restricting a developer when writing code, when it should only apply in production. Imagine not being able to console log anything during development!