Skip to content

Commit

Permalink
readme and jsdoc tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Filip Maj committed Jun 12, 2024
1 parent 98310e9 commit 8103faf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ under the hood.

## Requirements

This library requires a recent (at least 1.22) version of
This library requires a recent (at least 1.44) version of
[deno](https://deno.land).

## Running Tests
Expand All @@ -26,7 +26,7 @@ as desired, you can run:

To get a full test coverage report, run:

deno task coverage
deno task test:coverage

---

Expand Down
3 changes: 3 additions & 0 deletions src/mock.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import type { Protocol } from "./types.ts";
import { spy } from "@std/testing/mock";

/**
* A mock protocol constructor function, composed of purely spy functions, for use in testing.
*/
export const MockProtocol = function (): Protocol {
return {
name: "MockProtocol",
Expand Down
3 changes: 0 additions & 3 deletions src/mod.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ const SUPPORTED_NAMED_PROTOCOLS = [
* and the CLI reads both stdout and stderr and combines them to interpret the hook response.
* This simplistic protocol has inherent limitations: cannot log diagnostic info!
* @param args command-line arguments passed to this process
* @returns {Protocol}
*/
export const BaseProtocol = function (args: string[]): Protocol {
const { manifest: manifestOnly = false } = parseArgs(args);
Expand All @@ -33,7 +32,6 @@ export const BaseProtocol = function (args: string[]): Protocol {
* Protocol implementation that only uses stdout, but uses message boundaries to differentiate between
* diagnostic information and hook responses.
* @param args command-line arguments passed to this process
* @returns {Protocol}
*/
export const MessageBoundaryProtocol = function (
args: string[],
Expand Down Expand Up @@ -66,7 +64,6 @@ const PROTOCOL_MAP = {
* Based on the arguments provided by the CLI to the SDK hook process, returns an appropriate Protocol interface
* for communicating with the CLI over the specified protocol.
* @param args string[] An array of strings representing the command-line flags/arguments passed to the hook
* @returns {Protocol} An object implementing the Protocol interface
*/
export const getProtocolInterface = function (args: string[]): Protocol {
const { protocol: protocolRequestedByCLI } = parseArgs(
Expand Down

0 comments on commit 8103faf

Please sign in to comment.