@timobechtel/style 1.2.0 → 1.4.0

package/README.md

@@ -51,6 +51,19 @@ module.exports = {
 };
 ```
 
+Note: You should disable `source.organizeImports` in your VSCode config, as this collides with the `import/order` rule.
+
+Add the following to your VSCode config, e.g. `.vscode/settings.json`
+
+```json
+{
+  "editor.codeActionsOnSave": {
+    // use eslint import/order instead
+    "source.organizeImports": false
+  }
+}
+```
+
 ### semantic-release
 
 This repo also contains a [semantic-release](https://github.com/semantic-release/semantic-release) configuration.

package/eslint/rules/typescript.cjs

@@ -76,8 +76,24 @@ module.exports = defineConfig({
     'import/namespace': 'off',
     'import/no-unresolved': 'off',
 
-    // This is disabled as we feel that checking empty strings is a valid use
+    // This is disabled as I feel that checking empty strings is a valid use
     // of `||` over `??`.
     '@typescript-eslint/prefer-nullish-coalescing': 'off',
+
+    // Disallow Promises in places not designed to handle them.
+    '@typescript-eslint/no-misused-promises': [
+      'error',
+      {
+        // Disabled as I feel that passing a async callback to a function expecting
+        // a void callback is a valid use case.
+        // e.g. fn.on('event', async () => {})
+        // Strictly requiring to return 'undefined' does not have a functional benefit,
+        // but makes the code more verbose.
+        checksVoidReturn: false,
+      },
+    ],
+    // While I'd prefer using types over interfaces, there are a lot of cases
+    // where interfaces are needed, e.g. merging declarations and this rule is too strict.
+    '@typescript-eslint/consistent-type-definitions': 'off',
   },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@timobechtel/style",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "type": "module",
   "files": [
     "bin",

package/prettier/index.mjs

@@ -8,6 +8,9 @@ const overridableDefaults = {
   endOfLine: 'lf',
   tabWidth: 2,
   printWidth: 80,
+  // Why I'd generally prefer tabs, as they are a lot more customizable,
+  // I've found that in a lot of places, tabs are displayed as 8 spaces by default,
+  // which makes it hard to read on mobile devices. (e.g. the GitHub app)
   useTabs: false,
 };