compodoc VS webpack-bundle-analyzer

✅ 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

I used to use webpack-bundle-analyzer but we have switched the builder to browser-esbuild now.

First start by running a webpack bundle analysis to see what exactly is bundled. You might be surprised about things being included that you didn't expect which can help with where to look.

Firstly I recommend taking a look at the structure of the webpack output with something like webpack-bundle-analyzer for any obvious over bundling issues.

See: https://github.com/webpack-contrib/webpack-bundle-analyzer

Webpack Bundle Analyzer

npm run analyse - analyse bundle with webpack-bundle-analyzer

This was my question as well. The article does answer the question, but off the bat I'd assumed the author was talking about output/dist. The web treemap cli is a great tip. If you are using webpack, webpack-bundle-analyzer is a helpful tool for quickly finding bloated packages. It's definitely helped me cut down my build times: https://github.com/webpack-contrib/webpack-bundle-analyzer

Here are a few tipps where you could save some time: 1)check angular.json (configurations -> "your ci config") - look for buildOptimizer / optimization 2)If you run npm ci during your pipeline it might make sense to create the node modules folder beforehand, it seems to save time (https://github.com/npm/cli/issues/2011) 3)Use ng build --stats-json to analyze your build 4)Use https://github.com/webpack-contrib/webpack-bundle-analyzer (also works together with 3. ) 5)Check your package.json for unused dependencies 6)Check your imports, import only what is needed Hope this helps

- `npm run start` - Start the app - `npm run lint` - Lint the project - `npm run test` - Run unit tests - `npm run build` - Build the project - `npm run build:prod` - Build the project in production mode - `npm run build:prod:stats` - Build the project in product mode with stats - `npm run analyse` - Analyse bundle with [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) - `npm run compodoc` - Generate [compodoc](https://github.com/compodoc/compodoc) documentation - `npm run version` - Generate changelog - `npm run prettier` - Format the whole project - `npm run audit` - Audit this application using Sonatype OSS Index