/
service-name.js
94 lines (81 loc) · 3.15 KB
/
service-name.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
/**
* require and specify a prefix for all service names
*
* All your services should have a name starting with the parameter you can define in your config object.
* The second parameter can be a Regexp wrapped in quotes.
* You can not prefix your services by "$" (reserved keyword for AngularJS services) ("service-name": [2, "ng"])
**
* @styleguideReference {johnpapa} `y125` Naming - Factory and Service Names
* @version 0.1.0
* @category naming
* @sinceAngularVersion 1.x
*/
'use strict';
var utils = require('./utils/utils');
/**
* @param {Array.<*>} options
* @returns {?string}
*/
function getPrefixFromOptions(options) {
return options.find(function(option) {
return ['String', 'RegExp', 'Null', 'Undefined'].indexOf(utils.getToStringTagType(option)) !== -1;
});
}
/**
* @param {Array.<*>} options
* @returns {Object}
*/
function getConfig(options) {
var config = options.find(function(option) {
return utils.getToStringTagType(option) === 'Object';
});
config = config || {};
if (typeof config.oldBehavior !== 'boolean') {
config = Object.assign({
oldBehavior: true
});
}
return config;
}
module.exports = function(context) {
return {
CallExpression: function(node) {
var config = getConfig(context.options);
var prefix = getPrefixFromOptions(context.options);
var convertedPrefix; // convert string from JSON .eslintrc to regex
var isService;
if (prefix === undefined) {
return;
}
convertedPrefix = utils.convertPrefixToRegex(prefix);
if (config.oldBehavior) {
isService = utils.isAngularServiceDeclarationDeprecated(node);
// Warning that the API is deprecated
// eslint-disable-next-line
console.warn('The rule `angular/service-name` will be split up to different rules in the next version. Please read the docs for more information');
} else {
isService = utils.isAngularServiceDeclaration(node);
}
if (isService) {
var name = node.arguments[0].value;
if (name !== undefined && name.indexOf('$') === 0) {
context.report(node, 'The {{service}} service should not start with "$". This is reserved for AngularJS services', {
service: name
});
} else if (name !== undefined && !convertedPrefix.test(name)) {
if (typeof prefix === 'string' && !utils.isStringRegexp(prefix)) {
context.report(node, 'The {{service}} service should be prefixed by {{prefix}}', {
service: name,
prefix: prefix
});
} else {
context.report(node, 'The {{service}} service should follow this pattern: {{prefix}}', {
service: name,
prefix: prefix.toString()
});
}
}
}
}
};
};