@azure-tools/typespec-azure-core 0.31.0-dev.2 → 0.31.0-dev.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-docs.d.ts","sourceRoot":"","sources":["../../../src/rules/require-docs.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,oBAAoB,
|
|
1
|
+
{"version":3,"file":"require-docs.d.ts","sourceRoot":"","sources":["../../../src/rules/require-docs.ts"],"names":[],"mappings":"AAWA,eAAO,MAAM,oBAAoB,mCA6E/B,CAAC"}
|
|
@@ -6,6 +6,24 @@ export const requireDocumentation = createRule({
|
|
|
6
6
|
name: "documentation-required",
|
|
7
7
|
create({ program }) {
|
|
8
8
|
return {
|
|
9
|
+
enum: (enumObj) => {
|
|
10
|
+
if (!getDoc(program, enumObj) && !isExcludedCoreType(program, enumObj)) {
|
|
11
|
+
reportDiagnostic(program, {
|
|
12
|
+
code: "documentation-required",
|
|
13
|
+
target: enumObj,
|
|
14
|
+
format: { kind: enumObj.kind, name: enumObj.name },
|
|
15
|
+
});
|
|
16
|
+
}
|
|
17
|
+
for (const member of enumObj.members.values()) {
|
|
18
|
+
if (!getDoc(program, member)) {
|
|
19
|
+
reportDiagnostic(program, {
|
|
20
|
+
code: "documentation-required",
|
|
21
|
+
target: member,
|
|
22
|
+
format: { kind: member.kind, name: member.name },
|
|
23
|
+
});
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
},
|
|
9
27
|
operation: (operation) => {
|
|
10
28
|
// Don't pay attention to operations on templated interfaces that
|
|
11
29
|
// haven't been filled in with parameters yet
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-docs.js","sourceRoot":"","sources":["../../../src/rules/require-docs.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"require-docs.js","sourceRoot":"","sources":["../../../src/rules/require-docs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,MAAM,EAAoB,MAAM,oBAAoB,CAAC;AACpE,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EACL,kBAAkB,EAClB,aAAa,EACb,yBAAyB,EACzB,6BAA6B,EAC7B,6BAA6B,GAC9B,MAAM,YAAY,CAAC;AAEpB,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC;IAC7C,IAAI,EAAE,wBAAwB;IAC9B,MAAM,CAAC,EAAE,OAAO,EAAE;QAChB,OAAO;YACL,IAAI,EAAE,CAAC,OAAa,EAAE,EAAE;gBACtB,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE;oBACtE,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,wBAAwB;wBAC9B,MAAM,EAAE,OAAO;wBACf,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE;qBACnD,CAAC,CAAC;iBACJ;gBACD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE;oBAC7C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;wBAC5B,gBAAgB,CAAC,OAAO,EAAE;4BACxB,IAAI,EAAE,wBAAwB;4BAC9B,MAAM,EAAE,MAAM;4BACd,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;yBACjD,CAAC,CAAC;qBACJ;iBACF;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAoB,EAAE,EAAE;gBAClC,iEAAiE;gBACjE,6CAA6C;gBAC7C,IACE,CAAC,6BAA6B,CAAC,SAAS,CAAC;oBACzC,CAAC,6BAA6B,CAAC,SAAS,CAAC;oBACzC,CAAC,kBAAkB,CAAC,OAAO,EAAE,SAAS,CAAC,EACvC;oBACA,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE;wBAC/B,gBAAgB,CAAC,OAAO,EAAE;4BACxB,IAAI,EAAE,wBAAwB;4BAC9B,MAAM,EAAE,SAAS;4BACjB,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE;yBACvD,CAAC,CAAC;qBACJ;oBAED,KAAK,MAAM,KAAK,IAAI,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;wBAC5D,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;4BAC3B,gBAAgB,CAAC,OAAO,EAAE;gCACxB,IAAI,EAAE,wBAAwB;gCAC9B,MAAM,EAAE,KAAK;gCACb,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE;6BAC/C,CAAC,CAAC;yBACJ;qBACF;iBACF;YACH,CAAC;YACD,KAAK,EAAE,CAAC,KAAY,EAAE,EAAE;gBACtB,+FAA+F;gBAC/F,IACE,CAAC,yBAAyB,CAAC,KAAK,CAAC;oBACjC,CAAC,aAAa,CAAC,KAAK,CAAC;oBACrB,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC;oBACnC,KAAK,CAAC,IAAI,KAAK,QAAQ,EACvB;oBACA,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE;wBAC3B,gBAAgB,CAAC,OAAO,EAAE;4BACxB,IAAI,EAAE,wBAAwB;4BAC9B,MAAM,EAAE,KAAK;4BACb,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE;yBAC/C,CAAC,CAAC;qBACJ;oBACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE;wBAC5C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;4BAC1B,gBAAgB,CAAC,OAAO,EAAE;gCACxB,IAAI,EAAE,wBAAwB;gCAC9B,MAAM,EAAE,IAAI;gCACZ,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE;6BAC7C,CAAC,CAAC;yBACJ;qBACF;iBACF;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
|
package/lib/azure-core.tsp
CHANGED
package/lib/foundations.tsp
CHANGED
|
@@ -16,9 +16,16 @@ namespace Azure.Core.Foundations;
|
|
|
16
16
|
*/
|
|
17
17
|
@lroStatus
|
|
18
18
|
enum OperationState {
|
|
19
|
+
@doc("The operation is in progress.")
|
|
19
20
|
InProgress,
|
|
21
|
+
|
|
22
|
+
@doc("The operation has completed successfully.")
|
|
20
23
|
Succeeded,
|
|
24
|
+
|
|
25
|
+
@doc("The operation has failed.")
|
|
21
26
|
Failed,
|
|
27
|
+
|
|
28
|
+
@doc("The operation has been canceled by the user.")
|
|
22
29
|
Canceled,
|
|
23
30
|
}
|
|
24
31
|
|
package/package.json
CHANGED