angular-scope-types - npm Package Compare versions

Comparing version 1.0.0-beta.3 to 1.0.0-beta.4

CHANGELOG.md

@@ -0,1 +1,11 @@
+# 1.0.0-beta.4
+
+## New Features
+
+- Adding ability to specify your own instance of an `apiCheck` which allows you to use your own checkers.
+
+## Bug Fixes
+
+- Fixing the prefix for the `scopeTypes` instance of an `apiCheck` to be `angular-scope-types` rather than `api-check-angular`
+
 # 1.0.0-beta.3
@@ -2,0 +12,0 @@

dist/angular-scope-types.js

@@ -1,2 +0,2 @@
-// angular-scope-types version 1.0.0-beta.3 built with ♥ by Kent C. Dodds <[e-mail]> (http://kent.doddsfamily.us) (ó ì_í)=óò=(ì_í ò)
+// angular-scope-types version 1.0.0-beta.4 built with ♥ by Kent C. Dodds <[e-mail]> (http://kent.doddsfamily.us) (ó ì_í)=óò=(ì_í ò)
 
@@ -98,3 +98,3 @@ (function webpackUniversalModuleDefinition(root, factory) {
 
-	var defaultOutput = { prefix: 'api-check-angular' };
+	var defaultOutput = { prefix: 'angular-scope-types' };
 
@@ -106,3 +106,4 @@ exports['default'] = scopeTypesFactory;
 	    disabled: false,
-	    output: defaultOutput
+	    output: defaultOutput,
+	    apiCheckInstance: undefined
 	  } : arguments[0];
@@ -114,2 +115,3 @@
 	  var output = _ref$output === undefined ? defaultOutput : _ref$output;
+	  var apiCheckInstance = _ref.apiCheckInstance;
 
@@ -127,6 +129,8 @@ var scopeTypes = (0, _apiCheck2['default'])({
 
+	  apiCheckInstance = apiCheckInstance || scopeTypes;
+
 	  return scopeTypes;
 
 	  function validateDirective(ddo) {
-	    if (scopeTypes.config.disabled) {
+	    if (scopeTypes.config.disabled || apiCheckInstance.config.disabled) {
 	      return ddo;
@@ -146,4 +150,4 @@ }
 
-	      var typeDefinitions = ddo.scopeTypes(scopeTypes);
-	      scopeTypes.warn(scopeTypes.objectOf(scopeTypes.func), typeDefinitions, { prefix: 'getting scope types for ' + ddo.name });
+	      var typeDefinitions = ddo.scopeTypes(apiCheckInstance);
+	      scopeTypes.warn(scopeTypes.objectOf(scopeTypes.func).optional, typeDefinitions, { prefix: 'getting scope types for ' + ddo.name });
 
@@ -169,3 +173,3 @@ $scope.$scopeTypesResults = { __passed: 0, __failed: 0 };
 	      function checkOption(checker, name) {
-	        $scope.$scopeTypesResults[name] = scopeTypes.warn(checker, context[name], { prefix: '' + ddo.name + 'Directive for "' + name + '"' });
+	        $scope.$scopeTypesResults[name] = apiCheckInstance.warn(checker, context[name], { prefix: '' + ddo.name + 'Directive for "' + name + '"' });
 	        updateData();
@@ -172,0 +176,0 @@ }

dist/angular-scope-types.min.js

@@ -1,4 +0,4 @@
-// angular-scope-types version 1.0.0-beta.3 built with ♥ by Kent C. Dodds <[e-mail]> (http://kent.doddsfamily.us) (ó ì_í)=óò=(ì_í ò)
+// angular-scope-types version 1.0.0-beta.4 built with ♥ by Kent C. Dodds <[e-mail]> (http://kent.doddsfamily.us) (ó ì_í)=óò=(ì_í ò)
 
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("api-check"),require("angular")):"function"==typeof define&&define.amd?define(["api-check","angular"],t):"object"==typeof exports?exports.angularScopeTypes=t(require("api-check"),require("angular")):e.angularScopeTypes=t(e.apiCheck,e.angular)}(this,function(e,t){return function(e){function t(r){if(o[r])return o[r].exports;var n=o[r]={exports:{},id:r,loaded:!1};return e[r].call(n.exports,n,n.exports,t),n.loaded=!0,n.exports}var o={};return t.m=e,t.c=o,t.p="",t(0)}([function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}Object.defineProperty(t,"__esModule",{value:!0});var n=o(7),a=r(n);t["default"]=a["default"],e.exports=t["default"]},function(t,o,r){t.exports=e},function(e,t,o){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var r=o(8);r.version||(r=window.angular),t["default"]=r,e.exports=t["default"]},function(e,t,o){"use strict";function r(){}Object.defineProperty(t,"__esModule",{value:!0}),r.nullable=r,r.nullable.optional=r,t["default"]={noopChecker:r},e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}function n(){var e=void 0===arguments[0]?{strictDi:!1,disabled:!1}:arguments[0],t=e.scopeTypes,o=(e.strictDi,e.disabled),r=void 0===o?!1:o;if(r)return u["default"].noopChecker;var n=t;if(!n)throw new Error("Must provide an instance of scopeTypes");var a=t.oneOfType([n.string,n.func]),i=n.shape({priority:n.number.optional,template:n.shape.ifNot("templateUrl",a).optional,templateUrl:n.shape.ifNot("template",n.string).optional,transclude:n.bool.optional,restrict:n.oneOf(["A","E","C","AE","EA","AEC","AC","EC"]).optional,templateNamespace:n.oneOf(["html","svg","math"]).optional,scope:n.oneOfType([n.bool,n.objectOf(n.string)]).optional,controller:n.injectableFunction.optional,controllerAs:n.string.optional,bindToController:n.oneOfType([n.bool,n.objectOf(n.string)]).optional,require:n.typeOrArrayOf(n.string).optional,compile:n.func.optional,link:n.oneOfType([n.func,n.shape({pre:n.func.optional,post:n.func.optional}).strict]).optional,scopeTypes:n.func,data:n.object.optional}).strict;return n.oneOfType([n.func,i])}Object.defineProperty(t,"__esModule",{value:!0}),t["default"]=n;var a=o(3),u=r(a);e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}Object.defineProperty(t,"__esModule",{value:!0});var n=o(6),a=r(n),u=o(4),i=r(u);t["default"]={injectableFunction:a["default"],ddo:i["default"]},e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}function n(){var e=void 0===arguments[0]?{strictDi:!1,disabled:!1}:arguments[0],t=e.strictDi,o=void 0===t?!1:t,r=e.disabled,n=void 0===r?!1:r,a=u["default"].func.withProperties({$inject:u["default"].arrayOf(u["default"].string)}),i=u["default"].utils.checkerHelpers.setupChecker(function(e,t,o){if(!Array.isArray(e))return u["default"].utils.getError(t,o,u["default"].array.type);var r=e.slice(),n=r.pop(),a=u["default"].arrayOf(u["default"].string),i=a(r);return u["default"].utils.isError(i)?u["default"].utils.getError(t,o,a.type):"function"!=typeof n?u["default"].utils.getError(t,o,u["default"].func.type):void 0},{type:"angular injectable function (array syntax)"},n),l=[a,i];return o||l.push(u["default"].func),u["default"].oneOfType(l)}Object.defineProperty(t,"__esModule",{value:!0}),t["default"]=n;var a=o(1),u=r(a);e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}function n(){function e(e){function t(t){function o(o,a){t.$scopeTypesResults[a]=i.warn(o,n[a],{prefix:""+e.name+'Directive for "'+a+'"'}),r()}function r(){var e=0,o=0,r=["__passed","__failed"];u["default"].forEach(t.$scopeTypesResults,function(t,n){-1===r.indexOf(n)&&(t.passed?e++:o++)}),t.$scopeTypesResults.__passed=e,t.$scopeTypesResults.__failed=o}var n=t;e.bindToController&&(n=n[e.controllerAs]);var a=e.scopeTypes(i);i.warn(i.objectOf(i.func),a,{prefix:"getting scope types for "+e.name}),t.$scopeTypesResults={__passed:0,__failed:0},u["default"].forEach(a,function(r,a){u["default"].isDefined(n[a])?o(r,a):!function(){var n=e.controllerAs?e.controllerAs+".":"",u=t.$watch(""+n+a,function(e,t){e!==t&&(u(),o(r,a))})}()})}function o(e,t){function o(o,r,n,a,u,i){var l={$scope:o,$element:n,$attrs:a,$transclude:u};i.invoke(t,this,l),i.invoke(e,this,l)}return u["default"].isDefined(e)?(o.$inject=["$scope","$controller","$element","$attrs","$transclude","$injector"],o):t}return i.config.disabled?e:(i.warn(i.ddo,e,{prefix:"creating directive with scopeTypes"}),e.controller=o(e.controller,t),t.$inject=["$scope"],e)}var t=void 0===arguments[0]?{disabled:!1,output:c}:arguments[0],o=t.disabled,r=void 0===o?!1:o,n=t.output,a=void 0===n?c:n,i=l["default"]({output:a,disabled:r});return u["default"].forEach(f["default"],function(e,t){i[t]=e({scopeTypes:i,disabled:r})}),i.directive=e,i}Object.defineProperty(t,"__esModule",{value:!0});var a=o(2),u=r(a),i=o(1),l=r(i),s=o(5),f=r(s),c={prefix:"api-check-angular"};t["default"]=n,e.exports=t["default"]},function(e,o,r){e.exports=t}])});
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("api-check"),require("angular")):"function"==typeof define&&define.amd?define(["api-check","angular"],t):"object"==typeof exports?exports.angularScopeTypes=t(require("api-check"),require("angular")):e.angularScopeTypes=t(e.apiCheck,e.angular)}(this,function(e,t){return function(e){function t(r){if(o[r])return o[r].exports;var n=o[r]={exports:{},id:r,loaded:!1};return e[r].call(n.exports,n,n.exports,t),n.loaded=!0,n.exports}var o={};return t.m=e,t.c=o,t.p="",t(0)}([function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}Object.defineProperty(t,"__esModule",{value:!0});var n=o(7),a=r(n);t["default"]=a["default"],e.exports=t["default"]},function(t,o,r){t.exports=e},function(e,t,o){"use strict";Object.defineProperty(t,"__esModule",{value:!0});var r=o(8);r.version||(r=window.angular),t["default"]=r,e.exports=t["default"]},function(e,t,o){"use strict";function r(){}Object.defineProperty(t,"__esModule",{value:!0}),r.nullable=r,r.nullable.optional=r,t["default"]={noopChecker:r},e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}function n(){var e=void 0===arguments[0]?{strictDi:!1,disabled:!1}:arguments[0],t=e.scopeTypes,o=(e.strictDi,e.disabled),r=void 0===o?!1:o;if(r)return i["default"].noopChecker;var n=t;if(!n)throw new Error("Must provide an instance of scopeTypes");var a=t.oneOfType([n.string,n.func]),u=n.shape({priority:n.number.optional,template:n.shape.ifNot("templateUrl",a).optional,templateUrl:n.shape.ifNot("template",n.string).optional,transclude:n.bool.optional,restrict:n.oneOf(["A","E","C","AE","EA","AEC","AC","EC"]).optional,templateNamespace:n.oneOf(["html","svg","math"]).optional,scope:n.oneOfType([n.bool,n.objectOf(n.string)]).optional,controller:n.injectableFunction.optional,controllerAs:n.string.optional,bindToController:n.oneOfType([n.bool,n.objectOf(n.string)]).optional,require:n.typeOrArrayOf(n.string).optional,compile:n.func.optional,link:n.oneOfType([n.func,n.shape({pre:n.func.optional,post:n.func.optional}).strict]).optional,scopeTypes:n.func,data:n.object.optional}).strict;return n.oneOfType([n.func,u])}Object.defineProperty(t,"__esModule",{value:!0}),t["default"]=n;var a=o(3),i=r(a);e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}Object.defineProperty(t,"__esModule",{value:!0});var n=o(6),a=r(n),i=o(4),u=r(i);t["default"]={injectableFunction:a["default"],ddo:u["default"]},e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}function n(){var e=void 0===arguments[0]?{strictDi:!1,disabled:!1}:arguments[0],t=e.strictDi,o=void 0===t?!1:t,r=e.disabled,n=void 0===r?!1:r,a=i["default"].func.withProperties({$inject:i["default"].arrayOf(i["default"].string)}),u=i["default"].utils.checkerHelpers.setupChecker(function(e,t,o){if(!Array.isArray(e))return i["default"].utils.getError(t,o,i["default"].array.type);var r=e.slice(),n=r.pop(),a=i["default"].arrayOf(i["default"].string),u=a(r);return i["default"].utils.isError(u)?i["default"].utils.getError(t,o,a.type):"function"!=typeof n?i["default"].utils.getError(t,o,i["default"].func.type):void 0},{type:"angular injectable function (array syntax)"},n),l=[a,u];return o||l.push(i["default"].func),i["default"].oneOfType(l)}Object.defineProperty(t,"__esModule",{value:!0}),t["default"]=n;var a=o(1),i=r(a);e.exports=t["default"]},function(e,t,o){"use strict";function r(e){return e&&e.__esModule?e:{"default":e}}function n(){function e(e){function t(t){function o(o,a){t.$scopeTypesResults[a]=u.warn(o,n[a],{prefix:""+e.name+'Directive for "'+a+'"'}),r()}function r(){var e=0,o=0,r=["__passed","__failed"];i["default"].forEach(t.$scopeTypesResults,function(t,n){-1===r.indexOf(n)&&(t.passed?e++:o++)}),t.$scopeTypesResults.__passed=e,t.$scopeTypesResults.__failed=o}var n=t;e.bindToController&&(n=n[e.controllerAs]);var a=e.scopeTypes(u);s.warn(s.objectOf(s.func).optional,a,{prefix:"getting scope types for "+e.name}),t.$scopeTypesResults={__passed:0,__failed:0},i["default"].forEach(a,function(r,a){i["default"].isDefined(n[a])?o(r,a):!function(){var n=e.controllerAs?e.controllerAs+".":"",i=t.$watch(""+n+a,function(e,t){e!==t&&(i(),o(r,a))})}()})}function o(e,t){function o(o,r,n,a,i,u){var l={$scope:o,$element:n,$attrs:a,$transclude:i};u.invoke(t,this,l),u.invoke(e,this,l)}return i["default"].isDefined(e)?(o.$inject=["$scope","$controller","$element","$attrs","$transclude","$injector"],o):t}return s.config.disabled||u.config.disabled?e:(s.warn(s.ddo,e,{prefix:"creating directive with scopeTypes"}),e.controller=o(e.controller,t),t.$inject=["$scope"],e)}var t=void 0===arguments[0]?{disabled:!1,output:f,apiCheckInstance:void 0}:arguments[0],o=t.disabled,r=void 0===o?!1:o,n=t.output,a=void 0===n?f:n,u=t.apiCheckInstance,s=l["default"]({output:a,disabled:r});return i["default"].forEach(c["default"],function(e,t){s[t]=e({scopeTypes:s,disabled:r})}),s.directive=e,u=u||s,s}Object.defineProperty(t,"__esModule",{value:!0});var a=o(2),i=r(a),u=o(1),l=r(u),s=o(5),c=r(s),f={prefix:"angular-scope-types"};t["default"]=n,e.exports=t["default"]},function(e,o,r){e.exports=t}])});
 //# sourceMappingURL=angular-scope-types.min.js.map

package.json

 {
   "name": "angular-scope-types",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "description": "checkers and other utilities for using api-check with angular",
@@ -5,0 +5,0 @@ "main": "dist/angular-scope-types.js",

src/scopeTypes.js

@@ -5,3 +5,3 @@ import angular from 'angular-fix';
 
-const defaultOutput = {prefix: 'api-check-angular'};
+const defaultOutput = {prefix: 'angular-scope-types'};
 
@@ -12,6 +12,8 @@ export default scopeTypesFactory;
   disabled = false,
-  output = defaultOutput
+  output = defaultOutput,
+  apiCheckInstance
   } = {
   disabled: false,
-  output: defaultOutput
+  output: defaultOutput,
+  apiCheckInstance: undefined
 }) {
@@ -29,6 +31,8 @@ const scopeTypes = apiCheckFactory({
 
+  apiCheckInstance = apiCheckInstance || scopeTypes;
+
   return scopeTypes;
 
   function validateDirective(ddo) {
-    if (scopeTypes.config.disabled) {
+    if (scopeTypes.config.disabled || apiCheckInstance.config.disabled) {
       return ddo;
@@ -48,5 +52,7 @@ }
 
-      let typeDefinitions = ddo.scopeTypes(scopeTypes);
+      let typeDefinitions = ddo.scopeTypes(apiCheckInstance);
       scopeTypes.warn(
-        scopeTypes.objectOf(scopeTypes.func), typeDefinitions, {prefix: `getting scope types for ${ddo.name}`}
+        scopeTypes.objectOf(scopeTypes.func).optional,
+        typeDefinitions,
+        {prefix: `getting scope types for ${ddo.name}`}
       );
@@ -72,3 +78,3 @@
       function checkOption(checker, name) {
-        $scope.$scopeTypesResults[name] = scopeTypes.warn(
+        $scope.$scopeTypesResults[name] = apiCheckInstance.warn(
           checker, context[name], {prefix: `${ddo.name}Directive for "${name}"`}
@@ -75,0 +81,0 @@ );

src/scopeTypes.test.js

@@ -6,2 +6,3 @@ /* eslint no-console:0 */
 import sinon from 'sinon';
+import apiCheck from 'api-check';
 
@@ -83,2 +84,15 @@ import scopeTypesFactory from './scopeTypes';
 
+      it(`should allow you to pass your own instance of an apiCheck`, () => {
+        const myApiCheck = apiCheck({});
+        const myScopeTypes = scopeTypesFactory({apiCheckInstance: myApiCheck});
+        const myDirName = 'dirName';
+        const scopeTypesSpy = sinon.spy();
+        createDirective(myDirName, {scope: {}, scopeTypes: scopeTypesSpy}, myScopeTypes);
+        compileAndDigest({}, '<dir-name></dir-name>');
+        angular.mock.inject(['$injector', $injector => {
+          expect(scopeTypesSpy).to.have.been.called;
+          expectNoWarning();
+        }]);
+      });
+
       function createDirective(name, definition, scopeTypesInstance = scopeTypes) {
@@ -85,0 +99,0 @@ angular.mock.module(['$provide', '$compileProvider', function($provide, $compileProvider) {

No alert changes

Improved metrics

Total package byte prevSize

74042

increased by2.58%

Lines of code

815

increased by2.77%

No dependency changes