Skip to content

Commit c3cd099

Browse files
Fix linter rule docs using : instead of / as separator (microsoft#2524)
fix microsoft#2520
1 parent ee5dc78 commit c3cd099

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/extending-typespec/linters.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,22 @@ export const $lib = createTypeSpecLibrary({
109109
ruleSets: {
110110
recommended: {
111111
// (optional) A ruleset takes a map of rules to explicitly enable
112-
enable: { [`@typespec/my-linter:${requiredDocRule.name}`]: true },
112+
enable: { [`@typespec/my-linter/${requiredDocRule.name}`]: true },
113113

114114
// (optional) A rule set can extend another rule set
115-
extends: ["@typespec/best-practices:recommended"],
115+
extends: ["@typespec/best-practices/recommended"],
116116

117117
// (optional) A rule set can disable a rule enabled in a ruleset it extended.
118118
disable: {
119-
"`@typespec/best-practices:no-a": "This doesn't apply in this ruleset.",
119+
"`@typespec/best-practices/no-a": "This doesn't apply in this ruleset.",
120120
},
121121
},
122122
},
123123
},
124124
});
125125
```
126126

127-
When referencing a rule or ruleset(in `enable`, `extends`, `disable`) the rule or rule set id must be used which in this format: `<libraryName>:<ruleName>`
127+
When referencing a rule or ruleset(in `enable`, `extends`, `disable`) the rule or rule set id must be used which in this format: `<libraryName>/<ruleName>`
128128

129129
## Testing a linter
130130

@@ -147,7 +147,7 @@ describe("required-doc rule", () => {
147147

148148
it("emit diagnostics when using model named foo", async () => {
149149
await ruleTester.expect(`model Foo {}`).toEmitDiagnostics({
150-
code: "@typespec/my-linter:no-foo-model",
150+
code: "@typespec/my-linter/no-foo-model",
151151
message: "Cannot name a model with 'Foo'",
152152
});
153153
});

docs/introduction/configuration/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -316,13 +316,13 @@ Configure which linter rules should be enabled in this repository. Referencing t
316316
```yaml
317317
linter:
318318
extends: # Extend `recommended` ruleset from @typespec/best-practices library
319-
- "@typespec/best-practices:recommended"
319+
- "@typespec/best-practices/recommended"
320320

321321
enable: # Explicitly enable some rules
322-
"@typespec/best-practices:no-x": true
322+
"@typespec/best-practices/no-x": true
323323

324324
disable: # Disable some rules defined in one of the ruleset extended.
325-
"@typespec/best-practices:no-y": "This rule cannot be applied in this project because X"
325+
"@typespec/best-practices/no-y": "This rule cannot be applied in this project because X"
326326
```
327327
328328
## Emitter control cli flags

0 commit comments

Comments
 (0)