typescript-eslint VS eslint-config-google

TypeScript Best Practices

Here’s some relevant discussion about some of the footguns:

https://github.com/typescript-eslint/typescript-eslint/issue...

https://github.com/tc39/proposal-explicit-resource-managemen...

I imagine there will eventually be lint rules for this somewhere and many of those using such a modern feature are likely to be using static analysis via eslint to help mitigate the risks here, but until it’s more established and understood and lint rules are fleshed out and widely adopted, there is risk here for sure.

Seems a bit like popular lint library maintainers are overly wary to add rules before it’s better understood through wider adoption and potential adopters are wary of using it until footguns are mitigated — not quite a standstill but maybe not great either

However, I prefer more thorough rules like checking unused type imports or type narrowing problems. In order to enable these checks, we need to tweak eslint.config.js. I prefer simply adding recommendedTypeChecked config to the project. Don't forget that you also need to adapt parserOptions to this change.

EsLint: New to ESLint? It helps you write better JavaScript and TypeScript. https://typescript-eslint.io/

For ESLint + TypeScript ESLint, with the new flat config eslint.config.js:

Typescript-eslint can assist in this task. This tool helps identify all instances of unsafe any usage. Specifically, all usages of JSON.parse can be found and it can be ensured that the received data's format is checked. More about getting rid of the any type in a codebase can be read in the article Making TypeScript Truly "Strongly Typed".

> Only lint files that have changed? How hard that is?

Quite hard, especially since type-aware rules from e.g. https://typescript-eslint.io/ mean that changing the type of a variable in file A can break your code in file B, even if file B hasn't changed.

The article only touches this: when converting to TypeScript, `any` is useful, but in the end you don't want this type in your codebase - so don't forget to use typescript-eslint [0] and turn on those no-unsafe-* rules which guard against `any` leaking into your code.

[0] https://github.com/typescript-eslint/typescript-eslint

GitHub - google/eslint-config-google: ESLint shareable config for the Google JavaScript style guide

# question 1: ? How would you like to use ESLint? … To check syntax only To check syntax and find problems ❯ To check syntax, find problems, and enforce code style # question 2: ? What type of modules does your project use? … ❯ JavaScript modules (import/export) CommonJS (require/exports) None of these # question 3: ? Which framework does your project use? … ❯ React Vue.js None of these # question 4 (select "No", because we won't add TypeScript support for this project): ? Does your project use TypeScript? › No / Yes # question 5: ? Where does your code run? … Browser ✔ Node # question 6: ? How would you like to define a style for your project? … ❯ Use a popular style guide Answer questions about your style Inspect your JavaScript file(s) # question 7 (we'll rely on Airbnb's JavaScript style guide here): ? Which style guide do you want to follow? … ❯ Airbnb: https://github.com/airbnb/javascript Standard: https://github.com/standard/standard Google: https://github.com/google/eslint-config-google # question 8: ? What format do you want your config file to be in? … JavaScript YAML ❯ JSON # the final prompt here is where eslint will ask you if you want to install all the necessary dependencies. Select "Yes" and hit enter: Checking peerDependencies of eslint-config-airbnb@latest The config that you have selected requires the following dependencies: eslint-plugin-react@^7.21.5 eslint-config-airbnb@latest eslint@^5.16.0 || ^6.8.0 || ^7.2.0 eslint-plugin-import@^2.22.1 eslint-plugin-jsx-a11y@^6.4.1 eslint-plugin-react-hooks@^4 || ^3 || ^2.3.0 || ^1.7.0 ? Would you like to install them now with npm? › No / Yes

Feel free to play around with the rules defined above or extend some of the other configurations like eslint-config-google to figure out what’s best suited for your project.

The Google JavaScript Style Guide was released in 2012, and it has the complete definition of coding standards used at Google. This style guide has two parts, one focusing on style rules (aesthetic issues of formatting) and the other focusing on language rules (conventions and coding standards). In addition, it has an ESLint package that you can use to incorporate the style guide into your project.

Google

It is much easier to understand a large project when its code is written in a consistent style. This is where style guides come in handy. Using a style guide enhances a team's productivity and avoids arguments about the best style guide for Node.js projects. In addition, you can opt-in to already existing style guides created at companies like Google and Airbnb that have been tested with time.

Google’s eslint config

# 1 - Inicio da configuração do eslint yarn eslint --init # 2 - Escolha a opção "To check syntax, find problems, and enforce code style" How would you like to use ESLint? To check syntax only To check syntax and find problems ❯ To check syntax, find problems, and enforce code style # 3 - Escolha a opção "JavaScript modules (import/export)" What type of modules does your project use? ❯ JavaScript modules (import/export) CommonJS (require/exports) None of these # 4 - Escolha a opção "React" Which framework does your project use? ❯ React Vue.js None of these # 5 - Escolha a opção "Yes" Does your project use TypeScript? No ❯ Yes # 6 - Pressionando a barra de espaço, deixe selecionado somente a opção "Browser" Where does your code run? ✔ Browser Node # 7 - Escolha a opção "Use a popular style guide" How would you like to define a style for your project? … ❯ Use a popular style guide Answer questions about your style Inspect your JavaScript file(s) # 8 - Escolha a opção "Use a popular style guide" How would you like to define a style for your project? … ❯ Use a popular style guide Answer questions about your style Inspect your JavaScript file(s) # 9 - Escolha a opção "Airbnb" Which style guide do you want to follow? ❯ Airbnb: https://github.com/airbnb/javascript Standard: https://github.com/standard/standard Google: https://github.com/google/eslint-config-google XO: https://github.com/xojs/eslint-config-xo # 10 - Escolha a opção "JavaScript" What format do you want your config file to be in? … ❯ JavaScript YAML JSON # 11 - Escolha a opção "Yes" Would you like to install them now with npm? No ❯ Yes