IPC144 VS prettier

Reviewing two PRs from a classmate is one of the duties for this project. The PRs, as well as my reviews, are available here and here. Both of the PRs I reviewed were really well-written and detailed, with very few mistakes. It was interesting to observe how different people approached certain changes, such as adding a svg file.

For this assignment we had to contribute to a Seneca repository. I chose the IPC144 repo.

Issue: https://github.com/Seneca-ICTOER/IPC144/issues/64 I worked on the standardized front matter across all markdown pages. This open-source project is the C language course notes of my major program.

And the reason why the web-only artifacts is still appear on the PDF page is because the --excludeSelectors option is not implemented enough. I have to add .clean-btn to the --excludeSelectors, the purpose of this is not to include the "On the page" artifact in side the PDF page. This is the final source code I have implement for this improvement and my pull request

I think I was able to do a good job meeting my goals I gave myself in my planning phase of this release. I was able to finish the issues well on schedule while balancing my other courses like I hoped and I was able to properly audit and fix both issues #122 and #123 without needing too many changes after review. What I learned from those two issues is the importance to read and checkout other issues/pull requests, especially for smaller repos. As I was told in the review for both my issues, I learned that the project recently made changes with how we would format the frontmatter. In PR #142 we no longer use the slug for pages due to inconsistency with links and we also need to include a description to follow the standardized Frontmatter as updated in PR #143.

The first issue I was working on IPC144 Course Note is about improving the usability of the PDF file generated from the website. All contents are generated inside the PDF, however, we want to get this better since some of the pictures are not showing properly, and also the web-only artifacts are still on the PDF, which we do not want it when we use the "PDF" version. convert-to-pdf.sh file would be modified a bit to accomplish this.

Issue #113

PR

As for this pull request, the code review went much more smoothly, with me having to only make minor changes to ensure that it would not cause any errors when built.

2. #issue-107

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.