Do not annotate ui-router's $urlRouterProvider.otherwise

Currently, this:

$urlRouterProvider.otherwise(function ($injector) {
  //...
});

is being annotated into:

$urlRouterProvider.otherwise(["$injector", function ($injector) {
  //...
}]);

But ui-router expects a function:

this.otherwise =
    function (rule) {
      if (isString(rule)) {
        var redirect = rule;
        rule = function () { return redirect; };
      }
      else if (!isFunction(rule)) throw new Error("'rule' must be a function");
      otherwise = rule;
      return this;
    };

and already passes $injector as a parameter to otherwise:

function update() {
        function check(rule) {
          var handled = rule($injector, $location);
          if (handled) {
            if (isString(handled)) $location.replace().url(handled);
            return true;
          }
          return false;
        }
        var n=rules.length, i;
        for (i=0; i<n; i++) {
          if (check(rules[i])) return;
        }
        // always check otherwise last to allow dynamic updates to the set of rules
        if (otherwise) check(otherwise);
      }

I’m not being able to keep ng-annotate from annotating this by using:

regexp: /^((?!otherwise).)*$/

I probably misunderstood the regexp option, though.

Workaround:

var urlRouterProvider = $urlRouterProvider;
urlRouterProvider.otherwise(function ($injector) {
  //...
});

[gabrielmaldi]

I took a look at ui-router’s source and then ran a few tests.

Takeaways:

• Only when can handle an array with annotations and a function, i.e. this is OK:

$urlRouterProvider.when("someRoute", ['$match', '$stateParams', function ($match, $stateParams) {
  //...
}]);

Proof:

this.when =
    function (what, handler) {
      var redirect, handlerIsString = isString(handler);
      if (isString(what)) what = $urlMatcherFactory.compile(what);

      if (!handlerIsString && !isFunction(handler) && !isArray(handler))
        throw new Error("invalid 'handler' in when()");

• Neither rule nor otherwise will accept an array and will throw if that’s the case:

this.rule =
    function (rule) {
      if (!isFunction(rule)) throw new Error("'rule' must be a function");

this.otherwise =
    function (rule) {
      if (isString(rule)) {
        var redirect = rule;
        rule = function () { return redirect; };
      }
      else if (!isFunction(rule)) throw new Error("'rule' must be a function");

• $urlRouterProvider’s only public (and documented) functions are when, rule, and otherwise; so perhaps including anythingreally might bite us if new functions which can’t be annotated are added to ui-router in the future (but it is entirely up to you to make this call 😃).

[stodolos]

Never mind… I had two “config” functions (one for my module config and another from a directive’s config, which came from a template I purchased), and I was blaming the module config the whole time. I finally came to realization when I enabled ng-strict-di. That clearly told me the name of the piece causing the issue, and then I was able to narrow it down.