warn about a common configuration oversight (#4817)

apostrophecms · Dec 10, 2024 · 9c35a72 · 9c35a72
1 parent 9c6b6bb
commit 9c35a72
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## UNRELEASED
 
+### Adds
+
+* When validating an `area` field, warn the developer if `widgets` is not nested in `options`.
+
 ### Fixes
 
 * Focus properly Widget Editor modals when opened. Keep the previous active focus on the modal when closing the widget editor.

diff --git a/modules/@apostrophecms/schema/lib/addFieldTypes.js b/modules/@apostrophecms/schema/lib/addFieldTypes.js
@@ -56,6 +56,13 @@ module.exports = (self) => {
       return _.isEqual(oneArea, twoArea);
     },
     validate: function (field, options, warn, fail) {
+      if (field.widgets) {
+        warn(stripIndents`
+          Remember to nest "widgets" inside "options" when configuring an area field.
+
+          Otherwise, "widgets" has no effect.
+        `);
+      }
       let widgets = (field.options && field.options.widgets) || {};
 
       if (field.options && field.options.groups) {