forked from typescript-eslint/typescript-eslint
/
class-name-casing.js
101 lines (88 loc) · 3.2 KB
/
class-name-casing.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
95
96
97
98
99
100
101
/**
* @fileoverview Enforces PascalCased class and interface names.
* @author Jed Fox
* @author Armano <https://github.com/armano2>
*/
"use strict";
const util = require("../util");
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = {
meta: {
type: "suggestion",
docs: {
description: "Require PascalCased class and interface names",
extraDescription: [util.tslintRule("class-name")],
category: "Best Practices",
url: util.metaDocsUrl("class-name-casing"),
recommended: "error",
},
schema: [],
},
create(context) {
// variables should be defined here
//----------------------------------------------------------------------
// Helpers
//----------------------------------------------------------------------
/**
* Determine if the identifier name is PascalCased
* @param {string} name The identifier name
* @returns {boolean} Is the name PascalCased?
*/
function isPascalCase(name) {
return /^[A-Z][0-9A-Za-z]*$/.test(name);
}
/**
* Report a class declaration as invalid
* @param {Node} decl The declaration
* @param {Node} [id=classDecl.id] The name of the declaration
* @returns {undefined}
*/
function report(decl, id) {
const resolvedId = id || decl.id;
let friendlyName;
switch (decl.type) {
case "ClassDeclaration":
case "ClassExpression":
friendlyName = "Class";
break;
case "TSAbstractClassDeclaration":
friendlyName = "Abstract class";
break;
case "TSInterfaceDeclaration":
friendlyName = "Interface";
break;
default:
friendlyName = decl.type;
}
context.report({
node: resolvedId,
message: "{{friendlyName}} '{{name}}' must be PascalCased.",
data: {
friendlyName,
name: resolvedId.name,
},
});
}
//----------------------------------------------------------------------
// Public
//----------------------------------------------------------------------
return {
"ClassDeclaration, TSInterfaceDeclaration, TSAbstractClassDeclaration, ClassExpression"(
node
) {
// class expressions (i.e. export default class {}) are OK
if (node.id && !isPascalCase(node.id.name)) {
report(node);
}
},
"VariableDeclarator[init.type='ClassExpression']"(node) {
const id = node.id;
if (id && !node.init.id && !isPascalCase(id.name)) {
report(node.init, id);
}
},
};
},
};