include-what-you-use VS pre-commit

Linters keep the code base consistent and help to catch a lot of issues and even bugs way before the compiler is ran. Clang-Tidy is the one I am relying on. IWYU is really helpful in keeping the includes clean, reducing number of dependencies and reducing the build times.

Interesting...how does it compare to https://github.com/include-what-you-use/include-what-you-use ?

Build Insights in Visual Studio, include-what-you-use).

Looks like https://include-what-you-use.org/ might do that.

If you are worried about includes, use https://github.com/include-what-you-use/include-what-you-use and stop thinking about it.

Getting rid of that is not straightforard, though some tools can help with that

You can use the tool https://github.com/include-what-you-use/include-what-you-use to do this for for. It tracks included files and can give comment for what is used from each file. It also warns you when you include files that you don’t use

Invisible imports (e.g. traits). In Python, everything is fully namespaced (unless you from import * in which case all bets are off). It's always explicit where a name is coming from. C is the opposite: #include lets you refer to anything defined in the headers with no namespacing. That's why a common strategy (include what you use) has an associated code style: after every non-std #include you have a comment saying which of its definitions you are using. Of course, Rust is much less implicit, but I still sometimes struggle with traits. For example, you can use tokio::net::TcpStream, but you need to also use tokio::io::AsyncReadExt for the .read trait to be defined on TcpStream. This makes it hard (for me) to answer questions like "what traits are currently available in this scope?" and "why is this module being imported?"

Aside from being closed source and not available on all architectures, how does it compare to iwyu(https://include-what-you-use.org/) or clang's relatively recent include-fixer which is also accessible via clangd?

Pre-commit: git hook manager

Just give you an idea of how to implement a template for serverless in your organization; you can create multiple cases and embed the practice of your organization to the template like pre-commit, cicd, lambda-layer-secret, lambda-layer-powertools and more

When using pre-commit for linting:

Instead of running these tools manually every time you make changes, you can automate the process with pre-commit hooks. Pre-commit hooks run automatically before each commit, blocking the commit if any tool fails.

Our team is small and we use:

  git hooks from https://pre-commit.com

You can also add InfraCost as part of the pre-commit. With pre-commit, you can define some hooks that you can easily run before you push your code. There are multiple ways to install pre-commit, and you can find examples here.

In the case of pre-commit hooks, the runtime either has to be installed manually by every user (in the case of Husky) or is handled in Python (in the case of pre-commit). Running Node.js through Python/pyenv introduces an additional layer of complexity, which can lead to issues like OpenSSL library incompatibilities.

I'm using pre-commit, follow the link to get installation instructions.

Not only can you check how well your code follows certain rules but also add auto-formatting options. This way, most inconsistencies are fixed automatically, saving time. Linters start up can be automated, for example, with pre-commit tool for python and this logic can be integrated into GitHub PR or new commits workflow. So before a new Pull Request is reviewed, it's the author who resolves any code style issues.

Today we are going to look at how to setup Black (a python code formatter) and pre-commit (a package for handling git hooks in python) to automatically format you code on commit.