feat: toggling require-await on the testing config

erunion · erunion · commit 283dfa3d9e6b · 2020-06-09T11:40:14.000-07:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,4 +1,4 @@
-name: Node CI
+name: CI
 
 on: [push]
 
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ Core coding standards for ReadMe projects.
 
 ## Installation
 
-You'll need to install [`eslint`](https://www.npmjs.com/package/eslint) and [`prettier`](https://www.npmjs.com/package/prettier) into your project. Use this shortcut to install them alongside the config (if using **npm 5+**):
+You'll need to install [`ESLint`](https://www.npmjs.com/package/eslint) and [`Prettier`](https://www.npmjs.com/package/prettier) into your project. Use this shortcut to install them alongside the config (if using **npm 5+**):
 
 ```sh
 npx install-peerdeps --dev @readme/eslint-config
diff --git a/testing.js b/testing.js
@@ -5,6 +5,8 @@ module.exports = {
     'jest/globals': true,
   },
   rules: {
+    'import/no-extraneous-dependencies': 'off',
+
     'jest/consistent-test-it': 'warn',
     'jest/expect-expect': 'error',
     'jest/no-deprecated-functions': 'off',
@@ -20,9 +22,13 @@ module.exports = {
     'jest/valid-describe': 'error',
     'jest/valid-title': 'warn',
 
-    'import/no-extraneous-dependencies': 'off',
     'node/no-extraneous-require': 'off',
 
+    // Sniff out tests that have useless `async` declarations. Since there's valid usecases for
+    // having a function be async and not return or await a Promise, we're only running this rule
+    // for tests where such a case isn't likely to be a thing.
+    'require-await': 'error',
+
     'sonarjs/no-identical-functions': 'off',
   },
 };

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: Node CI`
	`1`	`+name: CI`
`2`	`2`
`3`	`3`	`on: [push]`
`4`	`4`