@microsoft/typespec-msgraph 0.0.1-Preview.21 → 0.0.1-Preview.22
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/dist/src/components/annotations.js +2 -2
- package/dist/src/components/enum-type-element.js +1 -1
- package/dist/src/components/enum-type-element.js.map +1 -1
- package/dist/src/components/property-element.d.ts.map +1 -1
- package/dist/src/components/property-element.js +1 -1
- package/dist/src/components/property-element.js.map +1 -1
- package/dist/src/decorators/ags-attribute.d.ts.map +1 -1
- package/dist/src/decorators/ags-attribute.js +2 -4
- package/dist/src/decorators/ags-attribute.js.map +1 -1
- package/dist/src/decorators/function.js +1 -1
- package/dist/src/decorators/function.js.map +1 -1
- package/dist/src/decorators/graphFlags.d.ts +11 -0
- package/dist/src/decorators/graphFlags.d.ts.map +1 -0
- package/dist/src/decorators/{flags.js → graphFlags.js} +5 -5
- package/dist/src/decorators/graphFlags.js.map +1 -0
- package/dist/src/decorators/index.d.ts +2 -1
- package/dist/src/decorators/index.d.ts.map +1 -1
- package/dist/src/decorators/index.js +2 -1
- package/dist/src/decorators/index.js.map +1 -1
- package/dist/src/decorators/passthrough-address-url-msa.d.ts +2 -1
- package/dist/src/decorators/passthrough-address-url-msa.d.ts.map +1 -1
- package/dist/src/decorators/passthrough-address-url-msa.js +2 -1
- package/dist/src/decorators/passthrough-address-url-msa.js.map +1 -1
- package/dist/src/decorators/passthrough-address-url.d.ts +2 -1
- package/dist/src/decorators/passthrough-address-url.d.ts.map +1 -1
- package/dist/src/decorators/passthrough-address-url.js +2 -1
- package/dist/src/decorators/passthrough-address-url.js.map +1 -1
- package/dist/src/decorators/prefixed-graph-routes.d.ts +10 -0
- package/dist/src/decorators/prefixed-graph-routes.d.ts.map +1 -0
- package/dist/src/decorators/prefixed-graph-routes.js +27 -0
- package/dist/src/decorators/prefixed-graph-routes.js.map +1 -0
- package/dist/src/emitter.d.ts.map +1 -1
- package/dist/src/emitter.js +9 -6
- package/dist/src/emitter.js.map +1 -1
- package/dist/src/entities/address-url.js +2 -2
- package/dist/src/entities/address-url.js.map +1 -1
- package/dist/src/entities/annotations.d.ts +2 -2
- package/dist/src/entities/annotations.d.ts.map +1 -1
- package/dist/src/entities/annotations.js +10 -10
- package/dist/src/entities/annotations.js.map +1 -1
- package/dist/src/entities/enum.d.ts +1 -1
- package/dist/src/entities/enum.d.ts.map +1 -1
- package/dist/src/entities/enum.js +5 -3
- package/dist/src/entities/enum.js.map +1 -1
- package/dist/src/entities/model.d.ts +19 -12
- package/dist/src/entities/model.d.ts.map +1 -1
- package/dist/src/entities/model.js +65 -6
- package/dist/src/entities/model.js.map +1 -1
- package/dist/src/entities/ms-graph-route.js +6 -6
- package/dist/src/entities/ms-graph-route.js.map +1 -1
- package/dist/src/entities/namespace.d.ts +1 -0
- package/dist/src/entities/namespace.d.ts.map +1 -1
- package/dist/src/entities/namespace.js +31 -5
- package/dist/src/entities/namespace.js.map +1 -1
- package/dist/src/index.d.ts +1 -0
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +1 -0
- package/dist/src/index.js.map +1 -1
- package/dist/src/lib.d.ts +7 -0
- package/dist/src/lib.d.ts.map +1 -1
- package/dist/src/lib.js +7 -1
- package/dist/src/lib.js.map +1 -1
- package/dist/src/linter.d.ts.map +1 -1
- package/dist/src/linter.js +7 -2
- package/dist/src/linter.js.map +1 -1
- package/dist/src/rules/address-url.d.ts +1 -0
- package/dist/src/rules/address-url.d.ts.map +1 -1
- package/dist/src/rules/address-url.js +85 -3
- package/dist/src/rules/address-url.js.map +1 -1
- package/dist/src/rules/documentation.d.ts +4 -0
- package/dist/src/rules/documentation.d.ts.map +1 -0
- package/dist/src/rules/documentation.js +88 -0
- package/dist/src/rules/documentation.js.map +1 -0
- package/dist/src/rules/entity.d.ts +3 -0
- package/dist/src/rules/entity.d.ts.map +1 -1
- package/dist/src/rules/entity.js +32 -5
- package/dist/src/rules/entity.js.map +1 -1
- package/dist/src/rules/enum.d.ts +2 -0
- package/dist/src/rules/enum.d.ts.map +1 -1
- package/dist/src/rules/enum.js +27 -1
- package/dist/src/rules/enum.js.map +1 -1
- package/dist/src/rules/expand.js +3 -3
- package/dist/src/rules/expand.js.map +1 -1
- package/dist/src/rules/index.d.ts +1 -0
- package/dist/src/rules/index.d.ts.map +1 -1
- package/dist/src/rules/index.js +1 -0
- package/dist/src/rules/index.js.map +1 -1
- package/dist/src/rules/model.d.ts +5 -0
- package/dist/src/rules/model.d.ts.map +1 -1
- package/dist/src/rules/model.js +73 -3
- package/dist/src/rules/model.js.map +1 -1
- package/dist/src/rules/operation-inside-interface.d.ts.map +1 -1
- package/dist/src/rules/operation-inside-interface.js +3 -3
- package/dist/src/rules/operation-inside-interface.js.map +1 -1
- package/dist/src/rules/order-by.js +3 -3
- package/dist/src/rules/order-by.js.map +1 -1
- package/dist/src/rules/ownerless.d.ts.map +1 -1
- package/dist/src/rules/ownerless.js +3 -6
- package/dist/src/rules/ownerless.js.map +1 -1
- package/dist/src/rules/required-for-create.d.ts.map +1 -1
- package/dist/src/rules/required-for-create.js +4 -5
- package/dist/src/rules/required-for-create.js.map +1 -1
- package/dist/src/utils.d.ts +2 -2
- package/dist/src/utils.d.ts.map +1 -1
- package/dist/src/utils.js +66 -128
- package/dist/src/utils.js.map +1 -1
- package/dist/src/validate.d.ts.map +1 -1
- package/dist/src/validate.js +3 -0
- package/dist/src/validate.js.map +1 -1
- package/lib/decorators.tsp +23 -11
- package/package.json +4 -4
- package/dist/src/decorators/flags.d.ts +0 -11
- package/dist/src/decorators/flags.d.ts.map +0 -1
- package/dist/src/decorators/flags.js.map +0 -1
package/dist/src/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC"}
|
package/dist/src/lib.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ export declare const namespace = "MsGraph";
|
|
|
2
2
|
export interface MsGraphEmitterOptions {
|
|
3
3
|
filename?: string;
|
|
4
4
|
}
|
|
5
|
+
export declare const $flags: import("@typespec/compiler").PackageFlags;
|
|
5
6
|
export declare const reportDiagnostic: <C extends "decorator-missing-dependencies" | "element-missing-dependencies" | "decorator-invalid-use" | "singleton-invalid-name" | "extends-invalid-use" | "type-invalid-use", M extends keyof {
|
|
6
7
|
"decorator-missing-dependencies": {
|
|
7
8
|
readonly default: import("@typespec/compiler").CallableMessage<[string, string, string]>;
|
|
@@ -66,6 +67,8 @@ export declare const reportDiagnostic: <C extends "decorator-missing-dependencie
|
|
|
66
67
|
readonly navigationPropertyShouldBeTargettedWithOneInterface: import("@typespec/compiler").CallableMessage<[string]>;
|
|
67
68
|
readonly graphRouteMustMatchModelStructure: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
68
69
|
readonly overloadedFunctionReturnTypesMustBeSame: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
70
|
+
readonly enumMemberUnknownFutureValueCannotHaveDocString: import("@typespec/compiler").CallableMessage<[string]>;
|
|
71
|
+
readonly addressUrlsAreNotEqual: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
69
72
|
};
|
|
70
73
|
"singleton-invalid-name": {
|
|
71
74
|
readonly default: import("@typespec/compiler").CallableMessage<[string]>;
|
|
@@ -80,6 +83,7 @@ export declare const reportDiagnostic: <C extends "decorator-missing-dependencie
|
|
|
80
83
|
readonly recordTypeCannotBeNull: import("@typespec/compiler").CallableMessage<[string]>;
|
|
81
84
|
readonly recordTypeCannotBeUsedInLine: import("@typespec/compiler").CallableMessage<[string]>;
|
|
82
85
|
readonly interfaceWithPartialBindingType: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
86
|
+
readonly propertyTypeCannotBeStringLiteral: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
83
87
|
};
|
|
84
88
|
}[C]>(program: import("@typespec/compiler").Program, diag: import("@typespec/compiler").DiagnosticReport<{
|
|
85
89
|
"decorator-missing-dependencies": {
|
|
@@ -145,6 +149,8 @@ export declare const reportDiagnostic: <C extends "decorator-missing-dependencie
|
|
|
145
149
|
readonly navigationPropertyShouldBeTargettedWithOneInterface: import("@typespec/compiler").CallableMessage<[string]>;
|
|
146
150
|
readonly graphRouteMustMatchModelStructure: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
147
151
|
readonly overloadedFunctionReturnTypesMustBeSame: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
152
|
+
readonly enumMemberUnknownFutureValueCannotHaveDocString: import("@typespec/compiler").CallableMessage<[string]>;
|
|
153
|
+
readonly addressUrlsAreNotEqual: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
148
154
|
};
|
|
149
155
|
"singleton-invalid-name": {
|
|
150
156
|
readonly default: import("@typespec/compiler").CallableMessage<[string]>;
|
|
@@ -159,6 +165,7 @@ export declare const reportDiagnostic: <C extends "decorator-missing-dependencie
|
|
|
159
165
|
readonly recordTypeCannotBeNull: import("@typespec/compiler").CallableMessage<[string]>;
|
|
160
166
|
readonly recordTypeCannotBeUsedInLine: import("@typespec/compiler").CallableMessage<[string]>;
|
|
161
167
|
readonly interfaceWithPartialBindingType: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
168
|
+
readonly propertyTypeCannotBeStringLiteral: import("@typespec/compiler").CallableMessage<[string, string]>;
|
|
162
169
|
};
|
|
163
170
|
}, C, M>) => void;
|
|
164
171
|
//# sourceMappingURL=lib.d.ts.map
|
package/dist/src/lib.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,YAAY,CAAC;AAEnC,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAeD,eAAO,MAAQ,gBAAgB
|
|
1
|
+
{"version":3,"file":"lib.d.ts","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,SAAS,YAAY,CAAC;AAEnC,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAeD,eAAO,MAAM,MAAM,2CAEjB,CAAC;AAEH,eAAO,MAAQ,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwGpB,CAAC"}
|
package/dist/src/lib.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
|
|
1
|
+
import { createTypeSpecLibrary, definePackageFlags, paramMessage } from "@typespec/compiler";
|
|
2
2
|
export const namespace = "MsGraph";
|
|
3
3
|
const EmitterOptionsSchema = {
|
|
4
4
|
type: "object",
|
|
@@ -12,6 +12,9 @@ const EmitterOptionsSchema = {
|
|
|
12
12
|
},
|
|
13
13
|
required: [],
|
|
14
14
|
};
|
|
15
|
+
export const $flags = definePackageFlags({
|
|
16
|
+
decoratorArgMarshalling: "new",
|
|
17
|
+
});
|
|
15
18
|
export const { reportDiagnostic } = createTypeSpecLibrary({
|
|
16
19
|
name: "@microsoft/typespec-msgraph",
|
|
17
20
|
diagnostics: {
|
|
@@ -86,6 +89,8 @@ export const { reportDiagnostic } = createTypeSpecLibrary({
|
|
|
86
89
|
navigationPropertyShouldBeTargettedWithOneInterface: paramMessage `The navigation properties "${"models"}" should not be targetted by more than one interface with @delta. Please choose one interface for each navigation property.`,
|
|
87
90
|
graphRouteMustMatchModelStructure: paramMessage `The @graphRoute "${"graphRoute"}" must match a navigation path in the model "${"model"}".`,
|
|
88
91
|
overloadedFunctionReturnTypesMustBeSame: paramMessage `The return types "${"returnTypes"}" of the overloaded function "${"operation"}" must be identical.`,
|
|
92
|
+
enumMemberUnknownFutureValueCannotHaveDocString: paramMessage `Description is not allowed on "${"member"}" because it will be auto-generated.`,
|
|
93
|
+
addressUrlsAreNotEqual: paramMessage `The decorator values (string and booleans) of "${"decorator"}" applied to multiple interfaces that point to the same navigation property "${"target"}" must be identical.`,
|
|
89
94
|
},
|
|
90
95
|
},
|
|
91
96
|
"singleton-invalid-name": {
|
|
@@ -109,6 +114,7 @@ export const { reportDiagnostic } = createTypeSpecLibrary({
|
|
|
109
114
|
recordTypeCannotBeNull: paramMessage `The record type "${"type"}" cannot be null.`,
|
|
110
115
|
recordTypeCannotBeUsedInLine: paramMessage `Using inline record as type on ${"type"} is not supported. Create a complex entity to represent it.`,
|
|
111
116
|
interfaceWithPartialBindingType: paramMessage `The interface "${"interface"}" targets a partial or non-owned type "${"type"}" and as such cannot declare operations.`,
|
|
117
|
+
propertyTypeCannotBeStringLiteral: paramMessage `The type for "${"property"}" cannot be a ${"type"} literal.`
|
|
112
118
|
}
|
|
113
119
|
}
|
|
114
120
|
},
|
package/dist/src/lib.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,qBAAqB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../src/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,qBAAqB,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAE7G,MAAM,CAAC,MAAM,SAAS,GAAG,SAAS,CAAC;AAMnC,MAAM,oBAAoB,GAA0C;IAClE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,wFAAwF;SACtG;KACF;IACD,QAAQ,EAAE,EAAE;CACb,CAAA;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC;IACvC,uBAAuB,EAAE,KAAK;CAC/B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,qBAAqB,CAAC;IACxD,IAAI,EAAE,6BAA6B;IACnC,WAAW,EAAE;QACX,gCAAgC,EAAE;YAChC,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,OAAO,WAAW,sDAAsD,UAAU,qBAAqB,UAAU,GAAG;gBACzI,QAAQ,EAAE,YAAY,CAAA,oFAAoF;aAC3G;SACF;QACD,8BAA8B,EAAE;YAC9B,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,OAAO,SAAS,+BAA+B,OAAO,SAAS,UAAU,GAAG;gBACjG,SAAS,EAAE,YAAY,CAAA,4CAA4C;gBACnE,yCAAyC,EAAE,6DAA6D;gBACxG,yBAAyB,EAAE,YAAY,CAAA,iBAAiB,UAAU,SAAS,OAAO,6FAA6F;gBAC/K,qBAAqB,EAAE,YAAY,CAAA,cAAc,OAAO,mCAAmC;gBAC3F,0BAA0B,EAAE,YAAY,CAAA,kBAAkB,WAAW,kCAAkC,YAAY,qEAAqE;gBACxL,uCAAuC,EAAE,YAAY,CAAA,wDAAwD,WAAW,IAAI;gBAC5H,mCAAmC,EAAE,YAAY,CAAA,iBAAiB,UAAU,cAAc,QAAQ,0DAA0D;aAC7J;SACF;QACD,uBAAuB,EAAE;YACvB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,OAAO,WAAW,2CAA2C,OAAO,SAAS,UAAU,GAAG;gBAC/G,YAAY,EAAE,YAAY,CAAA,8FAA8F;gBACxH,4BAA4B,EAAE,YAAY,CAAA,iBAAiB,WAAW,uCAAuC;gBAC7G,gBAAgB,EAAE,YAAY,CAAA,mBAAmB,YAAY,6GAA6G,OAAO,iCAAiC;gBAClN,gBAAgB,EAAE,YAAY,CAAA,mBAAmB,YAAY,+EAA+E,OAAO,iCAAiC;gBACpL,iCAAiC,EAAE,YAAY,CAAA,mGAAmG;gBAClJ,GAAG,EAAE,YAAY,CAAA,2EAA2E;gBAC5F,iBAAiB,EAAE,YAAY,CAAA,mBAAmB,YAAY,kHAAkH,OAAO,iCAAiC;gBACxN,QAAQ,EAAE,YAAY,CAAA,OAAO,WAAW,mCAAmC,YAAY,GAAG;gBAC1F,SAAS,EAAE,YAAY,CAAA,OAAO,WAAW,uCAAuC,QAAQ,GAAG;gBAC3F,UAAU,EAAE,YAAY,CAAA,4CAA4C;gBACpE,aAAa,EAAE,YAAY,CAAA,+CAA+C;gBAC1E,4BAA4B,EAAE,YAAY,CAAA,mEAAmE;gBAC7G,wBAAwB,EAAE,YAAY,CAAA,wEAAwE;gBAC9G,0BAA0B,EAAE,YAAY,CAAA,sDAAsD,WAAW,wCAAwC;gBACjJ,4BAA4B,EAAE,YAAY,CAAA,wDAAwD,WAAW,4CAA4C;gBACzJ,OAAO,EAAE,YAAY,CAAA,qHAAqH;gBAC1I,4CAA4C,EAAE,YAAY,CAAA,+FAA+F;gBACzJ,uDAAuD,EAAE,YAAY,CAAA,qGAAqG;gBAC1K,iEAAiE,EAAE,YAAY,CAAA,+FAA+F;gBAC9K,oDAAoD,EAAE,YAAY,CAAA,kEAAkE;gBACpI,oDAAoD,EAAE,YAAY,CAAA,kEAAkE;gBACpI,yCAAyC,EAAE,YAAY,CAAA,oFAAoF;gBAC3I,yCAAyC,EAAE,YAAY,CAAA,yFAAyF;gBAChJ,qCAAqC,EAAE,YAAY,CAAA,2EAA2E;gBAC9H,oDAAoD,EAAE,YAAY,CAAA,2GAA2G;gBAC7K,+CAA+C,EAAE,YAAY,CAAA,0FAA0F;gBACvJ,+CAA+C,EAAE,YAAY,CAAA,2GAA2G;gBACxK,4CAA4C,EAAE,YAAY,CAAA,mBAAmB,YAAY,2FAA2F;gBACpL,0CAA0C,EAAE,YAAY,CAAA,2FAA2F;gBACnJ,4CAA4C,EAAE,YAAY,CAAA,uEAAuE;gBACjI,0CAA0C,EAAE,YAAY,CAAA,8BAA8B,QAAQ,8BAA8B;gBAC5H,2DAA2D,EAAE,YAAY,CAAA,uJAAuJ;gBAChO,6BAA6B,EAAE,YAAY,CAAA,oBAAoB,YAAY,SAAS,QAAQ,8CAA8C,UAAU,IAAI;gBACxJ,4CAA4C,EAAE,YAAY,CAAA,mBAAmB,YAAY,yBAAyB,YAAY,2BAA2B;gBACzJ,mCAAmC,EAAE,YAAY,CAAA,uCAAuC;gBACxF,4CAA4C,EAAE,YAAY,CAAA,sFAAsF;gBAChJ,0CAA0C,EAAE,YAAY,CAAA,8EAA8E;gBACtI,+BAA+B,EAAE,YAAY,CAAA,kEAAkE;gBAC/G,6DAA6D,EAAE,YAAY,CAAA,0FAA0F;gBACrK,oDAAoD,EAAE,YAAY,CAAA,iEAAiE;gBACnI,mDAAmD,EAAE,YAAY,CAAA,2EAA2E;gBAC5I,8CAA8C,EAAE,YAAY,CAAA,qBAAqB,aAAa,4CAA4C;gBAC1I,oCAAoC,EAAE,YAAY,CAAA,8FAA8F,OAAO,UAAU;gBACjK,8BAA8B,EAAE,YAAY,CAAA,iBAAiB,UAAU,8EAA8E,OAAO,IAAI;gBAChK,mDAAmD,EAAE,YAAY,CAAA,8BAA8B,QAAQ,6HAA6H;gBACpO,iCAAiC,EAAE,YAAY,CAAA,oBAAoB,YAAY,gDAAgD,OAAO,IAAI;gBAC1I,uCAAuC,EAAE,YAAY,CAAA,qBAAqB,aAAa,iCAAiC,WAAW,sBAAsB;gBACzJ,+CAA+C,EAAE,YAAY,CAAA,kCAAkC,QAAQ,sCAAsC;gBAC7I,sBAAsB,EAAE,YAAY,CAAA,kDAAkD,WAAW,gFAAgF,QAAQ,sBAAsB;aAChN;SACF;QACD,wBAAwB,EAAE;YACxB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,wCAAwC,OAAO,uEAAuE;aAC5I;SACF;QACD,qBAAqB,EAAE;YACrB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,KAAK,MAAM,4BAA4B,MAAM,YAAY;gBAC9E,UAAU,EAAE,8FAA8F;aAC3G;SACF;QACD,kBAAkB,EAAE;YAClB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,OAAO,MAAM,yDAAyD;gBAC3F,8BAA8B,EAAE,YAAY,CAAA,oBAAoB,MAAM,2BAA2B;gBACjG,sBAAsB,EAAE,YAAY,CAAA,oBAAoB,MAAM,mBAAmB;gBACjF,4BAA4B,EAAE,YAAY,CAAA,kCAAkC,MAAM,6DAA6D;gBAC/I,+BAA+B,EAAE,YAAY,CAAA,kBAAkB,WAAW,0CAA0C,MAAM,0CAA0C;gBACpK,iCAAiC,EAAE,YAAY,CAAA,iBAAiB,UAAU,iBAAiB,MAAM,WAAW;aAC7G;SACF;KACF;IACD,OAAO,EAAE,EAAE,OAAO,EAAE,oBAA6D,EAAE;CAC3E,CAAC,CAAC"}
|
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":"AASA,eAAO,MAAM,OAAO,+CAyBlB,CAAA"}
|
package/dist/src/linter.js
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import { defineLinter } from "@typespec/compiler";
|
|
2
|
-
import { modelShouldBeEntityOrComplexType, singletonOrEntitySetHostingBindingsShouldExist, useEvolvableEnumRule, mediaTypeValuesShouldBeMinimallyFormattedForMIMETypes, interfaceNavigationSourceShouldHaveMediaIf$ValueIsSpecified, getPutPostAndPatchOperationsShouldHaveSelectDecorator, useRecordTypeInsteadOfDictionary, dictionaryTypeIsMostlyUsedWithRecordType } from "./rules/index.js";
|
|
2
|
+
import { modelShouldBeEntityOrComplexType, singletonOrEntitySetHostingBindingsShouldExist, useEvolvableEnumRule, mediaTypeValuesShouldBeMinimallyFormattedForMIMETypes, interfaceNavigationSourceShouldHaveMediaIf$ValueIsSpecified, getPutPostAndPatchOperationsShouldHaveSelectDecorator, useRecordTypeInsteadOfDictionary, dictionaryTypeIsMostlyUsedWithRecordType, containedNavigationPropertyTypeShouldNotBeExternallyReferenced, entityAndComplexPropertyNameShouldNotBeName, validateCoreElementsHaveDocString } from "./rules/index.js";
|
|
3
3
|
export const $linter = defineLinter({
|
|
4
4
|
rules: [useEvolvableEnumRule, singletonOrEntitySetHostingBindingsShouldExist,
|
|
5
5
|
modelShouldBeEntityOrComplexType, mediaTypeValuesShouldBeMinimallyFormattedForMIMETypes,
|
|
6
6
|
interfaceNavigationSourceShouldHaveMediaIf$ValueIsSpecified, getPutPostAndPatchOperationsShouldHaveSelectDecorator,
|
|
7
|
-
useRecordTypeInsteadOfDictionary, dictionaryTypeIsMostlyUsedWithRecordType
|
|
7
|
+
useRecordTypeInsteadOfDictionary, dictionaryTypeIsMostlyUsedWithRecordType,
|
|
8
|
+
containedNavigationPropertyTypeShouldNotBeExternallyReferenced, entityAndComplexPropertyNameShouldNotBeName,
|
|
9
|
+
validateCoreElementsHaveDocString
|
|
8
10
|
],
|
|
9
11
|
ruleSets: {
|
|
10
12
|
recommended: {
|
|
@@ -17,6 +19,9 @@ export const $linter = defineLinter({
|
|
|
17
19
|
[`@microsoft/typespec-msgraph/${getPutPostAndPatchOperationsShouldHaveSelectDecorator.name}`]: true,
|
|
18
20
|
[`@microsoft/typespec-msgraph/${useRecordTypeInsteadOfDictionary.name}`]: true,
|
|
19
21
|
[`@microsoft/typespec-msgraph/${dictionaryTypeIsMostlyUsedWithRecordType.name}`]: true,
|
|
22
|
+
[`@microsoft/typespec-msgraph/${containedNavigationPropertyTypeShouldNotBeExternallyReferenced.name}`]: true,
|
|
23
|
+
[`@microsoft/typespec-msgraph/${entityAndComplexPropertyNameShouldNotBeName.name}`]: true,
|
|
24
|
+
[`@microsoft/typespec-msgraph/${validateCoreElementsHaveDocString.name}`]: true,
|
|
20
25
|
},
|
|
21
26
|
},
|
|
22
27
|
}
|
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,gCAAgC,EAAE,8CAA8C,EACvF,oBAAoB,EAAE,qDAAqD,EAC3E,2DAA2D,EAAE,qDAAqD,EAClH,gCAAgC,EAAE,wCAAwC,EAC1E,MAAM,kBAAkB,CAAC;AAE3B,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IAClC,KAAK,EAAE,CAAC,oBAAoB,EAAE,8CAA8C;QAC1E,gCAAgC,EAAE,qDAAqD;QACvF,2DAA2D,EAAE,qDAAqD;QAClH,gCAAgC,EAAE,wCAAwC;
|
|
1
|
+
{"version":3,"file":"linter.js","sourceRoot":"","sources":["../../src/linter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gCAAgC,EAAE,8CAA8C,EACvF,oBAAoB,EAAE,qDAAqD,EAC3E,2DAA2D,EAAE,qDAAqD,EAClH,gCAAgC,EAAE,wCAAwC,EAC1E,8DAA8D,EAAE,2CAA2C,EAC3G,iCAAiC,EACjC,MAAM,kBAAkB,CAAC;AAE3B,MAAM,CAAC,MAAM,OAAO,GAAG,YAAY,CAAC;IAClC,KAAK,EAAE,CAAC,oBAAoB,EAAE,8CAA8C;QAC1E,gCAAgC,EAAE,qDAAqD;QACvF,2DAA2D,EAAE,qDAAqD;QAClH,gCAAgC,EAAE,wCAAwC;QAC1E,8DAA8D,EAAE,2CAA2C;QAC3G,iCAAiC;KAClC;IACD,QAAQ,EAAE;QACR,WAAW,EAAE;YACX,MAAM,EAAE;gBACN,CAAC,+BAA+B,oBAAoB,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBAClE,CAAC,+BAA+B,8CAA8C,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBAC5F,CAAC,+BAA+B,gCAAgC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBAC9E,CAAC,+BAA+B,qDAAqD,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBACnG,CAAC,+BAA+B,2DAA2D,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBACzG,CAAC,+BAA+B,qDAAqD,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBACnG,CAAC,+BAA+B,gCAAgC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBAC9E,CAAC,+BAA+B,wCAAwC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBACtF,CAAC,+BAA+B,8DAA8D,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBAC5G,CAAC,+BAA+B,2CAA2C,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;gBACzF,CAAC,+BAA+B,iCAAiC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI;aAChF;SACF;KACF;CACF,CAAC,CAAA"}
|
|
@@ -16,4 +16,5 @@ export declare function validatePassthroughAddressUrlOnlyAppliesToRoutedInterfac
|
|
|
16
16
|
*/
|
|
17
17
|
export declare function validatePassthroughAddressUrlMsaOnlyAppliesToRoutedInterfacesOrActionOperations(program: Program): void;
|
|
18
18
|
export declare function validatePassthroughAddressUrlDecoratorIsUsedTogetherWithAddressUrlDecorator(program: Program): void;
|
|
19
|
+
export declare function validateAddressUrlTargetingSameNavigationPropertyMustBeSimilar(program: Program): void;
|
|
19
20
|
//# sourceMappingURL=address-url.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"address-url.d.ts","sourceRoot":"","sources":["../../../src/rules/address-url.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"address-url.d.ts","sourceRoot":"","sources":["../../../src/rules/address-url.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,OAAO,EAAkD,MAAM,oBAAoB,CAAC;AAM7F;;GAEG;AACH,wBAAgB,iEAAiE,CAC/E,OAAO,EAAE,OAAO,QAgBjB;AAED;;GAEG;AACH,wBAAgB,oEAAoE,CAClF,OAAO,EAAE,OAAO,QAgBjB;AAED;;GAEG;AACH,wBAAgB,4EAA4E,CAC1F,OAAO,EAAE,OAAO,QAgBjB;AAED;;GAEG;AACH,wBAAgB,+EAA+E,CAC7F,OAAO,EAAE,OAAO,QAgBjB;AAED,wBAAgB,2EAA2E,CACzF,OAAO,EAAE,OAAO,QAqEjB;AAoCD,wBAAgB,8DAA8D,CAAC,OAAO,EAAE,OAAO,QAa9F"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { hasAddressUrl, hasAddressUrlMsa, hasGraphRoute, hasPassthroughAddressUrl, isAction, } from "../index.js";
|
|
1
|
+
import { getAddressUrl, getAddressUrlMsa, getGraphRoutePaths, getPassthroughAddressUrl, hasAddressUrl, hasAddressUrlMsa, hasGraphRoute, hasPassthroughAddressUrl, isAction, } from "../index.js";
|
|
2
2
|
import { reportDiagnostic } from "../lib.js";
|
|
3
3
|
import { navigateTypesInNamespace } from "@typespec/compiler";
|
|
4
4
|
import { GetDeclaredNamespaces } from "../entities/namespace.js";
|
|
5
|
-
import { hasPassthroughAddressUrlMsa } from "../decorators/passthrough-address-url-msa.js";
|
|
6
|
-
import { getIdForType } from "../utils.js";
|
|
5
|
+
import { getPassthroughAddressUrlMsa, hasPassthroughAddressUrlMsa } from "../decorators/passthrough-address-url-msa.js";
|
|
6
|
+
import { getIdForType, isEqual } from "../utils.js";
|
|
7
7
|
/**
|
|
8
8
|
* @addressUrl only applies to either routed interfaces (entity sets, singletons and navigation properties) or action operations.
|
|
9
9
|
*/
|
|
@@ -158,4 +158,86 @@ function validateAddressUrlApplication(program, target, decorator) {
|
|
|
158
158
|
},
|
|
159
159
|
});
|
|
160
160
|
}
|
|
161
|
+
export function validateAddressUrlTargetingSameNavigationPropertyMustBeSimilar(program) {
|
|
162
|
+
for (const namespace of GetDeclaredNamespaces(program)) {
|
|
163
|
+
const interfaces = namespace.interfaces;
|
|
164
|
+
const addressUrlGroup = filterInterfaces(program, interfaces, hasAddressUrl);
|
|
165
|
+
const addressUrlMsaGroup = filterInterfaces(program, interfaces, hasAddressUrlMsa);
|
|
166
|
+
const passthroughAddressUrlGroup = filterInterfaces(program, interfaces, hasPassthroughAddressUrl);
|
|
167
|
+
const passthroughAddressUrlMsaGroup = filterInterfaces(program, interfaces, hasPassthroughAddressUrlMsa);
|
|
168
|
+
validateAddressUrlParameters(program, addressUrlGroup, '@addressUrl', getAddressUrl);
|
|
169
|
+
validateAddressUrlParameters(program, addressUrlMsaGroup, '@addressUrlMsa', getAddressUrlMsa);
|
|
170
|
+
validateAddressUrlParameters(program, passthroughAddressUrlGroup, '@passthroughAddressUrl', getPassthroughAddressUrl);
|
|
171
|
+
validateAddressUrlParameters(program, passthroughAddressUrlMsaGroup, '@passthroughAddressUrlMsa', getPassthroughAddressUrlMsa);
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
function validateAddressUrlParameters(program, interfaces, target, getParameter) {
|
|
175
|
+
const interfacesWithSameSource = getInterfacesWithSameNavSource(program, interfaces);
|
|
176
|
+
for (const [_, group] of interfacesWithSameSource) {
|
|
177
|
+
const interfaces = group.interfaces;
|
|
178
|
+
const addressUrls = [];
|
|
179
|
+
for (const theInterface of interfaces) {
|
|
180
|
+
const addressUrl = getParameter(program, theInterface);
|
|
181
|
+
if (!addressUrl) {
|
|
182
|
+
continue;
|
|
183
|
+
}
|
|
184
|
+
addressUrls.push(addressUrl);
|
|
185
|
+
}
|
|
186
|
+
if (addressUrls.length > 1 && !addressUrlParametersAreEqual(addressUrls)) {
|
|
187
|
+
interfaces.forEach(theInterface => {
|
|
188
|
+
reportInvalidUseDiagnostic(program, theInterface, target, group.navigationPropertyName);
|
|
189
|
+
});
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
function getInterfacesWithSameNavSource(program, interfaces) {
|
|
194
|
+
let interfacesWithSameSource = new Map();
|
|
195
|
+
for (const [_, theInterface] of interfaces) {
|
|
196
|
+
const graphRoutes = getGraphRoutePaths(program, theInterface);
|
|
197
|
+
graphRoutes === null || graphRoutes === void 0 ? void 0 : graphRoutes.forEach(route => {
|
|
198
|
+
var _a;
|
|
199
|
+
const lastSegment = route.split("/").pop();
|
|
200
|
+
if (lastSegment) {
|
|
201
|
+
if (interfacesWithSameSource.has(lastSegment)) {
|
|
202
|
+
(_a = interfacesWithSameSource.get(lastSegment)) === null || _a === void 0 ? void 0 : _a.interfaces.push(theInterface);
|
|
203
|
+
}
|
|
204
|
+
else {
|
|
205
|
+
interfacesWithSameSource.set(lastSegment, { navigationPropertyName: lastSegment, interfaces: [theInterface] });
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
});
|
|
209
|
+
}
|
|
210
|
+
return interfacesWithSameSource;
|
|
211
|
+
}
|
|
212
|
+
function filterInterfaces(program, interfaces, filter) {
|
|
213
|
+
let group = new Map();
|
|
214
|
+
for (const [_, theInterface] of interfaces) {
|
|
215
|
+
if (filter(program, theInterface)) {
|
|
216
|
+
let key = theInterface.name;
|
|
217
|
+
if (!group.has(key)) {
|
|
218
|
+
group.set(key, theInterface);
|
|
219
|
+
}
|
|
220
|
+
}
|
|
221
|
+
}
|
|
222
|
+
return group;
|
|
223
|
+
}
|
|
224
|
+
function reportInvalidUseDiagnostic(program, theInterface, decorator, navigationProperty) {
|
|
225
|
+
reportDiagnostic(program, {
|
|
226
|
+
code: "decorator-invalid-use",
|
|
227
|
+
target: theInterface,
|
|
228
|
+
messageId: "addressUrlsAreNotEqual",
|
|
229
|
+
format: {
|
|
230
|
+
decorator: decorator,
|
|
231
|
+
target: navigationProperty,
|
|
232
|
+
},
|
|
233
|
+
});
|
|
234
|
+
}
|
|
235
|
+
function addressUrlParametersAreEqual(addressUrlParameterItems) {
|
|
236
|
+
for (let i = 1; i < addressUrlParameterItems.length; i++) {
|
|
237
|
+
if (isEqual(addressUrlParameterItems[0], addressUrlParameterItems[i])) {
|
|
238
|
+
return true;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
241
|
+
return false;
|
|
242
|
+
}
|
|
161
243
|
//# sourceMappingURL=address-url.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"address-url.js","sourceRoot":"","sources":["../../../src/rules/address-url.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"address-url.js","sourceRoot":"","sources":["../../../src/rules/address-url.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EACb,gBAAgB,EAChB,kBAAkB,EAElB,wBAAwB,EACxB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,wBAAwB,EACxB,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAiC,wBAAwB,EAAE,MAAM,oBAAoB,CAAC;AAC7F,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,MAAM,8CAA8C,CAAC;AACxH,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAGpD;;GAEG;AACH,MAAM,UAAU,iEAAiE,CAC/E,OAAgB;IAEhB,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,IAAI,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;oBACzC,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,CAAC,CAAC;gBACtE,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;oBACtC,6BAA6B,CAAC,OAAO,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;gBACnE,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oEAAoE,CAClF,OAAgB;IAEhB,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,IAAI,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;oBAC5C,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;gBACzE,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;oBACzC,6BAA6B,CAAC,OAAO,EAAE,SAAS,EAAE,gBAAgB,CAAC,CAAC;gBACtE,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4EAA4E,CAC1F,OAAgB;IAEhB,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,IAAI,wBAAwB,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;oBACpD,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,wBAAwB,CAAC,CAAC;gBACjF,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,wBAAwB,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;oBACjD,6BAA6B,CAAC,OAAO,EAAE,SAAS,EAAE,wBAAwB,CAAC,CAAC;gBAC9E,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,+EAA+E,CAC7F,OAAgB;IAEhB,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,IAAI,2BAA2B,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;oBACvD,6BAA6B,CAAC,OAAO,EAAE,YAAY,EAAE,2BAA2B,CAAC,CAAC;gBACpF,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,2BAA2B,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;oBACpD,6BAA6B,CAAC,OAAO,EAAE,SAAS,EAAE,2BAA2B,CAAC,CAAC;gBACjF,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,MAAM,UAAU,2EAA2E,CACzF,OAAgB;IAEhB,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,IACE,wBAAwB,CAAC,OAAO,EAAE,YAAY,CAAC;oBAC/C,CAAC,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,EACrC,CAAC;oBACD,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,gCAAgC;wBACtC,MAAM,EAAE,YAAY;wBACpB,SAAS,EAAE,SAAS;wBACpB,MAAM,EAAE;4BACN,SAAS,EAAE,wBAAwB;4BACnC,QAAQ,EAAE,aAAa;4BACvB,QAAQ,EAAE,cAAc,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG;yBAC/D;qBACF,CAAC,CAAC;gBACL,CAAC;gBAED,IACE,2BAA2B,CAAC,OAAO,EAAE,YAAY,CAAC;oBAClD,CAAC,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,EACxC,CAAC;oBACD,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,gCAAgC;wBACtC,MAAM,EAAE,YAAY;wBACpB,SAAS,EAAE,SAAS;wBACpB,MAAM,EAAE;4BACN,SAAS,EAAE,2BAA2B;4BACtC,QAAQ,EAAE,gBAAgB;4BAC1B,QAAQ,EAAE,cAAc,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,GAAG;yBAC/D;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,wBAAwB,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;oBACvF,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,gCAAgC;wBACtC,MAAM,EAAE,SAAS;wBACjB,SAAS,EAAE,SAAS;wBACpB,MAAM,EAAE;4BACN,SAAS,EAAE,wBAAwB;4BACnC,QAAQ,EAAE,aAAa;4BACvB,QAAQ,EAAE,cAAc,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG;yBAC5D;qBACF,CAAC,CAAC;gBACL,CAAC;gBAED,IACE,2BAA2B,CAAC,OAAO,EAAE,SAAS,CAAC;oBAC/C,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,EACrC,CAAC;oBACD,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,gCAAgC;wBACtC,MAAM,EAAE,SAAS;wBACjB,SAAS,EAAE,SAAS;wBACpB,MAAM,EAAE;4BACN,SAAS,EAAE,2BAA2B;4BACtC,QAAQ,EAAE,gBAAgB;4BAC1B,QAAQ,EAAE,cAAc,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG;yBAC5D;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,6BAA6B,CACpC,OAAgB,EAChB,MAA6B,EAC7B,SAI+B;IAE/B,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,IAAI,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QAClE,OAAO;IACT,CAAC;IAED,IAAI,MAAM,CAAC,IAAI,KAAK,WAAW,IAAI,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7D,OAAO;IACT,CAAC;IAED,gBAAgB,CAAC,OAAO,EAAE;QACxB,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,WAAW;QACtB,MAAM,EAAE;YACN,SAAS,EAAE,SAAS;YACpB,MAAM,EACJ,uFAAuF;SAC1F;KACF,CAAC,CAAC;AACL,CAAC;AAOD,MAAM,UAAU,8DAA8D,CAAC,OAAgB;IAC7F,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAC,CAAC;QACtD,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;QACxC,MAAM,eAAe,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,aAAa,CAAC,CAAC;QAC7E,MAAM,kBAAkB,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;QACnF,MAAM,0BAA0B,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,wBAAwB,CAAC,CAAC;QACnG,MAAM,6BAA6B,GAAG,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,2BAA2B,CAAC,CAAC;QAEzG,4BAA4B,CAAC,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,aAAa,CAAC,CAAC;QACrF,4BAA4B,CAAC,OAAO,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;QAC9F,4BAA4B,CAAC,OAAO,EAAE,0BAA0B,EAAE,wBAAwB,EAAE,wBAAwB,CAAC,CAAC;QACtH,4BAA4B,CAAC,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,2BAA2B,CAAC,CAAC;IACjI,CAAC;AACH,CAAC;AAED,SAAS,4BAA4B,CACnC,OAAgB,EAChB,UAAkC,EAClC,MAAc,EACd,YAAkG;IAGlG,MAAM,wBAAwB,GAAG,8BAA8B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAErF,KAAI,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,wBAAwB,EAChD,CAAC;QACC,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,MAAM,WAAW,GAA0B,EAAE,CAAA;QAC7C,KAAI,MAAM,YAAY,IAAI,UAAU,EAAC,CAAC;YACpC,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YACvD,IAAG,CAAC,UAAU,EAAC,CAAC;gBACd,SAAS;YACX,CAAC;YACD,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;QACD,IAAG,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,4BAA4B,CAAC,WAAW,CAAC,EAAC,CAAC;YACvE,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;gBAChC,0BAA0B,CAAC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC1F,CAAC,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,8BAA8B,CAAC,OAAgB,EAAE,UAAkC;IAE1F,IAAI,wBAAwB,GAAG,IAAI,GAAG,EAA4C,CAAC;IAEnF,KAAI,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,UAAU,EACzC,CAAC;QACC,MAAM,WAAW,GAAG,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC9D,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,KAAK,CAAC,EAAE;;YAC3B,MAAM,WAAW,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YAC3C,IAAG,WAAW,EAAC,CAAC;gBACd,IAAG,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,EAAC,CAAC;oBAC5C,MAAA,wBAAwB,CAAC,GAAG,CAAC,WAAW,CAAC,0CAAE,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC3E,CAAC;qBACG,CAAC;oBACH,wBAAwB,CAAC,GAAG,CAAC,WAAW,EAAE,EAAC,sBAAsB,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,YAAY,CAAC,EAAC,CAAC,CAAC;gBAC/G,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,wBAAwB,CAAC;AAClC,CAAC;AAGD,SAAS,gBAAgB,CAAC,OAAgB,EAAE,UAAkC,EAC5E,MAA8D;IAC/D,IAAI,KAAK,GAAG,IAAI,GAAG,EAAqB,CAAC;IACzC,KAAI,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,UAAU,EAAC,CAAC;QACzC,IAAG,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,EAAC,CAAC;YAChC,IAAI,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC;YAC5B,IAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAC,CAAC;gBAClB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAC/B,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED,SAAS,0BAA0B,CAAC,OAAgB,EAAE,YAAiB,EAAE,SAAiB,EAAE,kBAA0B;IACpH,gBAAgB,CAAC,OAAO,EAAE;QACxB,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,YAAY;QACpB,SAAS,EAAE,wBAAwB;QACnC,MAAM,EAAE;YACN,SAAS,EAAE,SAAS;YACpB,MAAM,EAAE,kBAAkB;SAC3B;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,4BAA4B,CAAC,wBAA+C;IACnF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,wBAAwB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACzD,IAAI,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtE,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentation.d.ts","sourceRoot":"","sources":["../../../src/rules/documentation.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,iCAAiC;;EA2F5C,CAAA"}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { createRule, getDoc, paramMessage } from "@typespec/compiler";
|
|
2
|
+
import { isComplex, isEntity } from "../index.js";
|
|
3
|
+
import { isExcludedCoreType } from "../utils.js";
|
|
4
|
+
export const validateCoreElementsHaveDocString = createRule({
|
|
5
|
+
name: "require-documentation-for-core-elements",
|
|
6
|
+
severity: "warning",
|
|
7
|
+
description: "Require documentation for models, model properties, enums, enum members, actions and functions",
|
|
8
|
+
messages: {
|
|
9
|
+
default: paramMessage `Models, model properties, enums, enum members, actions and functions must have documentation`
|
|
10
|
+
},
|
|
11
|
+
create(context) {
|
|
12
|
+
return {
|
|
13
|
+
model: (model) => {
|
|
14
|
+
if (isExcludedCoreType(context.program, model)) {
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
if (!isEntity(context.program, model) && !isComplex(context.program, model))
|
|
18
|
+
return;
|
|
19
|
+
const doc = getDoc(context.program, model);
|
|
20
|
+
if (!doc || doc.trim().length === 0) {
|
|
21
|
+
context.reportDiagnostic({
|
|
22
|
+
target: model,
|
|
23
|
+
format: {
|
|
24
|
+
target: model.name
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
}
|
|
28
|
+
for (const property of model.properties.values()) {
|
|
29
|
+
if (isExcludedCoreType(context.program, property)) {
|
|
30
|
+
continue;
|
|
31
|
+
}
|
|
32
|
+
const propDoc = getDoc(context.program, property);
|
|
33
|
+
if (!propDoc || propDoc.trim().length === 0) {
|
|
34
|
+
context.reportDiagnostic({
|
|
35
|
+
target: property,
|
|
36
|
+
format: {
|
|
37
|
+
target: property.name
|
|
38
|
+
}
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
},
|
|
43
|
+
enum: (enumType) => {
|
|
44
|
+
if (isExcludedCoreType(context.program, enumType)) {
|
|
45
|
+
return;
|
|
46
|
+
}
|
|
47
|
+
const doc = getDoc(context.program, enumType);
|
|
48
|
+
if (!doc || doc.trim().length === 0) {
|
|
49
|
+
context.reportDiagnostic({
|
|
50
|
+
target: enumType,
|
|
51
|
+
format: {
|
|
52
|
+
target: enumType.name
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
for (const member of enumType.members.values()) {
|
|
57
|
+
if (member.name === "unknownFutureValue") {
|
|
58
|
+
continue;
|
|
59
|
+
}
|
|
60
|
+
const memberDoc = getDoc(context.program, member);
|
|
61
|
+
if (!memberDoc || memberDoc.trim().length === 0) {
|
|
62
|
+
context.reportDiagnostic({
|
|
63
|
+
target: member,
|
|
64
|
+
format: {
|
|
65
|
+
target: member.name
|
|
66
|
+
}
|
|
67
|
+
});
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
},
|
|
71
|
+
operation: (operation) => {
|
|
72
|
+
if (isExcludedCoreType(context.program, operation) || operation.kind !== "Operation") {
|
|
73
|
+
return;
|
|
74
|
+
}
|
|
75
|
+
const doc = getDoc(context.program, operation);
|
|
76
|
+
if (!doc || doc.trim().length === 0) {
|
|
77
|
+
context.reportDiagnostic({
|
|
78
|
+
target: operation,
|
|
79
|
+
format: {
|
|
80
|
+
target: operation.name
|
|
81
|
+
}
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
});
|
|
88
|
+
//# sourceMappingURL=documentation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"documentation.js","sourceRoot":"","sources":["../../../src/rules/documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAA0B,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAEjD,MAAM,CAAC,MAAM,iCAAiC,GAAG,UAAU,CAAC;IAC1D,IAAI,EAAE,yCAAyC;IAC/C,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,gGAAgG;IAC7G,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,8FAA8F;KACpH;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC/C,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC;oBACzE,OAAO;gBAET,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC3C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,KAAK;wBACb,MAAM,EAAE;4BACN,MAAM,EAAE,KAAK,CAAC,IAAI;yBACnB;qBACF,CAAC,CAAC;gBACL,CAAC;gBAED,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;oBACjD,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;wBAClD,SAAS;oBACX,CAAC;oBAED,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAClD,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC5C,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,QAAQ;4BAChB,MAAM,EAAE;gCACN,MAAM,EAAE,QAAQ,CAAC,IAAI;6BACtB;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;YACD,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACjB,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;oBAClD,OAAO;gBACT,CAAC;gBAED,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;gBAC9C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,QAAQ;wBAChB,MAAM,EAAE;4BACN,MAAM,EAAE,QAAQ,CAAC,IAAI;yBACtB;qBACF,CAAC,CAAC;gBACL,CAAC;gBAED,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;oBAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;wBACzC,SAAS;oBACX,CAAC;oBAED,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBAClD,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAChD,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,MAAM;4BACd,MAAM,EAAE;gCACN,MAAM,EAAE,MAAM,CAAC,IAAI;6BACpB;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;YACD,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,SAAS,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;oBACrF,OAAO;gBACT,CAAC;gBAED,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;gBAC9C,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpC,OAAO,CAAC,gBAAgB,CAAC;wBACvB,MAAM,EAAE,SAAS;wBACjB,MAAM,EAAE;4BACN,MAAM,EAAE,SAAS,CAAC,IAAI;yBACvB;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}
|
|
@@ -4,4 +4,7 @@ export declare function validateKeyOnlyOnEntityNonNullablePrimitiveProperty(prog
|
|
|
4
4
|
export declare function validateExtendOnlyAppliesOnDifferentNamespaces(program: Program): void;
|
|
5
5
|
export declare function validatePropertyTypeOfEntityTypeMustHaveContainsOrReferences(program: Program): void;
|
|
6
6
|
export declare function validateEntityAndComplexAreMutuallyExclusive(program: Program): void;
|
|
7
|
+
export declare const entityAndComplexPropertyNameShouldNotBeName: import("@typespec/compiler").LinterRuleDefinition<"entity-complex-property-names-should-not-be-name", {
|
|
8
|
+
readonly default: import("@typespec/compiler").CallableMessage<[]>;
|
|
9
|
+
}>;
|
|
7
10
|
//# sourceMappingURL=entity.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../src/rules/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,
|
|
1
|
+
{"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../../src/rules/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EACsH,MAAM,oBAAoB,CAAC;AAMjK,wBAAgB,yBAAyB,CAAC,OAAO,EAAE,OAAO,QAsDzD;AAED,wBAAgB,mDAAmD,CAAC,OAAO,EAAE,OAAO,QA2CnF;AAGD,wBAAgB,8CAA8C,CAAC,OAAO,EAAE,OAAO,QA8B9E;AAED,wBAAgB,4DAA4D,CAAE,OAAO,EAAE,OAAO,QA0B7F;AAED,wBAAgB,4CAA4C,CAAC,OAAO,EAAE,OAAO,QAkB5E;AAED,eAAO,MAAM,2CAA2C;;EA2BtD,CAAA"}
|
package/dist/src/rules/entity.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { getLocationContext, isKey, navigateTypesInNamespace, walkPropertiesInherited, isArrayModelType } from "@typespec/compiler";
|
|
2
|
-
import { isComplex,
|
|
1
|
+
import { getLocationContext, isKey, navigateTypesInNamespace, walkPropertiesInherited, isArrayModelType, createRule, paramMessage } from "@typespec/compiler";
|
|
2
|
+
import { isComplex, isEntity, isOwnerless, isPartial } from "../index.js";
|
|
3
3
|
import { reportDiagnostic } from "../lib.js";
|
|
4
|
-
import { isTypeNullable, isExcludedLibraryType, isSameNamespace, extractTypesFromUnion, getInterfaceNavigationSourceType } from "../utils.js";
|
|
4
|
+
import { isTypeNullable, isExcludedLibraryType, isSameNamespace, extractTypesFromUnion, getInterfaceNavigationSourceType, isNavigationProperty } from "../utils.js";
|
|
5
5
|
import { GetDeclaredNamespaces } from "../entities/namespace.js";
|
|
6
6
|
export function validateEntityMustHaveKey(program) {
|
|
7
7
|
for (const namespace of GetDeclaredNamespaces(program)) {
|
|
@@ -129,7 +129,7 @@ export function validatePropertyTypeOfEntityTypeMustHaveContainsOrReferences(pro
|
|
|
129
129
|
navigateTypesInNamespace(namespace, {
|
|
130
130
|
modelProperty: (property) => {
|
|
131
131
|
if (property.type.kind === "Model" && isPropertyParentModelAndPropertyTypeEntity(program, property)) {
|
|
132
|
-
if (!
|
|
132
|
+
if (!isNavigationProperty(program, property)) {
|
|
133
133
|
reportModelPropertyDiagnostics(program, property);
|
|
134
134
|
return;
|
|
135
135
|
}
|
|
@@ -138,7 +138,7 @@ export function validatePropertyTypeOfEntityTypeMustHaveContainsOrReferences(pro
|
|
|
138
138
|
const unionTypes = extractTypesFromUnion(property.type);
|
|
139
139
|
for (const unionType of unionTypes) {
|
|
140
140
|
if (unionType.kind === "Model" && isEntity(program, unionType)) {
|
|
141
|
-
if (!
|
|
141
|
+
if (!isNavigationProperty(program, property)) {
|
|
142
142
|
reportModelPropertyDiagnostics(program, property, unionType.name);
|
|
143
143
|
return;
|
|
144
144
|
}
|
|
@@ -167,6 +167,33 @@ export function validateEntityAndComplexAreMutuallyExclusive(program) {
|
|
|
167
167
|
});
|
|
168
168
|
}
|
|
169
169
|
}
|
|
170
|
+
export const entityAndComplexPropertyNameShouldNotBeName = createRule({
|
|
171
|
+
name: "entity-complex-property-names-should-not-be-name",
|
|
172
|
+
severity: "warning",
|
|
173
|
+
description: "Enforce prperty names should not be 'name'",
|
|
174
|
+
messages: {
|
|
175
|
+
default: paramMessage `Prefer using 'displayName' instead of 'name'`
|
|
176
|
+
},
|
|
177
|
+
create(context) {
|
|
178
|
+
return {
|
|
179
|
+
model: (model) => {
|
|
180
|
+
if (!isEntity(context.program, model) && !isComplex(context.program, model)) {
|
|
181
|
+
return;
|
|
182
|
+
}
|
|
183
|
+
for (const property of model.properties.values()) {
|
|
184
|
+
if (property.name.toLowerCase() === "name") {
|
|
185
|
+
context.reportDiagnostic({
|
|
186
|
+
target: property,
|
|
187
|
+
format: {
|
|
188
|
+
property: property.name
|
|
189
|
+
}
|
|
190
|
+
});
|
|
191
|
+
}
|
|
192
|
+
}
|
|
193
|
+
}
|
|
194
|
+
};
|
|
195
|
+
},
|
|
196
|
+
});
|
|
170
197
|
function isPropertyParentModelAndPropertyTypeEntity(program, property) {
|
|
171
198
|
const propertyType = getPropertyType(program, property);
|
|
172
199
|
return getLocationContext(program, property).type !== "library" &&
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../../src/rules/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,kBAAkB,EAAE,KAAK,EAAE,wBAAwB,EAClE,uBAAuB,EAAiE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"entity.js","sourceRoot":"","sources":["../../../src/rules/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,kBAAkB,EAAE,KAAK,EAAE,wBAAwB,EAClE,uBAAuB,EAAiE,gBAAgB,EAAE,UAAU,EAAE,YAAY,EAAC,MAAM,oBAAoB,CAAC;AACjK,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,eAAe,EAAE,qBAAqB,EAAE,gCAAgC,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACpK,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,MAAM,UAAU,yBAAyB,CAAC,OAAgB;IACxD,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC9B,OAAO;gBACT,CAAC;gBAED,IAAG,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,EAAC,CAAC;oBAC5B,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;gBAClD,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;oBAClC,IAAI,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;wBAC7B,OAAO;oBACT,CAAC;gBACH,CAAC;gBAED,8EAA8E;gBAC9E,IAAI,gBAAgB,GAAW,KAAK,CAAC;gBACrC,wBAAwB,CAAC,SAAS,EAAE;oBAClC,SAAS,EAAE,CAAC,cAAc,EAAE,EAAE;wBAC5B,IAAG,WAAW,CAAC,OAAO,EAAE,cAAc,CAAC,EAAC,CAAC;4BACvC,IAAI,WAAW,GAAmB,gCAAgC,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;4BAC5F,IAAI,WAAW,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;gCACzC,gBAAgB,GAAG,IAAI,CAAC;4BAC1B,CAAC;wBACH,CAAC;oBACH,CAAC;iBACF,CAAC,CAAC;gBAEH,iEAAiE;gBACjE,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAwB,EAAE,EAAE;;oBAAC,OAAA,CAAA,MAAA,EAAE,CAAC,UAAU,0CAAE,IAAI,MAAK,eAAe;wBACvF,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAsB,EAAE,EAAE,CAAE,IAAI,CAAC,OAAkB,KAAK,sBAAsB,CAAC,KAAK,CAAC,CAAC;wBACzG,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAsB,EAAE,EAAE,CAAE,IAAI,CAAC,OAAkB,KAAK,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;iBAAA,CAAC,EAAE,CAAC;oBACjG,gBAAgB,GAAG,IAAI,CAAC;gBAC5B,CAAC;gBACD,IAAI,gBAAgB,EAAE,CAAC;oBACpB,OAAO;gBACV,CAAC;gBAED,gBAAgB,CAAC,OAAO,EAAE;oBACxB,IAAI,EAAE,gCAAgC;oBACtC,MAAM,EAAE,KAAK;oBACb,MAAM,EAAE;wBACN,SAAS,EAAE,SAAS;wBACpB,QAAQ,EAAE,MAAM;wBAChB,QAAQ,EAAE,uBAAuB;qBAClC;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAAA,CAAC;AAEF,MAAM,UAAU,mDAAmD,CAAC,OAAgB;IAClF,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,aAAa,EAAE,CAAC,QAAQ,EAAE,EAAE;gBAC1B,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;oBACjD,OAAO;gBACT,CAAC;gBAED,IAAI,qBAAqB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACnD,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACvC,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,gCAAgC;wBACtC,MAAM,EAAE,QAAQ;wBAChB,MAAM,EAAE;4BACN,SAAS,EAAE,MAAM;4BACjB,QAAQ,EAAE,SAAS;4BACnB,QAAQ,EAAE,cAAc;yBACzB;qBACF,CAAC,CAAC;oBAEH,OAAO;gBACT,CAAC;gBAED,IACE,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC;oBACtC,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ;oBAC/B,QAAQ,CAAC,IAAI,KAAK,OAAO,EACzB,CAAC;oBACD,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,uBAAuB;wBAC7B,MAAM,EAAE,QAAQ;wBAChB,SAAS,EAAE,KAAK;wBAChB,MAAM,EAAE,EAAE;qBACX,CAAC,CAAC;oBAEH,OAAO;gBACT,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAAA,CAAC;AAEF,yCAAyC;AACzC,MAAM,UAAU,8CAA8C,CAAC,OAAgB;IAC7E,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;oBACrB,OAAO;gBACT,CAAC;gBAED,MAAM,4BAA4B,GAAG,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC;gBACvF,MAAM,wBAAwB,GAAG,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC;gBAEzE,IAAG,4BAA4B,KAAK,SAAS,IAAI,wBAAwB,KAAK,SAAS,EAAC,CAAC;oBACvF,OAAO;gBACT,CAAC;gBAED,IAAG,4BAA4B,KAAK,SAAS,IAAI,wBAAwB,KAAK,SAAS,EAAC,CAAC;oBACvF,OAAO;gBACT,CAAC;gBAED,IAAI,eAAe,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;oBACrD,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,qBAAqB;wBAC3B,MAAM,EAAE,KAAK;wBACb,SAAS,EAAE,YAAY;wBACvB,MAAM,EAAE,EAAE;qBACX,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAAA,CAAC;AAEF,MAAM,UAAU,4DAA4D,CAAE,OAAgB;IAC5F,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAC,CAAC;QACtD,wBAAwB,CAAC,SAAS,EAAE;YAClC,aAAa,EAAE,CAAC,QAAQ,EAAE,EAAE;gBAC1B,IAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,0CAA0C,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;oBACnG,IAAG,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAC,CAAC;wBAC3C,8BAA8B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;wBAClD,OAAO;oBACT,CAAC;gBACH,CAAC;gBAED,IAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,KAAK,SAAS,EAAC,CAAC;oBAC7F,MAAM,UAAU,GAAG,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAExD,KAAI,MAAM,SAAS,IAAI,UAAU,EAAC,CAAC;wBACjC,IAAG,SAAS,CAAC,IAAI,KAAK,OAAO,IAAI,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;4BAC9D,IAAG,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAC,CAAC;gCAC3C,8BAA8B,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;gCAClE,OAAO;4BACT,CAAC;wBACH,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;AACH,CAAC;AAED,MAAM,UAAU,4CAA4C,CAAC,OAAgB;IAC3E,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAC,CAAC;QACtD,wBAAwB,CAAC,SAAS,EAAE;YAClC,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,IAAG,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,EAAC,CAAC;oBACxD,gBAAgB,CAAC,OAAO,EAAE;wBACxB,IAAI,EAAE,uBAAuB;wBAC7B,MAAM,EAAE,KAAK;wBACb,SAAS,EAAE,sCAAsC;wBACjD,MAAM,EAAE;4BACN,KAAK,EAAE,KAAK,CAAC,IAAI;yBAClB;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;AAEH,CAAC;AAED,MAAM,CAAC,MAAM,2CAA2C,GAAG,UAAU,CAAC;IACpE,IAAI,EAAE,kDAAkD;IACxD,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,4CAA4C;IACzD,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,8CAA8C;KACpE;IACD,MAAM,CAAC,OAAO;QACV,OAAO;YACL,KAAK,EAAE,CAAC,KAAK,EAAE,EAAE;gBACf,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC5E,OAAO;gBACT,CAAC;gBAED,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,EAAE,EAAE,CAAC;oBACjD,IAAI,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;wBAC3C,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,QAAQ;4BAChB,MAAM,EAAE;gCACN,QAAQ,EAAE,QAAQ,CAAC,IAAI;6BACxB;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAA;IACL,CAAC;CACF,CAAC,CAAA;AAEF,SAAS,0CAA0C,CAAC,OAAgB,EAAE,QAAuB;IAC3F,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAExD,OAAO,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,IAAI,KAAK,SAAS;QAC7D,QAAQ,CAAC,KAAK;QACd,YAAY,CAAC,IAAI,KAAK,OAAO;QAC7B,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC;QACjC,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,8BAA8B,CAAC,OAAgB,EAAE,QAAuB,EAAE,gBAAyB;IAC1G,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACxD,gBAAgB,CAAC,OAAO,EAAE;QACxB,IAAI,EAAE,8BAA8B;QACpC,MAAM,EAAE,QAAQ;QAChB,SAAS,EAAE,qCAAqC;QAChD,MAAM,EAAE;YACN,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,MAAM,EAAE,gBAAgB,aAAhB,gBAAgB,cAAhB,gBAAgB,GAAK,YAAsB,CAAC,IAAI;SACzD;KACF,CAAC,CAAC;AACL,CAAC;AAED,SAAS,eAAe,CAAC,OAAgB,EAAE,QAAuB;IAChE,IAAI,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC;IACjC,IAAI,YAAY,CAAC,IAAI,KAAK,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,EAAE,CAAC;QAC7E,YAAY,GAAG,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC;IAC5C,CAAC;IACD,OAAO,YAAY,CAAC;AACtB,CAAC"}
|
package/dist/src/rules/enum.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
+
import { Program } from "@typespec/compiler";
|
|
1
2
|
export declare const useEvolvableEnumRule: import("@typespec/compiler").LinterRuleDefinition<"use-evolvable-enum", {
|
|
2
3
|
readonly default: import("@typespec/compiler").CallableMessage<[string]>;
|
|
3
4
|
}>;
|
|
5
|
+
export declare function validateEnumMemberUnknownFutureValueShouldNotHaveDocString(program: Program): void;
|
|
4
6
|
//# sourceMappingURL=enum.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enum.d.ts","sourceRoot":"","sources":["../../../src/rules/enum.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"enum.d.ts","sourceRoot":"","sources":["../../../src/rules/enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAA8D,MAAM,oBAAoB,CAAC;AAKzG,eAAO,MAAM,oBAAoB;;EA2B/B,CAAC;AAEH,wBAAgB,0DAA0D,CAAC,OAAO,EAAE,OAAO,QAyB1F"}
|
package/dist/src/rules/enum.js
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import { createRule, paramMessage } from "@typespec/compiler";
|
|
1
|
+
import { createRule, getDoc, navigateTypesInNamespace, paramMessage } from "@typespec/compiler";
|
|
2
2
|
import { isExcludedCoreType } from "../utils.js";
|
|
3
|
+
import { GetDeclaredNamespaces } from "../entities/namespace.js";
|
|
4
|
+
import { reportDiagnostic } from "../lib.js";
|
|
3
5
|
export const useEvolvableEnumRule = createRule({
|
|
4
6
|
name: "use-evolvable-enum",
|
|
5
7
|
severity: "warning",
|
|
@@ -26,4 +28,28 @@ export const useEvolvableEnumRule = createRule({
|
|
|
26
28
|
};
|
|
27
29
|
},
|
|
28
30
|
});
|
|
31
|
+
export function validateEnumMemberUnknownFutureValueShouldNotHaveDocString(program) {
|
|
32
|
+
for (const namespace of GetDeclaredNamespaces(program)) {
|
|
33
|
+
navigateTypesInNamespace(namespace, {
|
|
34
|
+
enum: (enumType) => {
|
|
35
|
+
for (const member of enumType.members.values()) {
|
|
36
|
+
if (member.name !== "unknownFutureValue") {
|
|
37
|
+
continue;
|
|
38
|
+
}
|
|
39
|
+
const doc = getDoc(program, member);
|
|
40
|
+
if (doc) {
|
|
41
|
+
reportDiagnostic(program, {
|
|
42
|
+
code: "decorator-invalid-use",
|
|
43
|
+
target: member,
|
|
44
|
+
messageId: "enumMemberUnknownFutureValueCannotHaveDocString",
|
|
45
|
+
format: {
|
|
46
|
+
member: member.name,
|
|
47
|
+
},
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
}
|
|
29
55
|
//# sourceMappingURL=enum.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../src/rules/enum.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../src/rules/enum.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,UAAU,EAAE,MAAM,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAE7C,MAAM,CAAC,MAAM,oBAAoB,GAAG,UAAU,CAAC;IAC7C,IAAI,EAAE,oBAAoB;IAC1B,QAAQ,EAAE,SAAS;IACnB,WAAW,EAAE,yBAAyB;IACtC,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,gBAAgB,MAAM,2EAA2E;KACvH;IACD,MAAM,CAAC,OAAO;QACZ,OAAO;YACL,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACjB,IAAI,kBAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC;oBAClD,OAAO;gBACT,CAAC;gBAED,IAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC;oBAC/C,OAAO;gBACT,CAAC;gBAED,OAAO,CAAC,gBAAgB,CAAC;oBACvB,MAAM,EAAE,QAAQ;oBAChB,MAAM,EAAE;wBACN,IAAI,EAAE,QAAQ,CAAC,IAAI;qBACpB;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,UAAU,0DAA0D,CAAC,OAAgB;IACzF,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAC,CAAC;QACtD,wBAAwB,CAAC,SAAS,EAAE;YAClC,IAAI,EAAE,CAAC,QAAQ,EAAE,EAAE;gBACjB,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;oBAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,oBAAoB,EAAE,CAAC;wBACzC,SAAS;oBACX,CAAC;oBAED,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;oBACpC,IAAI,GAAG,EAAE,CAAC;wBACR,gBAAgB,CAAC,OAAO,EAAE;4BACxB,IAAI,EAAE,uBAAuB;4BAC7B,MAAM,EAAE,MAAM;4BACd,SAAS,EAAE,iDAAiD;4BAC5D,MAAM,EAAE;gCACN,MAAM,EAAE,MAAM,CAAC,IAAI;6BACpB;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;AAEH,CAAC"}
|
package/dist/src/rules/expand.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { navigateTypesInNamespace, walkPropertiesInherited } from "@typespec/compiler";
|
|
2
2
|
import { getOperationVerb } from "@typespec/http";
|
|
3
|
-
import { getExpand,
|
|
3
|
+
import { getExpand, isDelta, isExpand } from "../index.js";
|
|
4
4
|
import { reportDiagnostic } from "../lib.js";
|
|
5
|
-
import { getNavigationSourceType } from "../utils.js";
|
|
5
|
+
import { getNavigationSourceType, isNavigationProperty } from "../utils.js";
|
|
6
6
|
import { GetDeclaredNamespaces } from "../entities/namespace.js";
|
|
7
7
|
export function validateExpandOnlyOnGetNavigationSource(program) {
|
|
8
8
|
for (const namespace of GetDeclaredNamespaces(program)) {
|
|
@@ -47,7 +47,7 @@ export function validateExpandOnlyNavigationProperties(program) {
|
|
|
47
47
|
}
|
|
48
48
|
const modelType = returnType.indexer ? returnType.indexer.value : returnType;
|
|
49
49
|
const navigationProperties = [...walkPropertiesInherited(modelType)]
|
|
50
|
-
.filter((property) =>
|
|
50
|
+
.filter((property) => isNavigationProperty(program, property))
|
|
51
51
|
.map((property) => property.name);
|
|
52
52
|
const invalidExpansions = expanded.filter((property) => {
|
|
53
53
|
return !navigationProperties.includes(property) && property !== "$value";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"expand.js","sourceRoot":"","sources":["../../../src/rules/expand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AACvG,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,
|
|
1
|
+
{"version":3,"file":"expand.js","sourceRoot":"","sources":["../../../src/rules/expand.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,wBAAwB,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AACvG,OAAO,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAEjE,MAAM,UAAU,uCAAuC,CAAC,OAAgB;IACtE,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;oBAClC,OAAO;gBACT,CAAC;gBAED,IAAI,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,KAAK,EAAE,CAAC;oBACnD,IAAG,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,KAAK,SAAS,EAAE,CAAC;wBAC7D,OAAO;oBACT,CAAC;gBACH,CAAC;gBAED,IAAG,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,SAAS,CAAC,IAAI,KAAK,OAAO,EAAC,CAAC;oBAC5D,OAAO;gBACT,CAAC;gBAED,gBAAgB,CAAC,OAAO,EAAE;oBACxB,IAAI,EAAE,uBAAuB;oBAC7B,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,WAAW;oBACtB,MAAM,EAAE;wBACN,SAAS,EAAE,SAAS;wBACpB,MAAM,EAAE,eAAe;qBACxB;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAAA,CAAC;AAEF,MAAM,UAAU,sCAAsC,CAAC,OAAgB;IACrE,KAAK,MAAM,SAAS,IAAI,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;QACvD,wBAAwB,CAAC,SAAS,EAAE;YAClC,SAAS,EAAE,CAAC,SAAS,EAAE,EAAE;gBACvB,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBAC/C,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;oBACrB,OAAO;gBACT,CAAC;gBAED,MAAM,UAAU,GAAG,uBAAuB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;gBAC/D,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,OAAO;gBACT,CAAC;gBAED,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAE,UAAU,CAAC,OAAO,CAAC,KAAe,CAAC,CAAC,CAAC,UAAU,CAAC;gBACxF,MAAM,oBAAoB,GAAG,CAAC,GAAG,uBAAuB,CAAC,SAAS,CAAC,CAAC;qBACjE,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,oBAAoB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;qBAC7D,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAEpC,MAAM,iBAAiB,GAAG,QAAQ,CAAC,MAAM,CACvC,CAAC,QAAQ,EAAE,EAAE;oBACX,OAAO,CAAC,oBAAoB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,KAAK,QAAQ,CAAA;gBAC1E,CAAC,CACF,CAAC;gBAEF,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;oBAC9B,OAAO;gBACT,CAAC;gBAED,gBAAgB,CAAC,OAAO,EAAE;oBACxB,IAAI,EAAE,uBAAuB;oBAC7B,MAAM,EAAE,SAAS;oBACjB,SAAS,EAAE,kBAAkB;oBAC7B,MAAM,EAAE;wBACN,KAAK,EAAE,SAAS,CAAC,IAAI;wBACrB,UAAU,EAAE,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC;qBACzC;iBACF,CAAC,CAAC;YACL,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAAA,CAAC"}
|
|
@@ -8,6 +8,7 @@ export * from "./contains.js";
|
|
|
8
8
|
export * from "./count.js";
|
|
9
9
|
export * from "./delta.js";
|
|
10
10
|
export * from "./disallowed-typespec-decorators.js";
|
|
11
|
+
export * from "./documentation.js";
|
|
11
12
|
export * from "./entity.js";
|
|
12
13
|
export * from "./enum.js";
|
|
13
14
|
export * from "./expand.js";
|