From a365a0c3ff3e0c0df3bdabce47fa38f6d2648ff8 Mon Sep 17 00:00:00 2001
From: Coleman Watts <coleman@civicrm.org>
Date: Mon, 9 Dec 2019 10:49:02 -0500
Subject: [PATCH] Stricter directives with better docs

---
 ext/afform/core/ang/af.ang.php      | 4 ++--
 ext/afform/core/ang/af/Entity.js    | 5 ++---
 ext/afform/core/ang/af/Fieldset.js  | 7 +++----
 ext/afform/core/ang/af/Form.js      | 6 ++----
 ext/afform/core/ang/afField.ang.php | 2 +-
 5 files changed, 10 insertions(+), 14 deletions(-)

diff --git a/ext/afform/core/ang/af.ang.php b/ext/afform/core/ang/af.ang.php
index 0dae45cef5..249a7a6e39 100644
--- a/ext/afform/core/ang/af.ang.php
+++ b/ext/afform/core/ang/af.ang.php
@@ -15,8 +15,8 @@ return [
   'settings' => [],
   'basePages' => [],
   'exports' => [
-    'af-entity' => 'AE',
+    'af-entity' => 'E',
     'af-fieldset' => 'A',
-    'af-form' => 'AE',
+    'af-form' => 'E',
   ],
 ];
diff --git a/ext/afform/core/ang/af/Entity.js b/ext/afform/core/ang/af/Entity.js
index 561563d6ca..fdb791e20f 100644
--- a/ext/afform/core/ang/af/Entity.js
+++ b/ext/afform/core/ang/af/Entity.js
@@ -1,6 +1,5 @@
 (function(angular, $, _) {
-  // "afEntity" is a basic skeletal directive.
-  // Example usage: <af-form>... <af-entity name="myModel" type="Individual" /> ...</af-form>
+  // Example usage: <af-form><af-entity name="Person" type="Contact" /> ... <fieldset af-fieldset="Person> ... </fieldset></af-form>
   angular.module('af').directive('afEntity', function() {
     // Whitelist of all allowed properties of an af-fieldset
     // (at least the ones we care about client-side - other's can be added for server-side processing and we'll just ignore them)
@@ -12,7 +11,7 @@
       autofill: '@'
     };
     return {
-      restrict: 'AE',
+      restrict: 'E',
       require: '^afForm',
       scope: modelProps,
       link: function($scope, $el, $attr, afFormCtrl) {
diff --git a/ext/afform/core/ang/af/Fieldset.js b/ext/afform/core/ang/af/Fieldset.js
index 63e338554d..47da042458 100644
--- a/ext/afform/core/ang/af/Fieldset.js
+++ b/ext/afform/core/ang/af/Fieldset.js
@@ -1,6 +1,5 @@
 (function(angular, $, _) {
-  // "afFieldset" is a basic skeletal directive.
-  // Example usage: <af-form>... <div af-fieldset="myModel">...</div> ...</af-form>
+  // Example usage: <af-form><af-entity name="Person" type="Contact" /> ... <fieldset af-fieldset="Person> ... </fieldset></af-form>
   angular.module('af').directive('afFieldset', function() {
     return {
       restrict: 'A',
@@ -12,7 +11,7 @@
         $scope.afFormCtrl = afFormCtrl;
         // This is faster than waiting for each field directive to register itself
         $('af-field', $el).each(function() {
-          afFormCtrl.registerField($scope.modelName, $(this).attr('name'))
+          afFormCtrl.registerField($scope.modelName, $(this).attr('name'));
         });
       },
       controller: function($scope){
@@ -25,7 +24,7 @@
         };
         this.getName = function() {
           return $scope.modelName;
-        }
+        };
       }
     };
   });
diff --git a/ext/afform/core/ang/af/Form.js b/ext/afform/core/ang/af/Form.js
index 2810e8cfe1..1083ebc634 100644
--- a/ext/afform/core/ang/af/Form.js
+++ b/ext/afform/core/ang/af/Form.js
@@ -1,11 +1,9 @@
 (function(angular, $, _) {
-  // "afForm" is a basic skeletal directive.
-  // Example usage: <af-form ctrl="myCtrl">
+  // Example usage: <af-form ctrl="modelListCtrl">
   angular.module('af').directive('afForm', function() {
     return {
-      restrict: 'AE',
+      restrict: 'E',
       scope: {
-        // afForm: '=',
         ctrl: '@'
       },
       link: {
diff --git a/ext/afform/core/ang/afField.ang.php b/ext/afform/core/ang/afField.ang.php
index a50114e60d..6f42674372 100644
--- a/ext/afform/core/ang/afField.ang.php
+++ b/ext/afform/core/ang/afField.ang.php
@@ -18,6 +18,6 @@ return [
   'settings' => [],
   'basePages' => [],
   'exports' => [
-    'af-field' => 'AE',
+    'af-field' => 'E',
   ],
 ];
-- 
2.25.1