Skip to content

Commit 678aba7

Browse files
author
iscai-msft
committed
rename to no-reserved-words
1 parent 7b1ce4b commit 678aba7

2 files changed

Lines changed: 31 additions & 31 deletions

File tree

‎packages/typespec-client-generator-core/src/rules/reserved-words/create-reserved-word-rule.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ export function createReservedWordRule(
3030
reservedWords: LanguageReservedWords,
3131
) {
3232
return createRule({
33-
name: `reserved-words-${language}`,
33+
name: `no-reserved-words-${language}`,
3434
description: `Warns when identifiers conflict with ${displayName} reserved words.`,
3535
severity: "warning",
36-
url: `https://azure.github.io/typespec-azure/docs/libraries/typespec-client-generator-core/rules/reserved-words-${language}`,
36+
url: `https://azure.github.io/typespec-azure/docs/libraries/typespec-client-generator-core/rules/no-reserved-words-${language}`,
3737
messages: {
3838
default: paramMessage`'${"name"}' cannot be used as a ${"context"} name since it is a reserved word in ${"language"}. Consider using the @clientName decorator to rename it for ${"language"} code generation.`,
3939
},

packages/typespec-client-generator-core/test/rules/reserved-words.test.ts renamed to packages/typespec-client-generator-core/test/rules/no-reserved-words.test.ts

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -53,56 +53,56 @@ describe("reserved word rule factory", () => {
5353

5454
it("emits warning for reserved model name", async () => {
5555
await tester.expect(`model reserved { name: string; }`).toEmitDiagnostics({
56-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
56+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
5757
message: expectedMessage("reserved", "model", "Test"),
5858
});
5959
});
6060

6161
it("emits warning for reserved property name", async () => {
6262
await tester.expect(`model Foo { reserved: string; }`).toEmitDiagnostics({
63-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
63+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
6464
message: expectedMessage("reserved", "property", "Test"),
6565
});
6666
});
6767

6868
it("emits warning for reserved operation name", async () => {
6969
await tester.expect(`op reserved(): void;`).toEmitDiagnostics({
70-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
70+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
7171
message: expectedMessage("reserved", "operation", "Test"),
7272
});
7373
});
7474

7575
it("emits warning for reserved parameter name", async () => {
7676
await tester.expect(`op foo(reserved: string): void;`).toEmitDiagnostics({
77-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
77+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
7878
message: expectedMessage("reserved", "parameter", "Test"),
7979
});
8080
});
8181

8282
it("emits warning for reserved enum type name", async () => {
8383
await tester.expect(`enum reserved { a, b }`).toEmitDiagnostics({
84-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
84+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
8585
message: expectedMessage("reserved", "enum", "Test"),
8686
});
8787
});
8888

8989
it("emits warning for reserved enum member name", async () => {
9090
await tester.expect(`enum Foo { reserved }`).toEmitDiagnostics({
91-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
91+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
9292
message: expectedMessage("reserved", "enum member", "Test"),
9393
});
9494
});
9595

9696
it("emits warning for reserved union type name", async () => {
9797
await tester.expect(`union reserved { a: string, b: int32 }`).toEmitDiagnostics({
98-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
98+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
9999
message: expectedMessage("reserved", "union", "Test"),
100100
});
101101
});
102102

103103
it("emits warning for reserved union variant name", async () => {
104104
await tester.expect(`union Foo { reserved: string }`).toEmitDiagnostics({
105-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
105+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
106106
message: expectedMessage("reserved", "union variant", "Test"),
107107
});
108108
});
@@ -130,7 +130,7 @@ describe("reserved word rule factory", () => {
130130
await tester
131131
.expect(`model Foo { @clientName("notReserved", "otherlang") reserved: string; }`)
132132
.toEmitDiagnostics({
133-
code: "@azure-tools/typespec-client-generator-core/reserved-words-test",
133+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-test",
134134
message: expectedMessage("reserved", "property", "Test"),
135135
});
136136
});
@@ -157,7 +157,7 @@ describe("context isolation", () => {
157157

158158
it("warns when model-only reserved word is used as a model name", async () => {
159159
await tester.expect(`model modelonly { name: string; }`).toEmitDiagnostics({
160-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
160+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
161161
message: expectedMessage("modelonly", "model", "Isolated"),
162162
});
163163
});
@@ -178,7 +178,7 @@ describe("context isolation", () => {
178178

179179
it("warns when property-only reserved word is used as a property name", async () => {
180180
await tester.expect(`model Foo { proponly: string; }`).toEmitDiagnostics({
181-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
181+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
182182
message: expectedMessage("proponly", "property", "Isolated"),
183183
});
184184
});
@@ -195,7 +195,7 @@ describe("context isolation", () => {
195195

196196
it("warns when operation-only reserved word is used as an operation name", async () => {
197197
await tester.expect(`op oponly(): void;`).toEmitDiagnostics({
198-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
198+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
199199
message: expectedMessage("oponly", "operation", "Isolated"),
200200
});
201201
});
@@ -212,7 +212,7 @@ describe("context isolation", () => {
212212

213213
it("warns when parameter-only reserved word is used as a parameter name", async () => {
214214
await tester.expect(`op foo(paramonly: string): void;`).toEmitDiagnostics({
215-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
215+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
216216
message: expectedMessage("paramonly", "parameter", "Isolated"),
217217
});
218218
});
@@ -233,14 +233,14 @@ describe("context isolation", () => {
233233

234234
it("warns when enumType-only reserved word is used as an enum type name", async () => {
235235
await tester.expect(`enum enumtypeonly { a, b }`).toEmitDiagnostics({
236-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
236+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
237237
message: expectedMessage("enumtypeonly", "enum", "Isolated"),
238238
});
239239
});
240240

241241
it("warns when enumType-only reserved word is used as a union type name", async () => {
242242
await tester.expect(`union enumtypeonly { a: string, b: int32 }`).toEmitDiagnostics({
243-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
243+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
244244
message: expectedMessage("enumtypeonly", "union", "Isolated"),
245245
});
246246
});
@@ -257,14 +257,14 @@ describe("context isolation", () => {
257257

258258
it("warns when enumMember-only reserved word is used as an enum member name", async () => {
259259
await tester.expect(`enum Foo { enummemberonly }`).toEmitDiagnostics({
260-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
260+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
261261
message: expectedMessage("enummemberonly", "enum member", "Isolated"),
262262
});
263263
});
264264

265265
it("warns when enumMember-only reserved word is used as a union variant name", async () => {
266266
await tester.expect(`union Foo { enummemberonly: string }`).toEmitDiagnostics({
267-
code: "@azure-tools/typespec-client-generator-core/reserved-words-isolated",
267+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-isolated",
268268
message: expectedMessage("enummemberonly", "union variant", "Isolated"),
269269
});
270270
});
@@ -293,28 +293,28 @@ describe("python reserved words", () => {
293293

294294
it("emits warning for Python keyword used as property name", async () => {
295295
await tester.expect(`model Foo { \`yield\`: string; }`).toEmitDiagnostics({
296-
code: "@azure-tools/typespec-client-generator-core/reserved-words-python",
296+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python",
297297
message: expectedMessage("yield", "property", "Python"),
298298
});
299299
});
300300

301301
it("emits warning for 'self' used as property name (Python-specific)", async () => {
302302
await tester.expect(`model Foo { self: string; }`).toEmitDiagnostics({
303-
code: "@azure-tools/typespec-client-generator-core/reserved-words-python",
303+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python",
304304
message: expectedMessage("self", "property", "Python"),
305305
});
306306
});
307307

308308
it("emits warning for 'enum' used as model name (Python-specific)", async () => {
309309
await tester.expect(`model \`enum\` { name: string; }`).toEmitDiagnostics({
310-
code: "@azure-tools/typespec-client-generator-core/reserved-words-python",
310+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python",
311311
message: expectedMessage("enum", "model", "Python"),
312312
});
313313
});
314314

315315
it("emits warning for 'keys' used as property name (Python dict method conflict)", async () => {
316316
await tester.expect(`model Foo { keys: string; }`).toEmitDiagnostics({
317-
code: "@azure-tools/typespec-client-generator-core/reserved-words-python",
317+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python",
318318
message: expectedMessage("keys", "property", "Python"),
319319
});
320320
});
@@ -325,7 +325,7 @@ describe("python reserved words", () => {
325325

326326
it("emits warning for 'stream' used as parameter name (Python TSP-specific)", async () => {
327327
await tester.expect(`op foo(stream: string): void;`).toEmitDiagnostics({
328-
code: "@azure-tools/typespec-client-generator-core/reserved-words-python",
328+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python",
329329
message: expectedMessage("stream", "parameter", "Python"),
330330
});
331331
});
@@ -356,14 +356,14 @@ describe("csharp reserved words", () => {
356356

357357
it("emits warning for C# keyword used as property name", async () => {
358358
await tester.expect(`model Foo { \`namespace\`: string; }`).toEmitDiagnostics({
359-
code: "@azure-tools/typespec-client-generator-core/reserved-words-csharp",
359+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-csharp",
360360
message: expectedMessage("namespace", "property", "C#"),
361361
});
362362
});
363363

364364
it("emits warning for C# contextual keyword", async () => {
365365
await tester.expect(`model Foo { \`var\`: string; }`).toEmitDiagnostics({
366-
code: "@azure-tools/typespec-client-generator-core/reserved-words-csharp",
366+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-csharp",
367367
message: expectedMessage("var", "property", "C#"),
368368
});
369369
});
@@ -384,7 +384,7 @@ describe("java reserved words", () => {
384384

385385
it("emits warning for Java keyword used as property name", async () => {
386386
await tester.expect(`model Foo { \`synchronized\`: string; }`).toEmitDiagnostics({
387-
code: "@azure-tools/typespec-client-generator-core/reserved-words-java",
387+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-java",
388388
message: expectedMessage("synchronized", "property", "Java"),
389389
});
390390
});
@@ -405,7 +405,7 @@ describe("javascript reserved words", () => {
405405

406406
it("emits warning for JS keyword used as operation name", async () => {
407407
await tester.expect(`op \`function\`(): void;`).toEmitDiagnostics({
408-
code: "@azure-tools/typespec-client-generator-core/reserved-words-javascript",
408+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-javascript",
409409
message: expectedMessage("function", "operation", "JavaScript"),
410410
});
411411
});
@@ -472,7 +472,7 @@ describe("diagnostic message format", () => {
472472
"@azure-tools/typespec-client-generator-core",
473473
);
474474
await tester.expect(`model Foo { \`yield\`: string; }`).toEmitDiagnostics({
475-
code: "@azure-tools/typespec-client-generator-core/reserved-words-python",
475+
code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python",
476476
severity: "warning",
477477
message: expectedMessage("yield", "property", "Python"),
478478
});
@@ -495,8 +495,8 @@ describe("multiple reserved words in same spec", () => {
495495
}`,
496496
)
497497
.toEmitDiagnostics([
498-
{ code: "@azure-tools/typespec-client-generator-core/reserved-words-python" },
499-
{ code: "@azure-tools/typespec-client-generator-core/reserved-words-python" },
498+
{ code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python" },
499+
{ code: "@azure-tools/typespec-client-generator-core/no-reserved-words-python" },
500500
]);
501501
});
502502
});

0 commit comments

Comments
 (0)