SSGulnur VS lint-staged

Today, I created the first release for my SSGulnur tool.

This will create a configuration yaml file in your .github/workflows folder which will explain Github what and when to do to your repo changes.

For my PR I did basic tests checking the functions for unexpected output.

I also updated my CONTRIBUTING.md, so the future contributors find instructions for testing.

configure the rules and options to customize the look, e.g., .prettierrc

I filed a new issue and started working on it on the new branch. I saved every step as commits which I squashed into one later. Everything went as planned and the implementation took me about what I expected, as I was not creating anything new myself and was only working on integrating an existing tool into my project.

Issue URL

I also received an issue on my repo with my SSG tool. I labeled it as an enhancement as it was not a necessary part but good to have. I checked the PR and realized that there was a need for a few changes by testing the work. For that, I added them as a remote to my local repo, fetched and set a tracking branch. I contacted the author of PR through Slack and explained all necessary updates. I also summarized them in the PR itself as things to do, so I remember what to check for when everything is ready.

First feature that I was interested in implementing was adding markdown bold and link syntax features support. As always, I created an issue about my solution and a branch in which I worked on it.

Issue #1 is a bug connected to file reading and quotation marks. Basically, all quotation marks needed to be converted into the escape characters in order to be processed correctly and not as end of the string.

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!