fix(types): Deprecate validateOptions

Because we have , we no longer need  and it is not the recommended
approach to validating your options anymore.

closes #403

Author: Kent C. Dodds

other/ERRORS_AND_WARNINGS.md

@@ -142,6 +142,12 @@ the apiCheck checkers are never even created. Not much we can do about the coupl
 a big issue. For more info, see [#334](https://github.com/formly-js/angular-formly/issues/334). Note, this will be
 removed in a major release.
 
+# validateOptions deprecated
+
+Because angular-formly already has a dependency on `api-check` and this is just a better way to validate your options,
+you should use this method instead. In an effort to simplify things. This has been deprecated in favor of the `apiCheck`
+property.
+
 # skipNgModelAttrsManipulator moved
 
 This property has been moved from the `data` property to the `extras` property.

src/directives/formly-field.test.js

@@ -104,12 +104,16 @@ describe('formly-field', function() {
   describe('api check', () => {
     let validateOptions;
     beforeEach(() => {
+      /* eslint no-console:0 */
+      const originalWarn = console.warn;
+      console.warn = () => {};
       validateOptions = sinon.spy();
       formlyConfig.setType({
         name: 'text', template: `<input name="{{id}}" ng-model="model[options.key]" />`,
         validateOptions
       });
       scope.model = {};
+      console.warn = originalWarn;
     });
 
     it('should throw an error when a field has extra properties', () => {

src/providers/formlyConfig.js

@@ -61,7 +61,7 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
       prefix: 'formlyConfig.setType',
       url: 'settype-validation-failed'
     });
-    checkApiCheck(options);
+    checkDeprecatedOptions(options);
     if (!options.overwriteOk) {
       checkOverwrite(options.name, typeMap, options, 'types');
     } else {
@@ -241,7 +241,7 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
     if (options.template) {
       formlyUsabilityProvider.checkWrapperTemplate(options.template, options);
     }
-    checkApiCheck(options);
+    checkDeprecatedOptions(options);
     if (!options.overwriteOk) {
       checkOverwrite(options.name, templateWrappersMap, options, 'templateWrappers');
     } else {
@@ -267,11 +267,19 @@ function formlyConfig(formlyUsabilityProvider, formlyErrorAndWarningsUrlPrefix,
     }
   }
 
-  function checkApiCheck(options) {
+  function checkDeprecatedOptions(options) {
     if (options.apiCheck && !angular.isFunction(options.apiCheck)) {
       warn(
         'apicheck-as-an-object-deprecated',
-        'apiCheck as an object has been deprecated',
+        'apiCheck as an object has been deprecated.',
+        `Attempted for type: ${options.name}`,
+        options
+      );
+    }
+    if (options.validateOptions) {
+      warn(
+        'validateoptions-deprecated',
+        'the `validateOptions` property has been deprecated.',
         `Attempted for type: ${options.name}`,
         options
       );

src/providers/formlyConfig.test.js

@@ -437,45 +437,70 @@ describe('formlyConfig', () => {
             childFn = sinon.spy();
           });
 
-          it(`should call the parent validateOptions function when there is no child function`, () => {
-            setterFn([
-              {name, template, validateOptions: parentFn},
-              {name: 'type2', extends: name}
-            ]);
-            getterFn('type2').validateOptions(options);
-            expect(parentFn).to.have.been.calledWith(options);
+          it(`should give a deprecation warning when specified as part of a type`, () => {
+            shouldWarn(
+              /Formly Warning: the `validateOptions` property has been deprecated. Attempted for type: foobar/,
+              function() {
+                setterFn({
+                  name: 'foobar',
+                  validateOptions() {}
+                });
+              }
+            );
           });
 
-          it(`should call the child validateOptions function when there is no parent function`, () => {
-            setterFn([
-              {name, template},
-              {name: 'type2', extends: name, validateOptions: childFn}
-            ]);
-            getterFn('type2').validateOptions(options);
-            expect(childFn).to.have.been.calledWith(options);
-          });
+          describe(`old functionality`, () => {
+            let originalWarn;
+            beforeEach(() => {
+              originalWarn = console.warn;
+              console.warn = () => {};
+            });
 
-          it(`should call the child validateOptions function and the parent validateOptions function when they are both present`, () => {
-            setterFn([
-              {name, template, validateOptions: parentFn},
-              {name: 'type2', extends: name, validateOptions: childFn}
-            ]);
-            getterFn('type2').validateOptions(options);
-            expect(childFn).to.have.been.calledWith(options);
-            expect(parentFn).to.have.been.calledWith(options);
-          });
+            it(`should call the parent validateOptions function when there is no child function`, () => {
+              setterFn([
+                {name, template, validateOptions: parentFn},
+                {name: 'type2', extends: name}
+              ]);
+              getterFn('type2').validateOptions(options);
+              expect(parentFn).to.have.been.calledWith(options);
+            });
 
-          it(`should pass the result of the child's defaultOptions with the given options to the parent's validateOptions function`, () => {
-            const defaultOptions = {data: {f: 'g'}};
-            const combinedOptions = {data: {a: 'b', c: {d: 'e'}, f: 'g'}};
-            setterFn([
-              {name, template, validateOptions: parentFn},
-              {name: 'type2', extends: name, validateOptions: childFn, defaultOptions}
-            ]);
-            getterFn('type2').validateOptions(options);
-            expect(childFn).to.have.been.calledWith(options);
-            expect(parentFn).to.have.been.calledWith(combinedOptions);
+            it(`should call the child validateOptions function when there is no parent function`, () => {
+              setterFn([
+                {name, template},
+                {name: 'type2', extends: name, validateOptions: childFn}
+              ]);
+              getterFn('type2').validateOptions(options);
+              expect(childFn).to.have.been.calledWith(options);
+            });
+
+            it(`should call the child validateOptions function and the parent validateOptions function when they are both present`, () => {
+              setterFn([
+                {name, template, validateOptions: parentFn},
+                {name: 'type2', extends: name, validateOptions: childFn}
+              ]);
+              getterFn('type2').validateOptions(options);
+              expect(childFn).to.have.been.calledWith(options);
+              expect(parentFn).to.have.been.calledWith(options);
+            });
+
+            it(`should pass the result of the child's defaultOptions with the given options to the parent's validateOptions function`, () => {
+              const defaultOptions = {data: {f: 'g'}};
+              const combinedOptions = {data: {a: 'b', c: {d: 'e'}, f: 'g'}};
+              setterFn([
+                {name, template, validateOptions: parentFn},
+                {name: 'type2', extends: name, validateOptions: childFn, defaultOptions}
+              ]);
+              getterFn('type2').validateOptions(options);
+              expect(childFn).to.have.been.calledWith(options);
+              expect(parentFn).to.have.been.calledWith(combinedOptions);
+            });
+
+            afterEach(() => {
+              console.warn = originalWarn;
+            });
           });
+
         });
 
         describe(`controller functions`, () => {
@@ -519,23 +544,6 @@ describe('formlyConfig', () => {
 
         });
       });
-
-      describe(`validateOptions`, () => {
-        it(`should allow you to specify this as a property of a type`, () => {
-          expect(() => {
-            setterFn({
-              name,
-              validateOptions,
-              template
-            });
-          }).to.not.throw();
-          expect(getterFn(name).validateOptions).to.be.a('function');
-
-          function validateOptions() {
-          }
-        });
-      });
-
     });
 
     describe('(◞‸◟；) path', () => {
@@ -601,7 +609,7 @@ describe('formlyConfig', () => {
 
     it(`should give a deprecation warning when providing apiCheck as an object rather than a function`, () => {
       shouldWarn(
-        /Formly Warning: apiCheck as an object has been deprecated Attempted for type: input/,
+        /Formly Warning: apiCheck as an object has been deprecated. Attempted for type: input/,
         function() {
           setterFn({
             name,