compodoc VS prettier

✅ Angular 15 ✅ Angular Material ✅ Unit Testing with Jest ✅ End-to-End Testing with [TestCafé](https://testcafe.io/ ✅ Internationalization with Transloco ✅ Auto documentation with Compodoc ✅ Analyse your project with webpack-bundle-analyzer ✅ Docker ✅ ESLint ✅ Prettier ✅ Commit Linting ✅ AuditJS Audit this application using Sonatype OSS Index ✅ Auto-generate a CHANGELOG with auto-changelog

Properly written code, there are documentation tool like this for Angular and others. https://compodoc.app/

Compodoc is a good tool for generating docs for an angular project. The documents generated also includes visual maps of dependencies.

App documentation, here is compodoc (https://compodoc.app/) It is generated when the dev does a git commit and build in the pipeline.

Finally, we have come to a point where we want our JSDoc comment documentations to turn into a full scale documentation website, which we can share with new developers instead of providing lengthy Word documents, or which can be used by the team to search for explanations and direction during development. Thankfully, there are amazing tools that help us build such sites easily, with just a console command. Today we will be exploring one such tool called Compodoc, which is a documentation website generator specifically designed for Angular projects (it also supports Nest and Stencil, but we will focus on Angular).

We use Compodoc in our applications. You write JSDoc comments and it does the hard work of creating the documentation for you.

npm run compodoc - generate compodoc documentation

✅ Angular 13 ✅ Angular Material ✅ Unit Testing with Jest ✅ End-to-End Testing with [TestCafé](https://testcafe.io/ ✅ Internationalization with Transloco ✅ Auto documentation with Compodoc ✅ Analyse your project with webpack-bundle-analyzer ✅ Docker ✅ ESLint ✅ Prettier ✅ Commit Linting ✅ AuditJS Audit this application using Sonatype OSS Index ✅ Auto-generate a CHANGELOG with auto-changelog

Not too sure about a diagramming tool for a new project, but I've used compodoc to automatically generate documentation and diagrams for existing Angular apps before and would definitely recommend checking it out

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.

GitHub | Website

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

What is Prettier 😎?