Skip to content

Commit c20d6df

Browse files
refactor(prefer-readonly-type): give error message ids more explicit names
1 parent f5f3930 commit c20d6df

File tree

2 files changed

+85
-84
lines changed

2 files changed

+85
-84
lines changed

src/rules/prefer-readonly-type.ts

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,10 @@ const defaultOptions: Options = {
8080

8181
// The possible error messages.
8282
const errorMessages = {
83-
array: "Only readonly arrays allowed.",
84-
implicit: "Implicitly a mutable array. Only readonly arrays allowed.",
85-
property: "A readonly modifier is required.",
86-
tuple: "Only readonly tuples allowed.",
87-
type: "Only readonly types allowed.",
83+
arrayShouldBeReadonly: "Array should be readonly.",
84+
propertyShouldBeReadonly: "This property should be readonly.",
85+
tupleShouldBeReadonly: "Tuple should be readonly.",
86+
typeShouldBeReadonly: "Type should be readonly.",
8887
} as const;
8988

9089
// The meta data for this rule.
@@ -137,7 +136,9 @@ function checkArrayOrTupleType(
137136
? [
138137
{
139138
node,
140-
messageId: isTSTupleType(node) ? "tuple" : "array",
139+
messageId: isTSTupleType(node)
140+
? "tupleShouldBeReadonly"
141+
: "arrayShouldBeReadonly",
141142
fix:
142143
node.parent !== undefined && isTSArrayType(node.parent)
143144
? (fixer) => [
@@ -166,7 +167,7 @@ function checkMappedType(
166167
: [
167168
{
168169
node,
169-
messageId: "property",
170+
messageId: "propertyShouldBeReadonly",
170171
fix: (fixer) =>
171172
fixer.insertTextBeforeRange(
172173
[node.range[0] + 1, node.range[1]],
@@ -205,7 +206,7 @@ function checkTypeReference(
205206
? [
206207
{
207208
node,
208-
messageId: "type",
209+
messageId: "typeShouldBeReadonly",
209210
fix: (fixer) => fixer.replaceText(node.typeName, immutableType),
210211
},
211212
]
@@ -238,7 +239,7 @@ function checkProperty(
238239
? [
239240
{
240241
node,
241-
messageId: "property",
242+
messageId: "propertyShouldBeReadonly",
242243
fix:
243244
isTSIndexSignature(node) || isTSPropertySignature(node)
244245
? (fixer) => fixer.insertTextBefore(node, "readonly ")
@@ -303,7 +304,7 @@ function checkForImplicitMutableArray(
303304
? [
304305
{
305306
node: declarator.node,
306-
messageId: "implicit",
307+
messageId: "arrayShouldBeReadonly",
307308
fix: (fixer) =>
308309
fixer.insertTextAfter(declarator.id, ": readonly unknown[]"),
309310
},

0 commit comments

Comments
 (0)