TypeScript Style Guide

[mjkeaton]

Add and agree on a basic TypeScript Style Guide.

Goals:

• Minimal intrusiveness for devs (code should be automatically formatted)
• Minimal changes to well established guides

See also:

• https://ts.dev/style/

Examples:

• https://mkosir.github.io/typescript-style-guide/
• https://google.github.io/styleguide/tsguide.html
• https://github.com/google/gts (Google TypeScript Style Guide)

Here, we should agree on a first blueprint of the enforced style rules. e.g. starting with gts.

[mjkeaton]

When trying to include gts there are several caveats along the way:

• gts still uses eslintrc.json instead of preferred eslint.config.js (https://eslint.org/docs/latest/use/configure/migration-guide#using-eslintrc-configs-in-flat-config)
• gts uses plugins incompatible with eslint v9 (https://eslint.org/docs/latest/use/configure/migration-guide#importing-plugins-and-custom-parsers, https://eslint.org/blog/2024/05/eslint-compatibility-utilities/)

There are already pull request to address these issues:

• Support for ESLint's New Flat Configs google/gts#830
• feat!: flat config for eslint migrated from old config google/gts#886
• fix(deps): update dependency eslint to v9 google/gts#881

But it might take a while to be implemented. Workarounds to make it compatible are cumbersome and error-prone. Downgrading to eslint v8 might be possible.