configuration.js default export requires eslint rule#1523
configuration.js default export requires eslint rule#1523frumbert wants to merge 1 commit intomoodle:mainfrom
Conversation
grunt complains that Promise executor functions should not be async no-async-promise-executor This change skips the async check
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR updates the TinyMCE plugin type documentation to avoid an ESLint failure (no-async-promise-executor) triggered by a JavaScript example snippet in the docs.
Changes:
- Adds an
eslint-disable-next-line no-async-promise-executordirective to a documentedexport default new Promise(async (resolve) => { ... })example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // eslint-disable-next-line no-async-promise-executor | ||
| export default new Promise(async(resolve) => { | ||
| // ... Plugin code goes here. |
There was a problem hiding this comment.
Using // eslint-disable-next-line no-async-promise-executor here documents an ESLint suppression rather than showing a recommended pattern, and it may not fully resolve the lint failure because this same new Promise(async (resolve) => ...) pattern appears elsewhere in this doc (and in the versioned copies). Prefer rewriting the example(s) to avoid an async Promise executor (e.g., export an async IIFE that returns the tuple, or keep a non-async executor and call an inner async function with explicit reject handling) so the docs and linting both align with the rule.
There was a problem hiding this comment.
This eslint suggestion is already present in the source of almost all the built-in plugins, such as https://github.com/moodle/moodle/blob/main/public/lib/editor/tiny/plugins/autosave/amd/src/plugin.js
While refactoring might be the better solution in the long run, it's not how it works right now and this is documentation about how it works right now.
1 participant
grunt complains that
Promise executor functions should not be async no-async-promise-executor
This change skips the async check