@openctx/protocol - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "@openctx/protocol",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "OpenCtx client/provider protocol",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

src/openctx-protocol.schema.json

@@ -98,7 +98,7 @@ {
                 "selector": {
-                    "description": "Selects the scope (repositories, files, and languages) in which this provider should be called.\n\nAt least 1 must be satisfied for the provider to be called. If empty, the provider is never called. If undefined, the provider is called on all files.",
+                    "description": "Selects the scope in which this provider should be called.\n\nAt least 1 must be satisfied for the provider to be called. If empty, the provider is never called. If undefined, the provider is called on all resources.",
                     "type": "array",
                     "items": {
                         "title": "Selector",
-                        "description": "Defines a scope in which a provider is called, as a subset of languages, repositories, and/or files.\n\nTo satisfy a selector, all of the selector's conditions must be met. For example, if both `path` and `content` are specified, the file must satisfy both conditions.",
+                        "description": "Defines a scope in which a provider is called.\n\nTo satisfy a selector, all of the selector's conditions must be met. For example, if both `path` and `content` are specified, the resource must satisfy both conditions.",
                         "type": "object",
@@ -108,7 +108,7 @@ "additionalProperties": false,
                             "path": {
-                                "description": "A glob that must match the file path. If the file's location is represented as a URI, the URI's scheme is stripped before being matched against this glob.\n\nUse `**/` before the glob to match in any parent directory. Use `/**` after the glob to match any files under a directory. Leading slashes are stripped from the path before being matched against the glob.",
+                                "description": "A glob that must match the resource's hostname and path.\n\nUse `**/` before the glob to match in any parent directory. Use `/**` after the glob to match any resources under a directory. Leading slashes are stripped from the path before being matched against the glob.",
                                 "type": "string"
                             },
                             "contentContains": {
-                                "description": "A literal string that must be present in the file's content.",
+                                "description": "A literal string that must be present in the resource's content.",
                                 "type": "string"
@@ -124,10 +124,11 @@ }
             "additionalProperties": false,
-            "required": ["file", "content"],
+            "required": ["uri", "content"],
             "properties": {
-                "file": {
-                    "description": "The file's URI.",
-                    "type": "string"
+                "uri": {
+                    "description": "The resource's URI.",
+                    "type": "string",
+                    "format": "uri"
                 },
                 "content": {
-                    "description": "The file's content.",
+                    "description": "The resource's content.",
                     "type": "string"
@@ -134,0 +135,0 @@ }

src/openctx-protocol.schema.ts

@@ -39,5 +39,5 @@ import type { Item } from '@openctx/schema'
     /**
-     * Selects the scope (repositories, files, and languages) in which this provider should be called.
+     * Selects the scope in which this provider should be called.
      *
-     * At least 1 must be satisfied for the provider to be called. If empty, the provider is never called. If undefined, the provider is called on all files.
+     * At least 1 must be satisfied for the provider to be called. If empty, the provider is never called. If undefined, the provider is called on all resources.
      */
@@ -47,15 +47,15 @@ selector?: Selector[]
 /**
- * Defines a scope in which a provider is called, as a subset of languages, repositories, and/or files.
+ * Defines a scope in which a provider is called.
  *
- * To satisfy a selector, all of the selector's conditions must be met. For example, if both `path` and `content` are specified, the file must satisfy both conditions.
+ * To satisfy a selector, all of the selector's conditions must be met. For example, if both `path` and `content` are specified, the resource must satisfy both conditions.
  */
 export interface Selector {
     /**
-     * A glob that must match the file path. If the file's location is represented as a URI, the URI's scheme is stripped before being matched against this glob.
+     * A glob that must match the resource's hostname and path.
      *
-     * Use `** /` before the glob to match in any parent directory. Use `/**` after the glob to match any files under a directory. Leading slashes are stripped from the path before being matched against the glob.
+     * Use `** /` before the glob to match in any parent directory. Use `/**` after the glob to match any resources under a directory. Leading slashes are stripped from the path before being matched against the glob.
      */
     path?: string
     /**
-     * A literal string that must be present in the file's content.
+     * A literal string that must be present in the resource's content.
      */
@@ -66,9 +66,9 @@ contentContains?: string
     /**
-     * The file's URI.
+     * The resource's URI.
      */
-    file: string
+    uri: string
     /**
-     * The file's content.
+     * The resource's content.
      */
     content: string
 }

No alert changes

Worsened metrics

Total package byte prevSize

21205

decreased by-10.73%

Number of package files

12

decreased by-14.29%

Lines of code

216

decreased by-22.58%

No dependency changes