@azure-tools/typespec-azure-core 0.74.0-dev.1 → 0.74.0-dev.4
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.
- package/README.md +1 -0
- package/dist/src/linter.d.ts.map +1 -1
- package/dist/src/linter.js +2 -0
- package/dist/src/linter.js.map +1 -1
- package/dist/src/rules/no-redundant-summary.d.ts +4 -0
- package/dist/src/rules/no-redundant-summary.d.ts.map +1 -0
- package/dist/src/rules/no-redundant-summary.js +34 -0
- package/dist/src/rules/no-redundant-summary.js.map +1 -0
- package/dist/src/rules/no-unnamed-types.d.ts.map +1 -1
- package/dist/src/rules/no-unnamed-types.js +18 -7
- package/dist/src/rules/no-unnamed-types.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -52,6 +52,7 @@ Available ruleSets:
|
|
|
52
52
|
| [`@azure-tools/typespec-azure-core/no-openapi`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-openapi) | Azure specs should not be using decorators from @typespec/openapi or @azure-tools/typespec-autorest |
|
|
53
53
|
| [`@azure-tools/typespec-azure-core/no-unnamed-types`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-unnamed-types) | Azure services should not have anonymous models, union expressions, enum expressions, or scalar expressions. Define them as named declarations. |
|
|
54
54
|
| [`@azure-tools/typespec-azure-core/no-header-explode`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-header-explode) | It is recommended to serialize header parameter without explode: true |
|
|
55
|
+
| [`@azure-tools/typespec-azure-core/no-redundant-summary`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-redundant-summary) | Summary must not repeat the documentation. |
|
|
55
56
|
| [`@azure-tools/typespec-azure-core/no-format`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-format) | Azure services should not use the `@format` decorator. |
|
|
56
57
|
| [`@azure-tools/typespec-azure-core/no-multiple-discriminator`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-multiple-discriminator) | Classes should have at most one discriminator. |
|
|
57
58
|
| [`@azure-tools/typespec-azure-core/no-rest-library-interfaces`](https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-rest-library-interfaces) | Resource interfaces from the TypeSpec.Rest.Resource library are incompatible with Azure.Core. |
|
package/dist/src/linter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"linter.d.ts","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AA6FA,eAAO,MAAM,OAAO,+CASlB,CAAC"}
|
package/dist/src/linter.js
CHANGED
|
@@ -23,6 +23,7 @@ import { noOpenapiClientExtensionsRule } from "./rules/no-openapi-client-extensi
|
|
|
23
23
|
import { noOpenAPIRule } from "./rules/no-openapi.js";
|
|
24
24
|
import { noPrivateUsage } from "./rules/no-private-usage.js";
|
|
25
25
|
import { noQueryExplodeRule } from "./rules/no-query-explode.js";
|
|
26
|
+
import { noRedundantSummaryRule } from "./rules/no-redundant-summary.js";
|
|
26
27
|
import { noResponseBodyRule } from "./rules/no-response-body.js";
|
|
27
28
|
import { noRouteParameterNameMismatchRule } from "./rules/no-route-parameter-name-mismatch.js";
|
|
28
29
|
import { noRpcPathParamsRule } from "./rules/no-rpc-path-params.js";
|
|
@@ -66,6 +67,7 @@ const rules = [
|
|
|
66
67
|
noOpenAPIRule,
|
|
67
68
|
noUnnamedTypesRule,
|
|
68
69
|
noHeaderExplodeRule,
|
|
70
|
+
noRedundantSummaryRule,
|
|
69
71
|
preventFormatRule,
|
|
70
72
|
noMultipleDiscriminatorRule,
|
|
71
73
|
preventRestLibraryInterfaces,
|
package/dist/src/linter.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4CAA4C,EAAE,MAAM,kCAAkC,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAC;AACxF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,gCAAgC,EAAE,MAAM,6CAA6C,CAAC;AAC/F,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iCAAiC,EAAE,MAAM,8CAA8C,CAAC;AACjG,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,MAAM,KAAK,GAAG;IACZ,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,QAAQ;IACR,UAAU;IACV,8BAA8B;IAC9B,aAAa;IACb,iBAAiB;IACjB,4CAA4C;IAC5C,kBAAkB;IAClB,wBAAwB;IACxB,UAAU;IACV,sBAAsB;IACtB,2BAA2B;IAC3B,yBAAyB;IACzB,oBAAoB;IACpB,cAAc;IACd,oBAAoB;IACpB,kBAAkB;IAClB,mBAAmB;IACnB,aAAa;IACb,kBAAkB;IAClB,mBAAmB;IACnB,iBAAiB;IACjB,2BAA2B;IAC3B,4BAA4B;IAC5B,kBAAkB;IAClB,iBAAiB;IACjB,oBAAoB;IACpB,oBAAoB;IACpB,iCAAiC;IACjC,2BAA2B;IAC3B,4BAA4B;IAC5B,gBAAgB;IAChB,qBAAqB;IACrB,yBAAyB;IACzB,oBAAoB;IACpB,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,kBAAkB;IAClB,gCAAgC;IAChC,6BAA6B;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IAClC,KAAK;IACL,QAAQ,EAAE;QACR,sBAAsB,EAAE;YACtB,MAAM,EAAE;gBACN,CAAC,oCAAoC,yBAAyB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;aAC7E;SACF;KACF;CACF,CAAC,CAAC"}
|
|
1
|
+
{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,8BAA8B,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4CAA4C,EAAE,MAAM,kCAAkC,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC1E,OAAO,EAAE,2BAA2B,EAAE,MAAM,4CAA4C,CAAC;AACzF,OAAO,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACnF,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAC;AACxF,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,gCAAgC,EAAE,MAAM,6CAA6C,CAAC;AAC/F,OAAO,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AAC/E,OAAO,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAC1E,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,4BAA4B,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iCAAiC,EAAE,MAAM,8CAA8C,CAAC;AACjG,OAAO,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AACrF,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAE3E,MAAM,KAAK,GAAG;IACZ,cAAc;IACd,gBAAgB;IAChB,aAAa;IACb,QAAQ;IACR,UAAU;IACV,8BAA8B;IAC9B,aAAa;IACb,iBAAiB;IACjB,4CAA4C;IAC5C,kBAAkB;IAClB,wBAAwB;IACxB,UAAU;IACV,sBAAsB;IACtB,2BAA2B;IAC3B,yBAAyB;IACzB,oBAAoB;IACpB,cAAc;IACd,oBAAoB;IACpB,kBAAkB;IAClB,mBAAmB;IACnB,aAAa;IACb,kBAAkB;IAClB,mBAAmB;IACnB,sBAAsB;IACtB,iBAAiB;IACjB,2BAA2B;IAC3B,4BAA4B;IAC5B,kBAAkB;IAClB,iBAAiB;IACjB,oBAAoB;IACpB,oBAAoB;IACpB,iCAAiC;IACjC,2BAA2B;IAC3B,4BAA4B;IAC5B,gBAAgB;IAChB,qBAAqB;IACrB,yBAAyB;IACzB,oBAAoB;IACpB,gBAAgB;IAChB,cAAc;IACd,aAAa;IACb,kBAAkB;IAClB,gCAAgC;IAChC,6BAA6B;CAC9B,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IAClC,KAAK;IACL,QAAQ,EAAE;QACR,sBAAsB,EAAE;YACtB,MAAM,EAAE;gBACN,CAAC,oCAAoC,yBAAyB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;aAC7E;SACF;KACF;CACF,CAAC,CAAC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
export declare const noRedundantSummaryRule: import("@typespec/compiler").LinterRuleDefinition<"no-redundant-summary", {
|
|
2
|
+
readonly default: "The summary and documentation are identical. Add detail to the documentation or omit the redundant summary.";
|
|
3
|
+
}, Record<string, never>>;
|
|
4
|
+
//# sourceMappingURL=no-redundant-summary.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-redundant-summary.d.ts","sourceRoot":"","sources":["../../../src/rules/no-redundant-summary.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,sBAAsB;;yBAmCjC,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import { createRule, fileRef, getDoc, getSummary } from "@typespec/compiler";
|
|
2
|
+
export const noRedundantSummaryRule = createRule({
|
|
3
|
+
name: "no-redundant-summary",
|
|
4
|
+
docs: fileRef.fromPackageRoot("src/rules/no-redundant-summary.md"),
|
|
5
|
+
description: "Summary must not repeat the documentation.",
|
|
6
|
+
severity: "warning",
|
|
7
|
+
url: "https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-redundant-summary",
|
|
8
|
+
messages: {
|
|
9
|
+
default: "The summary and documentation are identical. Add detail to the documentation or omit the redundant summary.",
|
|
10
|
+
},
|
|
11
|
+
create(context) {
|
|
12
|
+
function checkSummary(target) {
|
|
13
|
+
const summary = getSummary(context.program, target);
|
|
14
|
+
const doc = getDoc(context.program, target);
|
|
15
|
+
if (!summary || !doc || summary.trim() !== doc.trim()) {
|
|
16
|
+
return;
|
|
17
|
+
}
|
|
18
|
+
context.reportDiagnostic({ target });
|
|
19
|
+
}
|
|
20
|
+
return {
|
|
21
|
+
namespace: checkSummary,
|
|
22
|
+
interface: checkSummary,
|
|
23
|
+
operation: checkSummary,
|
|
24
|
+
model: checkSummary,
|
|
25
|
+
modelProperty: checkSummary,
|
|
26
|
+
scalar: checkSummary,
|
|
27
|
+
enum: checkSummary,
|
|
28
|
+
enumMember: checkSummary,
|
|
29
|
+
union: checkSummary,
|
|
30
|
+
unionVariant: checkSummary,
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
});
|
|
34
|
+
//# sourceMappingURL=no-redundant-summary.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-redundant-summary.js","sourceRoot":"","sources":["../../../src/rules/no-redundant-summary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAa,MAAM,oBAAoB,CAAC;AAExF,MAAM,CAAC,MAAM,sBAAsB,GAAG,UAAU,CAAC;IAC/C,IAAI,EAAE,sBAAsB;IAC5B,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,mCAAmC,CAAC;IAClE,WAAW,EAAE,4CAA4C;IACzD,QAAQ,EAAE,SAAS;IACnB,GAAG,EAAE,6FAA6F;IAClG,QAAQ,EAAE;QACR,OAAO,EACL,6GAA6G;KAChH;IACD,MAAM,CAAC,OAAO;QACZ,SAAS,YAAY,CAAC,MAAY;YAChC,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YACpD,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAE5C,IAAI,CAAC,OAAO,IAAI,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;gBACtD,OAAO;YACT,CAAC;YAED,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;QACvC,CAAC;QAED,OAAO;YACL,SAAS,EAAE,YAAY;YACvB,SAAS,EAAE,YAAY;YACvB,SAAS,EAAE,YAAY;YACvB,KAAK,EAAE,YAAY;YACnB,aAAa,EAAE,YAAY;YAC3B,MAAM,EAAE,YAAY;YACpB,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,YAAY;YACxB,KAAK,EAAE,YAAY;YACnB,YAAY,EAAE,YAAY;SAC3B,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"no-unnamed-types.d.ts","sourceRoot":"","sources":["../../../src/rules/no-unnamed-types.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"no-unnamed-types.d.ts","sourceRoot":"","sources":["../../../src/rules/no-unnamed-types.ts"],"names":[],"mappings":"AAwBA,eAAO,MAAM,kBAAkB;;yBA0F7B,CAAC"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
import { createRule, isNullType, paramMessage, } from "@typespec/compiler";
|
|
1
|
+
import { createRule, fileRef, ignoreDiagnostics, isNullType, paramMessage, } from "@typespec/compiler";
|
|
2
2
|
import { SyntaxKind } from "@typespec/compiler/ast";
|
|
3
|
-
import { getHeaderFieldName, isBody, isBodyRoot, isHeader, isMetadata, isMultipartBodyProperty, isStatusCode, } from "@typespec/http";
|
|
3
|
+
import { getHeaderFieldName, getHttpOperation, isBody, isBodyRoot, isHeader, isMetadata, isMultipartBodyProperty, isStatusCode, } from "@typespec/http";
|
|
4
4
|
export const noUnnamedTypesRule = createRule({
|
|
5
5
|
name: "no-unnamed-types",
|
|
6
|
+
docs: fileRef.fromPackageRoot("src/rules/no-unnamed-types.md"),
|
|
6
7
|
description: "Azure services should not have anonymous models, union expressions, enum expressions, or scalar expressions. Define them as named declarations.",
|
|
7
8
|
severity: "warning",
|
|
8
9
|
url: "https://azure.github.io/typespec-azure/docs/libraries/azure-core/rules/no-unnamed-types",
|
|
@@ -14,7 +15,7 @@ export const noUnnamedTypesRule = createRule({
|
|
|
14
15
|
// Unions: collect all unnamed unions, then exclude specific patterns.
|
|
15
16
|
const excludedUnions = new Set();
|
|
16
17
|
const invalidUnions = new Set();
|
|
17
|
-
// Models:
|
|
18
|
+
// Models: collect anonymous property types and request bodies.
|
|
18
19
|
const invalidModels = new Set();
|
|
19
20
|
const excludedModels = new Set();
|
|
20
21
|
return {
|
|
@@ -29,10 +30,7 @@ export const noUnnamedTypesRule = createRule({
|
|
|
29
30
|
}
|
|
30
31
|
}
|
|
31
32
|
// Flag anonymous models used as property types.
|
|
32
|
-
if (type
|
|
33
|
-
type.name === "" &&
|
|
34
|
-
type.properties.size > 0 &&
|
|
35
|
-
!isHttpEnvelope(program, type) &&
|
|
33
|
+
if (needsModelName(program, type) &&
|
|
36
34
|
!isInsideTemplateArgument(type) &&
|
|
37
35
|
!isMultipartBodyProperty(program, prop)) {
|
|
38
36
|
invalidModels.add(type);
|
|
@@ -51,6 +49,13 @@ export const noUnnamedTypesRule = createRule({
|
|
|
51
49
|
if (operation.returnType.kind === "Union") {
|
|
52
50
|
excludedUnions.add(operation.returnType);
|
|
53
51
|
}
|
|
52
|
+
const { body } = ignoreDiagnostics(getHttpOperation(program, operation)).parameters;
|
|
53
|
+
if (body?.bodyKind === "single" &&
|
|
54
|
+
body.property !== undefined &&
|
|
55
|
+
needsModelName(program, body.type) &&
|
|
56
|
+
isInsideTemplateArgument(body.type)) {
|
|
57
|
+
invalidModels.add(body.type);
|
|
58
|
+
}
|
|
54
59
|
},
|
|
55
60
|
union: (union) => {
|
|
56
61
|
if (!union.name && !isOnlyNullableUnion(union)) {
|
|
@@ -72,6 +77,12 @@ export const noUnnamedTypesRule = createRule({
|
|
|
72
77
|
};
|
|
73
78
|
},
|
|
74
79
|
});
|
|
80
|
+
function needsModelName(program, type) {
|
|
81
|
+
return (type.kind === "Model" &&
|
|
82
|
+
type.name === "" &&
|
|
83
|
+
type.properties.size > 0 &&
|
|
84
|
+
!isHttpEnvelope(program, type));
|
|
85
|
+
}
|
|
75
86
|
/** Check if the type's source node is inside a template argument position */
|
|
76
87
|
function isInsideTemplateArgument(type) {
|
|
77
88
|
let node = type.node;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"no-unnamed-types.js","sourceRoot":"","sources":["../../../src/rules/no-unnamed-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,UAAU,EAGV,YAAY,
|
|
1
|
+
{"version":3,"file":"no-unnamed-types.js","sourceRoot":"","sources":["../../../src/rules/no-unnamed-types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,OAAO,EACP,iBAAiB,EACjB,UAAU,EAGV,YAAY,GAIb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,MAAM,EACN,UAAU,EACV,QAAQ,EACR,UAAU,EACV,uBAAuB,EACvB,YAAY,GACb,MAAM,gBAAgB,CAAC;AAExB,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IAC3C,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,+BAA+B,CAAC;IAC9D,WAAW,EACT,iJAAiJ;IACnJ,QAAQ,EAAE,SAAS;IACnB,GAAG,EAAE,yFAAyF;IAC9F,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,aAAa,MAAM,iCAAiC,MAAM,eAAe;KAC/F;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAEhC,sEAAsE;QACtE,MAAM,cAAc,GAAG,IAAI,GAAG,EAAS,CAAC;QACxC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAS,CAAC;QAEvC,+DAA+D;QAC/D,MAAM,aAAa,GAAG,IAAI,GAAG,EAAS,CAAC;QACvC,MAAM,cAAc,GAAG,IAAI,GAAG,EAAS,CAAC;QAExC,OAAO;YACL,aAAa,EAAE,CAAC,IAAI,EAAE,EAAE;gBACtB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;gBAEvB,uEAAuE;gBACvE,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACxC,IACE,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC;wBAC3B,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC;4BACtB,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,EACrE,CAAC;wBACD,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC3B,CAAC;gBACH,CAAC;gBAED,gDAAgD;gBAChD,IACE,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;oBAC7B,CAAC,wBAAwB,CAAC,IAAI,CAAC;oBAC/B,CAAC,uBAAuB,CAAC,OAAO,EAAE,IAAI,CAAC,EACvC,CAAC;oBACD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC1B,CAAC;gBAED,+CAA+C;gBAC/C,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC1E,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;gBACvE,CAAC;gBAED,iDAAiD;gBACjD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5E,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACzE,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,+DAA+D;gBAC/D,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC1C,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC3C,CAAC;gBAED,MAAM,EAAE,IAAI,EAAE,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;gBACpF,IACE,IAAI,EAAE,QAAQ,KAAK,QAAQ;oBAC3B,IAAI,CAAC,QAAQ,KAAK,SAAS;oBAC3B,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC;oBAClC,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,EACnC,CAAC;oBACD,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC;YACD,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC/C,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;YACD,IAAI,EAAE,GAAG,EAAE;gBACT,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;oBAClC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;oBACzE,CAAC;gBACH,CAAC;gBACD,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE,CAAC;oBAClC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;wBAC/B,OAAO,CAAC,gBAAgB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC;oBACzE,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,cAAc,CAAC,OAAgB,EAAE,IAAU;IAClD,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,OAAO;QACrB,IAAI,CAAC,IAAI,KAAK,EAAE;QAChB,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;QACxB,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED,6EAA6E;AAC7E,SAAS,wBAAwB,CAAC,IAAmD;IACnF,IAAI,IAAI,GAAmD,IAAI,CAAC,IAAI,CAAC;IACrE,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC,gBAAgB,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,cAAc,CAAC,OAAgB,EAAE,KAAY;IACpD,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;QACjD,IACE,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC;YAC7B,YAAY,CAAC,OAAO,EAAE,QAAyB,CAAC;YAChD,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;YACzB,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC;YAC7B,uBAAuB,CAAC,OAAO,EAAE,QAAQ,CAAC,EAC1C,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,iEAAiE;AACjE,SAAS,mBAAmB,CAAC,KAAY;IACvC,MAAM,eAAe,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACxF,OAAO,eAAe,CAAC,MAAM,IAAI,CAAC,CAAC;AACrC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure-tools/typespec-azure-core",
|
|
3
|
-
"version": "0.74.0-dev.
|
|
3
|
+
"version": "0.74.0-dev.4",
|
|
4
4
|
"author": "Microsoft Corporation",
|
|
5
5
|
"description": "TypeSpec Azure Core library",
|
|
6
6
|
"homepage": "https://azure.github.io/typespec-azure",
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"@typespec/rest": "^0.87.0"
|
|
53
53
|
},
|
|
54
54
|
"devDependencies": {
|
|
55
|
-
"@types/node": "^26.
|
|
55
|
+
"@types/node": "^26.6.4",
|
|
56
56
|
"@vitest/coverage-v8": "^5.0.0",
|
|
57
57
|
"@vitest/ui": "^5.0.0",
|
|
58
58
|
"rimraf": "^6.1.3",
|
|
@@ -60,9 +60,9 @@
|
|
|
60
60
|
"vitest": "^5.0.0",
|
|
61
61
|
"@typespec/compiler": "^1.17.0",
|
|
62
62
|
"@typespec/http": "^1.17.0",
|
|
63
|
-
"@typespec/rest": "^0.87.0",
|
|
64
63
|
"@typespec/openapi": "^1.17.0",
|
|
65
64
|
"@typespec/library-linter": "^0.87.0",
|
|
65
|
+
"@typespec/rest": "^0.87.0",
|
|
66
66
|
"@typespec/tspd": "^0.77.1",
|
|
67
67
|
"@typespec/versioning": "^0.87.0"
|
|
68
68
|
},
|