angular-eslint VS lint-staged

Until I recently discovered that angular-eslint had added a new lint rule in v16.2 called prefer-self-closing-tags that can be used to enforce this syntax partially or throughout a project.

We are also using angular-eslint which now supports 16.0.3 so that was painless.

Along the lines of Angular ESLint, are there any packages that provide ESLint rules around writing SSR friendly code?

{ "root": true, "ignorePatterns": ["projects/**/*"], "rules": { "prettier/prettier": [ "error", { "endOfLine": "auto" } ] }, "overrides": [ { // TODO: find a way to apply rules on all files ending with .ts except for files ending with .stories.ts "files": ["*.ts"], "extends": [ "eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:@angular-eslint/recommended", "plugin:@angular-eslint/template/process-inline-templates", "plugin:prettier/recommended" ], "rules": { // https://github.com/angular-eslint/angular-eslint/tree/main/packages/eslint-plugin/docs/rules "@angular-eslint/directive-selector": [ "error", { "type": "attribute", "prefix": "hv", "style": "camelCase" } ], "@angular-eslint/component-selector": [ "error", { "type": "element", "prefix": "hv", "style": "kebab-case" } ], // https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/eslint-plugin/docs/rules "@typescript-eslint/member-ordering": "error", "@typescript-eslint/naming-convention": "error", // https://eslint.org/docs/latest/rules/ "default-case": "error", "default-case-last": "error" } }, { "files": ["*.html"], "extends": [ "plugin:@angular-eslint/template/recommended", "plugin:prettier/recommended" ], "rules": { // https://github.com/angular-eslint/angular-eslint/tree/main/packages/eslint-plugin-template/docs/rules "@angular-eslint/template/no-duplicate-attributes": ["error"], "@angular-eslint/template/attributes-order": ["error"], "@angular-eslint/template/no-call-expression": [ "error" ], "@angular-eslint/template/accessibility-elements-content": [ "error", { "allowList": [ "ariaLabel" ] } ], "@angular-eslint/template/accessibility-valid-aria": [ "error" ] } }, { "files": ["*.stories.@(ts|mjs|cjs)"], "extends": ["plugin:storybook/recommended"] // https://github.com/storybookjs/eslint-plugin-storybook/tree/main/docs/rules // "rules": {} } ] }

I don't think it's crazy, but these things improved my code quality a lot: * Use Prettier, an opinionated code formatter. It formats your code, no configuration, no fights with your colleagues. * Use eslint and SonarLint. They help you find bugs before you even commit your code. * Try to achieve a very high code coverage. Not every line needs to be covered, but I personally feel better if I've got 90+% coverage. It's not that hard once you include it in your coding-DNA. * Setup your IDE to properly debug your code. Don't do console.log(), use debugger; statements or real conditional breakpoints. Nothing sucks more than not being able to find out what your code really does. * Learn the ES6 and later features. Many developers tend to code in old ways (as they are used to), but JavaScript can do so much more these days. You'll save a lot of time and effort applying these new features. Start with Arrow Functions, followed by Rest and Spread operator, Property Shorthand and * Destructuring . Also note that there are some awesome new datastructures like Map and Set. * Learn TypeScript and keep yourself up to date. There are so many anti-patterns (never ever use any) that degregate your fancy, strictly typed highlevel code to buggy ES-code. It also helps a lot to reduce DRY and boilerplate. * Learn rxjs and use it on a daily base. Angular itself is really reactive as most Angular services return Observables that can be further processed with rxjs. Once your mind made the switch, you won't really use regular Events and/or loops anymore. But be aware of how to properly test your rxjs pipelines. * If you are integrating a remote API, I have very good experiences with OpenAPI and it's code generator for Angular. You will get ready-to-use interfaces and services just from an OpenAPI specification (which you get as a gift for many of the modern backend frameworks). Saves a lot of time and boilerplate code and removes the need to test and debug API-layer code. Your build will break as soon as the API introduces a breaking change, which is exactly what you want (it's too late if your app breaks on production)

If you're not already using Angular ESLint, you can add it to an Angular project by running the schematic:

ng add @angular-eslint/schematics ℹ Using package manager: npm ✔ Found compatible package version: @angular-eslint/[email protected]. ✔ Package information loaded. The package @angular-eslint/[email protected] will be installed and executed. Would you like to proceed? Yes ✔ Packages successfully installed. All @angular-eslint dependencies have been successfully installed 🎉 Please see https://github.com/angular-eslint/angular-eslint for how to add ESLint configuration to your project. We detected that you have a single project in your workspace and no existing linter wired up, so we are configuring ESLint for you automatically. Please see https://github.com/angular-eslint/angular-eslint for more information. CREATE .eslintrc.json (984 bytes) UPDATE package.json (1511 bytes) UPDATE angular.json (3447 bytes) ✔ Packages installed successfully.

We need two tools to get the job done. The first tool that we need is a pre-commit tool that runs for every git-commit action: Husky. The second tool that is needed is lint-staged, which will run specified scripts on matching staged files. Aside from these tools, we need a code repository with actual linting tools. We will be using an Angular project as an example with the Angular ESLint and Prettier pre-configured.

You can find all necessary tools and information to simplify the migration of existing Angular projects to ESLint at the GitHub Repo Angular ESLint.

We were already using lint-staged and have a pre-commit hook in place using Husky in our project for linter and prettier. So it made sense to add a check here.

Now you can config it in your package.json, here is the guide doc:

In the world of software development, maintaining consistent code quality and ensuring that the codebase adheres to predefined patterns and guidelines is crucial. However, manually enforcing these standards can be time-consuming and error-prone. This is where automation tools like Husky, Lint-Staged, Commitlint, and Commitizen come to the rescue. In this post, we will explore how these tools can be combined to streamline your development workflow.

This is wasted work that can and should be automated. Adding a linter and formatter on CI and a pre-commit hook such as lint-staged can do wonders.

lint-staged is a package that can be used to run formatting and linting commands on staged files in a Git repo.

To answer your next question: I lint and format on save, and I use Git hooks installed by Husky and executed through Lint-Staged (this tool helps ensure your Git hooks only run on modified files, etc) to ensure there are no lint or formatting errors whenever making a commit or pushing code. This is helpful for teams, as some developers tend to forget to run lint tasks, or don't have the Prettier extension installed in their IDE. If there are lint errors, the commit is rejected until fixed. YMMV - you'll need to fine-tune the strictness of this based on the team's needs.

Uses Husky Git hooks and Lint-staged pre-commit hooks.

Something else to consider is applying linting and formatting before every git commit. A package like Lint-staged only lints and formats on staged items, ensuring all pushed code follows the standards in the repo. This allows developers to have their own formatting preferences when developing, while the code homogenizes on push. Linting pre-commit also avoids strict rules like no-console or no-unused-vars restricting a developer when writing code, when it should only apply in production. Imagine not being able to console log anything during development!

Lint-Staged Docs

Additionally, there are pre-commit hooks which can be setup to seamlessly validate and modify the source code before every commit. I followed Prettier documentation to create one. I ran npx mrm@2 lint-staged which installed husky and lint-stagedand added a configuration to the project’s package.json. Then, I modified the commands a little and that's it.