simple-ssg1 VS prettier

Today, I also reviewed and added a few tests to another project, which was a similar tool of my friend. I was a little happy when I realized that I have structured my work in an easy way for testing such as I have lots of isolated small functions. Meanwhile, my friend had to copy his main function and rewrite it to be able to test its logic. It was a little confusing at first to figure out how everything works and to find something testable, but because he was also using Node.js and Jest, it was manageable.

To set up workflow I added nodeJS.yml file that runs on any push or PR to main branch.

For my SSG tool I used Jest, because it was made for JavaScript language(language my tool is using) and pretty straightforward to use.

This week I've been setting up code formatters for my project.

I was adding a configuration option via -c or –config option, where it will accept a JSON file as config file to use the values inside instead of other options. It waseasy to plan for what and how I want to do, since it’s just about reading a file and using the variables. The hard part was figuring out how my code would be compatible with the repo I tried to add it to. I was working on this repo, and I opened an issue and filed a pull request. This static site generator tool doesn’t use any options but accept arguments directly, so I had to use minimist package to parse options. There are a few variables that aren’t listed in the config module, such as stylesheet url, so I added them and use the variables from the config module instead. I also ended up slightly rewriting the language option code so the program would actually use the code from the author. Overall, there where bits and pieces of code for other options that aren’t entirely functional as options, so I ended up rewriting them a bit for the configuration option to work.

Today I have been adding some features to the tool:

I created SSG tool that allows you to conver txt files into html. I was unable to fix some issues yet, but planning to make it better in the future. (https://github.com/mnosov622/simple-ssg1).

I have an issue with the location of the script. When person clones the project, and then runs it, the tool gives weird error, saying that he can't find the location of the specified txt file. ( https://github.com/mnosov622/simple-ssg1/issues/2 )

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.