feat(eslint): Propose Eslint plugin promise

BREAKING CHANGE: Most errors are not auto fixable, if needed, use // disable-next-line Or insert in .eslintrc: { "rules": { "promise/always-return": "warn", "promise/no-return-wrap": "warn", "promise/param-names": "warn", "promise/catch-or-return": "warn", "promise/no-native": "warn", "promise/no-nesting": "warn", "promise/no-promise-in-callback": "warn", "promise/no-callback-in-promise": "warn", "promise/avoid-new": "warn", "promise/no-new-statics": "warn", "promise/no-return-in-finally": "warn", "promise/valid-params": "warn" } }
cozy · Jan 7, 2022 · 1fded18 · 1fded18
1 parent ae2860c
commit 1fded18
Show file tree

Hide file tree

Showing 10 changed files with 646 additions and 479 deletions.
diff --git a/packages/cozy-harvest-lib/src/cli/cli.js b/packages/cozy-harvest-lib/src/cli/cli.js
@@ -201,11 +201,13 @@ const main = async () => {
   await args.handler(args, client)
 }
 
+// eslint-disable-next-line promise/catch-or-return
 main()
   .catch(e => {
     logger.error(e)
     process.exit(1)
   })
+  // eslint-disable-next-line promise/always-return
   .then(() => {
     process.exit(0)
   })
diff --git a/packages/cozy-harvest-lib/src/components/OAuthForm.jsx b/packages/cozy-harvest-lib/src/components/OAuthForm.jsx
@@ -33,6 +33,7 @@ export class OAuthForm extends PureComponent {
 
     if (konnectorPolicy.fetchExtraOAuthUrlParams) {
       this.setState({ needExtraParams: true })
+      // eslint-disable-next-line promise/catch-or-return
       konnectorPolicy
         .fetchExtraOAuthUrlParams({
           flow,

diff --git a/packages/cozy-harvest-lib/src/models/ConnectionFlow.js b/packages/cozy-harvest-lib/src/models/ConnectionFlow.js
@@ -255,6 +255,7 @@ export class ConnectionFlow {
       this.jobWatcher.disableSuccessTimer()
     }
 
+    // eslint-disable-next-line promise/param-names
     return new Promise(rawResolve => {
       const accountId = this.account._id
       assert(accountId, 'Cannot wait for two fa on account without id')

diff --git a/packages/cozy-realtime/examples/chat/index.js b/packages/cozy-realtime/examples/chat/index.js
@@ -70,11 +70,13 @@ const main = async () => {
   }
 }
 
+// eslint-disable-next-line promise/catch-or-return
 main()
   .catch(e => {
     console.error(e)
     process.exit(1)
   })
+  // eslint-disable-next-line promise/always-return
   .then(() => {
     process.exit(0)
   })
diff --git a/packages/cozy-realtime/src/RetryManager.spec.js b/packages/cozy-realtime/src/RetryManager.spec.js
@@ -161,7 +161,12 @@ describe('RetryManager', () => {
       retry.onFailure()
       retry.onFailure()
       retry.onFailure()
-      retry.waitBeforeNextAttempt().then(handler)
+      retry
+        .waitBeforeNextAttempt()
+        .then(handler)
+        .catch(err => {
+          throw err
+        })
       retry.stopCurrentAttemptWaitingTime()
       await sleep(25)
       expect(handler).toHaveBeenCalled()

diff --git a/packages/cozy-sharing/src/SharingProvider.jsx b/packages/cozy-sharing/src/SharingProvider.jsx
@@ -185,6 +185,7 @@ export class SharingProvider extends Component {
       })
     )
     this.setState({ hasLoadedAtLeastOnePage: true })
+    // eslint-disable-next-line promise/catch-or-return
     fetchNextPermissions(permissions, this.dispatch, client).then(() =>
       this.setState({ allLoaded: true })
     )

diff --git a/packages/cozy-sharing/src/components/ShareDialogTwoStepsConfirmationContainer.jsx b/packages/cozy-sharing/src/components/ShareDialogTwoStepsConfirmationContainer.jsx
@@ -173,13 +173,15 @@ const ShareDialogTwoStepsConfirmationContainer = ({
   }
 
   const onConfirmRecipient = () => {
+    // eslint-disable-next-line promise/catch-or-return,promise/always-return
     confirmRecipient(recipientConfirmationData).then(() => {
       getRecipientsToBeConfirmed()
     })
   }
 
   const onRejectRecipient = () => {
     setStatus('loading')
+    // eslint-disable-next-line promise/catch-or-return,promise/always-return
     rejectRecipient(recipientConfirmationData).then(() => {
       getRecipientsToBeConfirmed()
     })

diff --git a/packages/eslint-config-cozy-app/basics.js b/packages/eslint-config-cozy-app/basics.js
@@ -1,8 +1,12 @@
 'use strict'
 
 module.exports = {
-  plugins: ['prettier'],
-  extends: ['eslint:recommended', 'eslint-config-prettier'],
+  plugins: ['prettier', 'promise'],
+  extends: [
+    'eslint:recommended',
+    'eslint-config-prettier',
+    'plugin:promise/recommended'
+  ],
   parser: '@babel/eslint-parser',
   env: {
     browser: true,

diff --git a/packages/eslint-config-cozy-app/package.json b/packages/eslint-config-cozy-app/package.json
@@ -25,6 +25,7 @@
     "eslint": "^8.3.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-react": "^7.27.1",
     "eslint-plugin-react-hooks": "^4.3.0",
     "eslint-plugin-vue": "^8.1.1",