izyum VS prettier

This week we worked on integrating CI into our open-source projects. It is not the first time for me to work with CI and pipelines in general, but I find it very satisfying to put my project on some pipeline every time. These kinds of automations sometimes feel like magic to me.

Repo I picked for adding unit tests is izyum, which is another SSG written in Node.js and TypeScript.

This week's objective was to set up a unit test environment for izyum and write some unit tests in order to cover core functionality.

The first thing I added was a CONTRIBUTING.md file where I located all info that I used to have in readme.md file about how to install the tool for development setup.

First of all, I created the issue for izyum where I briefly described what I want to do and how I am going to achieve it. After that, I made an implementation and created PR, which approved myself :)

Izyum has a lot of space for improvement in terms of code refactoring. The first and most obvious thing was the fact that all code was contained in a single index.ts file, which is a really bad practice. The combination of facts that it is a school project with deadlines and sometimes I can be pretty bad in terms of time management made the codebase to be a mess.

Hi! Thanks for checking in. This week I worked on adding a new feature to another Static Site Generator Izyum. It is written in TypeScript and CLI apps in TypeScript is something new for me, so let me tell you how it went.

This week's task was to implement two features for the existing product, for me it is izyum, which is my ssg tool.

Last week I was presented with the opportunity to contribute to Izyum, a static site generator tool that creates an HTML file for each .txt file provided. Since the application had no existing support for processing markdown files, I began by filing an issue for it.

Later,Tymur connected with me via Slack DM to test his SSG tool Izyum. This SSG is created using Typescript and NodeJS.

In this post, I also use ESLint + Standard JS as my code formatting tools. Formatting JS/TS code by using ESLint is also subjective and opinionated, arguably most people would rather use Prettier instead, which provides more configurable options.

Let's be honest - setting up tools for a new project can be a frustrating process. Especially when you want to jump straight to coding part. This is often the case with ESLint and Prettier, two popular tools in the JavaScript ecosystem that can sometimes interfere with each other when it comes to code formatting. Fortunately, there's a simple solution to this process, and it's called eslint-plugin-prettier.

From my point of view, Prettier doesn't work well for styling with utility classes. For a discussion see Prettier#7863 or Prettier#5948.

Prettier: An opinionated code formatter that enforces a consistent code style.

Automating code checks with static code analysis allows us to enforce code styling effectively. By integrating tools into our workflow, we can identify errors at an early stage, while coding instead of blocking us at the end. For instance, flake8 checks Python code for style and errors, eslint performs similar checks for JavaScript, and prettier automatically formats code to maintain consistency.

So anyways, I wanted to hook up Emacs with Astro support. For now, I've just been roughing it out there and running Prettier by itself and turning off save on format and auto-complete. It's been scary.

If you're a developer, you're surely familiar with Prettier and ESLint. With over 8 years of existence, they have established themselves as references in the JavaScript ecosystem.

prettier is used to format you text

No formatting inconsistencies: The committed code should follow the organization's code formatting standards(prettier or pretty-quick).

Let’s walk through the steps for a one-time setup to configure husky pre-commit and pre-push hooks, ESLint with code styles conventions, prettier code formatter, and lint-staged. Husky automatically runs a script on each commit or push. This is useful for linting files to enforce code styles that keeps the entire code base following conventions.