@typespec/http - npm Package Compare versions

Comparing version 0.51.0-dev.0 to 0.51.0-dev.1

dist/src/rules/op-reference-container-route.d.ts.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"op-reference-container-route.d.ts","sourceRoot":"","sources":["../../../src/rules/op-reference-container-route.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,6BAA6B;;EAiExC,CAAC"}
+{"version":3,"file":"op-reference-container-route.d.ts","sourceRoot":"","sources":["../../../src/rules/op-reference-container-route.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,6BAA6B;;EAkExC,CAAC"}

dist/src/rules/op-reference-container-route.js

@@ -5,4 +5,5 @@ import { createRule, paramMessage } from "@typespec/compiler";
     name: "op-reference-container-route",
+    severity: "warning",
     description: "Check for referenced (`op is`) operations which have a @route on one of their containers.",
-    severity: "warning",
+    url: "https://microsoft.github.io/typespec/standard-library/http/rules/op-reference-container-route",
     messages: {
@@ -9,0 +10,0 @@ default: paramMessage `Operation ${"opName"} references an operation which has a @route prefix on its namespace or interface: "${"routePrefix"}".  This operation will not carry forward the route prefix so the final route may be different than the referenced operation.`,

dist/src/rules/op-reference-container-route.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"op-reference-container-route.js","sourceRoot":"","sources":["../../../src/rules/op-reference-container-route.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,MAAM,CAAC,MAAM,6BAA6B,GAAG,UAAU,CAAC;IACtD,IAAI,EAAE,8BAA8B;IACpC,WAAW,EACT,2FAA2F;IAC7F,QAAQ,EAAE,SAAS;IACnB,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,aAAa,QAAQ,sFAAsF,aAAa,+HAA+H;KAC7Q;IACD,MAAM,CAAC,OAAO;QACZ,4EAA4E;QAC5E,6EAA6E;QAC7E,sDAAsD;QACtD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAiC,CAAC;QAE5D,SAAS,uBAAuB,CAC9B,SAAqD;;YAErD,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,WAAW,EAAE;gBAClC,OAAO,CACL,MAAA,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,mCAC5C,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,CAC7C,CAAC;aACH;YAED,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACvD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC3E,CAAC;QAED,SAAS,wBAAwB,CAAC,EAAyB,EAAE,UAAqB;;YAChF,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,gEAAgE;gBAChE,0CAA0C;gBAC1C,MAAM,SAAS,GAAG,MAAA,EAAE,CAAC,SAAS,mCAAI,EAAE,CAAC,SAAS,CAAC;gBAC/C,MAAM,iBAAiB,GAAG,MAAA,UAAU,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAS,CAAC;gBACvE,IAAI,SAAS,KAAK,iBAAiB,EAAE;oBACnC,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,KAAK,KAAK,SAAS,EAAE;wBACvB,KAAK,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;wBACpC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;qBAC3B;oBAED,IAAI,KAAK,EAAE;wBACT,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,UAAU;4BAClB,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE;yBACxD,CAAC,CAAC;wBACH,OAAO;qBACR;iBACF;gBAED,2EAA2E;gBAC3E,wBAAwB,CAAC,EAAE,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;aAC1D;QACH,CAAC;QAED,OAAO;YACL,SAAS,EAAE,CAAC,EAAa,EAAE,EAAE;gBAC3B,wBAAwB,CAAC,EAAE,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}
+{"version":3,"file":"op-reference-container-route.js","sourceRoot":"","sources":["../../../src/rules/op-reference-container-route.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAG3C,MAAM,CAAC,MAAM,6BAA6B,GAAG,UAAU,CAAC;IACtD,IAAI,EAAE,8BAA8B;IACpC,QAAQ,EAAE,SAAS;IACnB,WAAW,EACT,2FAA2F;IAC7F,GAAG,EAAE,+FAA+F;IACpG,QAAQ,EAAE;QACR,OAAO,EAAE,YAAY,CAAA,aAAa,QAAQ,sFAAsF,aAAa,+HAA+H;KAC7Q;IACD,MAAM,CAAC,OAAO;QACZ,4EAA4E;QAC5E,6EAA6E;QAC7E,sDAAsD;QACtD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAiC,CAAC;QAE5D,SAAS,uBAAuB,CAC9B,SAAqD;;YAErD,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,OAAO,SAAS,CAAC;aAClB;YAED,IAAI,SAAS,CAAC,IAAI,KAAK,WAAW,EAAE;gBAClC,OAAO,CACL,MAAA,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,mCAC5C,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,CAC7C,CAAC;aACH;YAED,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACvD,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,uBAAuB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC3E,CAAC;QAED,SAAS,wBAAwB,CAAC,EAAyB,EAAE,UAAqB;;YAChF,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,gEAAgE;gBAChE,0CAA0C;gBAC1C,MAAM,SAAS,GAAG,MAAA,EAAE,CAAC,SAAS,mCAAI,EAAE,CAAC,SAAS,CAAC;gBAC/C,MAAM,iBAAiB,GAAG,MAAA,UAAU,CAAC,SAAS,mCAAI,UAAU,CAAC,SAAS,CAAC;gBACvE,IAAI,SAAS,KAAK,iBAAiB,EAAE;oBACnC,IAAI,KAAK,GAAG,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;oBAC/B,IAAI,KAAK,KAAK,SAAS,EAAE;wBACvB,KAAK,GAAG,uBAAuB,CAAC,EAAE,CAAC,CAAC;wBACpC,UAAU,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;qBAC3B;oBAED,IAAI,KAAK,EAAE;wBACT,OAAO,CAAC,gBAAgB,CAAC;4BACvB,MAAM,EAAE,UAAU;4BAClB,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE;yBACxD,CAAC,CAAC;wBACH,OAAO;qBACR;iBACF;gBAED,2EAA2E;gBAC3E,wBAAwB,CAAC,EAAE,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;aAC1D;QACH,CAAC;QAED,OAAO;YACL,SAAS,EAAE,CAAC,EAAa,EAAE,EAAE;gBAC3B,wBAAwB,CAAC,EAAE,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACnD,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package.json

 {
   "name": "@typespec/http",
-  "version": "0.51.0-dev.0",
+  "version": "0.51.0-dev.1",
   "author": "Microsoft Corporation",
   "description": "TypeSpec HTTP protocol binding",
   "homepage": "https://github.com/microsoft/typespec",
+  "docusaurusWebsite": "https://microsoft.github.io/typespec",
   "readme": "https://github.com/microsoft/typespec/blob/main/README.md",
@@ -8,0 +9,0 @@ "license": "MIT",

README.md

@@ -11,2 +11,26 @@ # @typespec/http
 
+## Linter
+
+### Usage
+
+Add the following in `tspconfig.yaml`:
+
+```yaml
+linter:
+  extends:
+    - "@typespec/http/all"
+```
+
+### RuleSets
+
+Available ruleSets:
+
+- [`@typespec/http/all`](#@typespec/http/all)
+
+### Rules
+
+| Name                                                                                                                                           | Description                                                                               |
+| ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
+| [`@typespec/http/op-reference-container-route`](https://microsoft.github.io/typespec/standard-library/http/rules/op-reference-container-route) | Check for referenced (`op is`) operations which have a @route on one of their containers. |
+
 ## Decorators
@@ -13,0 +37,0 @@

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

234465

0.48%

Lines of code

3021

0.03%

Number of lines in readme file

473

5.35%

Worsened metrics

Number of low supply chain risk alerts

3

50%

No dependency changes