From 9da906a1c975e6fbd250faf6479c2b40b0d11306 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 17 Dec 2024 09:42:19 -0500 Subject: [PATCH 1/4] Review help text and examples --- src/cli.mjs | 18 +++++++------- src/commands/database/create.mjs | 20 +++++++++------- src/commands/database/delete.mjs | 14 +++++++---- src/commands/local.mjs | 40 +++++++++++++++++++++----------- src/commands/login.mjs | 2 +- src/commands/query.mjs | 2 +- src/commands/schema/abandon.mjs | 3 +-- src/commands/schema/commit.mjs | 3 +-- src/commands/schema/diff.mjs | 10 ++++---- src/commands/schema/pull.mjs | 10 ++++---- src/commands/schema/push.mjs | 13 +++++------ src/commands/schema/schema.mjs | 2 +- src/commands/shell.mjs | 2 +- src/lib/command-helpers.mjs | 24 +++++++++---------- src/lib/docker-containers.mjs | 2 +- test/query.mjs | 8 +++---- test/shell.mjs | 2 +- 17 files changed, 96 insertions(+), 79 deletions(-) diff --git a/src/cli.mjs b/src/cli.mjs index 4b9d9e44..9a068cb1 100644 --- a/src/cli.mjs +++ b/src/cli.mjs @@ -122,7 +122,7 @@ function buildYargs(argvInput) { .strictCommands(true) .completion( "completion", - "Output bash/zsh script to enable shell completions. See command output for installation instructions.", + "Output a bash/zsh script for CLI auto-completions. See command output for installation instructions.", async function (currentWord, argv, defaultCompletions, done) { // this is pretty hard to debug - if you need to, run // `fauna --get-yargs-completions ` @@ -163,8 +163,7 @@ function buildYargs(argvInput) { ) .options({ color: { - description: - "Enable color formatting for the output. Uses ANSI escape codes. Enabled by default if supported by the terminal. Use `--no-color` or `--color=false` to disable.", + description: "Enable color formatting. Use --no-color to disable.", type: "boolean", // https://github.com/chalk/chalk?tab=readme-ov-file#chalklevel default: chalk.level > 0, @@ -173,15 +172,14 @@ function buildYargs(argvInput) { config: { type: "string", description: - "Path to a CLI config file to use. Use `--profile` to select a profile from the file.", + "Path to a CLI config file to use. If provided, you must specify a profile.", default: ".", group: "Config:", }, profile: { alias: "p", type: "string", - description: - "Profile from the CLI config file to use. Each profile specifies a set of CLI settings. Defaults to the 'default' profile when a config file is provided.", + description: "Profile from the CLI config file to use.", group: "Config:", }, json: { @@ -193,21 +191,21 @@ function buildYargs(argvInput) { quiet: { type: "boolean", description: - "Only output the results of the command. Useful for scripts, CI/CD, and automation workflows.", + "Suppress all log messages except fatal errors. Overrides --verbosity and --verbose-component.", default: false, group: "Output:", }, "verbose-component": { description: - "Components to emit diagnostic logs for. Takes precedence over the `--verbosity` flag. Pass components as a space-separated list, such as `--verbose-component fetch error`, or as separate flags, such as `--verbose-component fetch --verbose-component error`.", + "Components to emit logs for. Overrides the --verbosity flag. Pass values as a space-separated list. Ex: --verbose-component fetch error.", type: "array", default: [], - choices: ["fetch", "error", "config", "argv", "creds", "completion"], + choices: ["argv", "completion", "config", "creds", "error", "fetch"], group: "Debug:", }, verbosity: { description: - "Maximum verbosity level for log messages. Accepts 1 (fatal) to 5 (debug). Lower values represent more critical logs.", + "Least critical log level to emit. Accepts 1 (fatal) to 5 (debug). Lower values represent more critical logs.", type: "number", default: 0, group: "Debug:", diff --git a/src/commands/database/create.mjs b/src/commands/database/create.mjs index c15fe5e2..42c6cb93 100644 --- a/src/commands/database/create.mjs +++ b/src/commands/database/create.mjs @@ -80,7 +80,7 @@ function buildCreateCommand(yargs) { name: { type: "string", required: true, - description: "Name of the child database to create.", + description: "Name of the database to create.", }, typechecked: { type: "boolean", @@ -100,19 +100,23 @@ function buildCreateCommand(yargs) { .check(validateDatabaseOrSecret) .example([ [ - "$0 database create --name my_database --database us/example", - "Create a database named 'my_database' directly under 'us/example'.", + "$0 database create --name example --database us", + "Create the top-level 'example' database in the 'us' Region Group.", ], [ - "$0 database create --name my_database --secret my-secret", - "Create a database named 'my_database' directly under the database scoped to a secret.", + "$0 database create --name my_db --database us/example", + "Create the 'my_db' child database directly under 'us/example'.", ], [ - "$0 database create --name my_database --database us/example --typechecked", + "$0 database create --name my_db --secret my-secret", + "Create the 'my_db' child database directly under the database scoped to a secret.", + ], + [ + "$0 database create --name example --database us --typechecked", "Create a database with typechecking enabled.", ], [ - "$0 database create --name my_database --database us/example --protected", + "$0 database create --name example --database us --protected", "Create a database with protected mode enabled.", ], ]); @@ -120,7 +124,7 @@ function buildCreateCommand(yargs) { export default { command: "create", - description: "Create a child database.", + description: "Create a database.", builder: buildCreateCommand, handler: createDatabase, }; diff --git a/src/commands/database/delete.mjs b/src/commands/database/delete.mjs index 6d8e34b4..07293101 100644 --- a/src/commands/database/delete.mjs +++ b/src/commands/database/delete.mjs @@ -56,19 +56,23 @@ function buildDeleteCommand(yargs) { .check(validateDatabaseOrSecret) .example([ [ - "$0 database delete --name my_database --database us/example", - "Delete a database named 'my_database' directly under 'us/example'.", + "$0 database delete --name example --database us", + "Delete the top-level 'example' database in the 'us' Region Group.", ], [ - "$0 database delete --name my_database --secret my-secret", - "Delete a database named 'my_database' directly under the database scoped to a secret.", + "$0 database delete --name my_db --database us/example", + "Delete the 'my_db' child database directly under 'us/example'.", + ], + [ + "$0 database delete --name my_db --secret my-secret", + "Delete the 'my_db' child database directly under the database scoped to a secret.", ], ]); } export default { command: "delete", - description: "Delete a child database.", + description: "Delete a database.", builder: buildDeleteCommand, handler: deleteDatabase, }; diff --git a/src/commands/local.mjs b/src/commands/local.mjs index a143ae03..ec87683f 100644 --- a/src/commands/local.mjs +++ b/src/commands/local.mjs @@ -124,35 +124,35 @@ function buildLocalCommand(yargs) { return yargs .options({ "container-port": { - describe: "The port inside the container Fauna listens on.", + describe: "Port inside the container Fauna listens on.", type: "number", default: 8443, }, "host-port": { describe: - "The port on the host machine mapped to the container's port. This is the port you'll connect to Fauna on.", + "Port on the host machine mapped to the container's port. Clients send requests to Fauna on this port.", type: "number", default: 8443, }, "host-ip": { - describe: `The IP address to bind the container's exposed port on the host.`, + describe: `IP address to bind to the container's exposed port on the host.`, type: "string", default: "0.0.0.0", }, interval: { describe: - "The interval (in milliseconds) between health check attempts. Determines how often the CLI checks if the Fauna container is ready.", + "Interval, in milliseconds, between health check attempts. How often the CLI checks if the container is ready.", type: "number", default: 10000, }, "max-attempts": { describe: - "The maximum number of health check attempts before declaring the start Fauna continer process as failed.", + "Maximum number of health check attempts allowed before container startup fails.", type: "number", default: 100, }, name: { - describe: "The name to give the container.", + describe: "Name for the container.", type: "string", default: "faunadb", }, @@ -162,8 +162,7 @@ function buildLocalCommand(yargs) { default: true, }, database: { - describe: - "The name of a database to create in the container. Omit to create no database.", + describe: "Name of the database to create. Omit to create no database.", type: "string", }, typechecked: { @@ -185,17 +184,16 @@ function buildLocalCommand(yargs) { type: "string", alias: ["dir", "directory"], description: - "Path to a local directory containing `.fsl` files for the database. Valid only if --database is set.", + "Path to a local directory containing .fsl files for the database. Valid only if --database is set.", }, active: { description: - "Immediately applies the local schema to the database's active schema, skipping staging the schema. To disable this, use `--no-active` or `--active=false`.", + "Apply the local schema to the database's active schema. Skips staging the schema. Use --no-active to disable.", type: "boolean", default: true, }, input: { - description: - "Prompt for schema input, such as confirmation. To disable prompts, use `--no-input` or `--input=false`. Disabled prompts are useful for scripts, CI/CD, and automation workflows.", + description: "Prompt for input. Use --no-input to disable.", default: true, type: "boolean", }, @@ -230,7 +228,23 @@ function buildLocalCommand(yargs) { ); } return true; - }); + }) + .example([ + ["$0 local", "Start a Fauna container with default name and ports."], + ["$0 local --name local-fauna", "Start a container named 'local-fauna'."], + [ + "$0 local --host-port 123 --container-port 6789", + "Map host port `1234` to container port `6789`.", + ], + [ + "$0 local --database example", + "Start a local Fauna container with the 'example' database.", + ], + [ + "$0 local --database example --dir /path/to/schema/dir", + "Start a local Fauna container with a database with specified schema.", + ], + ]); } export default { diff --git a/src/commands/login.mjs b/src/commands/login.mjs index 610b29d3..df416022 100644 --- a/src/commands/login.mjs +++ b/src/commands/login.mjs @@ -53,7 +53,7 @@ function buildLoginCommand(yargs) { export default { command: "login", - describe: "Log in to Fauna using a web-based browser flow.", + describe: "Log in to Fauna.", builder: buildLoginCommand, handler: doLogin, }; diff --git a/src/commands/query.mjs b/src/commands/query.mjs index 9538af28..345f730a 100644 --- a/src/commands/query.mjs +++ b/src/commands/query.mjs @@ -152,7 +152,7 @@ function buildQueryCommand(yargs) { return yargsWithCommonConfigurableQueryOptions(yargs) .positional("fql", { type: "string", - description: "FQL query to run. Use `-` to read from stdin.", + description: "FQL query to run. Use - to read from stdin.", }) .nargs("fql", 1) .options({ diff --git a/src/commands/schema/abandon.mjs b/src/commands/schema/abandon.mjs index 835abcd2..c4304cc5 100644 --- a/src/commands/schema/abandon.mjs +++ b/src/commands/schema/abandon.mjs @@ -68,8 +68,7 @@ function buildAbandonCommand(yargs) { return yargsWithCommonQueryOptions(yargs) .options({ input: { - description: - "Prompt for input, such as confirmation. To disable prompts, use `--no-input` or `--input=false`. Disabled prompts are useful for scripts, CI/CD, and automation workflows.", + description: "Prompt for input. Use --no-input to disable.", default: true, type: "boolean", }, diff --git a/src/commands/schema/commit.mjs b/src/commands/schema/commit.mjs index 01132fab..0bf93eed 100644 --- a/src/commands/schema/commit.mjs +++ b/src/commands/schema/commit.mjs @@ -72,8 +72,7 @@ function buildCommitCommand(yargs) { return yargsWithCommonQueryOptions(yargs) .options({ input: { - description: - "Prompt for input, such as confirmation. To disable prompts, use `--no-input` or `--input=false`. Disabled prompts are useful for scripts, CI/CD, and automation workflows.", + description: "Prompt for input. Use --no-input to disable.", default: true, type: "boolean", }, diff --git a/src/commands/schema/diff.mjs b/src/commands/schema/diff.mjs index 10c4ead7..572846c5 100644 --- a/src/commands/schema/diff.mjs +++ b/src/commands/schema/diff.mjs @@ -132,23 +132,23 @@ function buildDiffCommand(yargs) { }) .example([ [ - "$0 schema diff --database us/example --dir /path/to/schema", + "$0 schema diff --database us/example --dir /path/to/schema/dir", "Compare the 'us/example' database's staged schema to the local schema. If no schema is staged, compare the database's active schema to the local schema.", ], [ - "$0 schema diff --database us/example --dir /path/to/schema --active", + "$0 schema diff --database us/example --dir /path/to/schema/dir --active", "Compare the 'us/example' database's active schema to the local schema.", ], [ - "$0 schema diff --secret my-secret --dir /path/to/schema --active", + "$0 schema diff --secret my-secret --dir /path/to/schema/dir --active", "Compare the active schema of the database scoped to a secret to the local schema.", ], [ - "$0 schema diff --database us/example --dir /path/to/schema --staged", + "$0 schema diff --database us/example --dir /path/to/schema/dir --staged", "Compare the 'us/example' database's active schema to its staged schema.", ], [ - "$0 schema diff --database us/example --dir /path/to/schema --text", + "$0 schema diff --database us/example --dir /path/to/schema/dir --text", "Show a text diff instead of a semantic diff.", ], ]); diff --git a/src/commands/schema/pull.mjs b/src/commands/schema/pull.mjs index e8ca6c66..a9ca1c43 100644 --- a/src/commands/schema/pull.mjs +++ b/src/commands/schema/pull.mjs @@ -152,20 +152,20 @@ function buildPullCommand(yargs) { }) .example([ [ - "$0 schema pull --database us/example --dir /path/to/schema", + "$0 schema pull --database us/example --dir /path/to/schema/dir", "Pull the 'us/example' database's staged schema.", ], [ - "$0 schema pull --secret my-secret --dir /path/to/schema", + "$0 schema pull --secret my-secret --dir /path/to/schema/dir", "Pull the staged schema for the database scoped to a secret.", ], [ - "$0 schema pull --database us/example --dir /path/to/schema --active", + "$0 schema pull --database us/example --dir /path/to/schema/dir --active", "Pull the 'us/example' database's active schema.", ], [ - "$0 schema pull --database us/example --dir /path/to/schema --delete", - "Delete `.fsl` files in the local directory that are not part of the pulled schema.", + "$0 schema pull --database us/example --dir /path/to/schema/dir --delete", + "Delete .fsl files in the local directory that are not part of the pulled schema.", ], ]); } diff --git a/src/commands/schema/push.mjs b/src/commands/schema/push.mjs index e87ec3bf..2b07c5f7 100644 --- a/src/commands/schema/push.mjs +++ b/src/commands/schema/push.mjs @@ -101,14 +101,13 @@ function buildPushCommand(yargs) { return yargsWithCommonQueryOptions(yargs) .options({ input: { - description: - "Prompt for input, such as confirmation. To disable prompts, use `--no-input` or `--input=false`. Disabled prompts are useful for scripts, CI/CD, and automation workflows.", + description: "Prompt for input. Use --no-input to disable.", default: true, type: "boolean", }, active: { description: - "Immediately apply the local schema to the database's active schema. Skips staging the schema. Can result in temporarily unavailable indexes.", + "Apply the local schema to the database's active schema. Can result in temporarily unavailable indexes.", type: "boolean", default: false, }, @@ -116,19 +115,19 @@ function buildPushCommand(yargs) { }) .example([ [ - "$0 schema push --database us/example --dir /path/to/schema", + "$0 schema push --database us/example --dir /path/to/schema/dir", "Stage schema changes for the 'us/example' database. If schema is already staged, replace the staged schema.", ], [ - "$0 schema push --secret my-secret --dir /path/to/schema", + "$0 schema push --secret my-secret --dir /path/to/schema/dir", "Stage schema changes for the database scoped to a secret. If schema is already staged, replace the staged schema.", ], [ - "$0 schema push --database us/example --dir /path/to/schema --active", + "$0 schema push --database us/example --dir /path/to/schema/dir --active", "Immediately apply changes to the 'us/example' database's active schema.", ], [ - "$0 schema push --database us/example --dir /path/to/schema --no-input", + "$0 schema push --database us/example --dir /path/to/schema/dir --no-input", "Run the command without input prompts.", ], ]); diff --git a/src/commands/schema/schema.mjs b/src/commands/schema/schema.mjs index e2d22dda..74f8488d 100644 --- a/src/commands/schema/schema.mjs +++ b/src/commands/schema/schema.mjs @@ -13,7 +13,7 @@ export const localSchemaOptions = { alias: ["directory", "dir"], type: "string", description: - "Path to a local directory containing `.fsl` files for the database.", + "Path to a local directory containing .fsl files for the database.", default: ".", }, }; diff --git a/src/commands/shell.mjs b/src/commands/shell.mjs index 2f338414..c98c2268 100644 --- a/src/commands/shell.mjs +++ b/src/commands/shell.mjs @@ -118,7 +118,7 @@ async function shellCommand(argv) { }, { cmd: "toggleInfo", - help: "Enable or disable the query info fields of the API response. Disabled by default. If enabled, outputs the included fields of the API response.", + help: "Enable or disable output of --include info. Disabled by default.", action: () => { shell.context.include = shell.context.include.length === 0 diff --git a/src/lib/command-helpers.mjs b/src/lib/command-helpers.mjs index 8d522a08..bd997740 100644 --- a/src/lib/command-helpers.mjs +++ b/src/lib/command-helpers.mjs @@ -32,34 +32,34 @@ const COMMON_QUERY_OPTIONS = { alias: "u", type: "string", description: - "User used to run the command. You must first log in as the user using `fauna login`.", + "CLI user to run the command as. You must first log in as the user using 'fauna login'.", default: "default", group: "API:", }, local: { type: "boolean", describe: - 'Use a local Fauna container. If not otherwise specified, sets `--url` to http://localhost:8443 and `--secret` to "secret".', + "Use a local Fauna container. Sets --url to 'http://0.0.0.0:8443' and --secret to 'secret'.", default: false, group: "API:", }, url: { type: "string", description: - "URL for Fauna Core HTTP API requests made by the command. Defaults to https://db.fauna.com.", + "URL for Core HTTP API requests made by the command. Defaults to https://db.fauna.com.", group: "API:", }, secret: { type: "string", description: - "Authentication secret for Fauna Core HTTP API requests made by the command. Mutually exclusive with `--database` and `--role`.", + "Secret used for authentication. Can't be used with --database or --role.", required: false, group: "API:", }, "account-key": { type: "string", description: - "Fauna account key used for authentication. Negates the need for a user login. The key is used to generate short-lived database secrets for the CLI. Mutually exclusive with `--user` and `--secret`.", + "Fauna account key used for authentication. Can't be used with --user or --secret.", required: false, group: "API:", }, @@ -67,14 +67,13 @@ const COMMON_QUERY_OPTIONS = { alias: "d", type: "string", description: - "Path, including Region Group identifier and hierarchy, for the database to run the command in. Mutually exclusive with `--secret`.", + "Database, including Region Group and hierarchy, to run the command in. Ex: 'us/my_db', 'eu/parent_db/child_db', 'global/db'. Can't be used with --secret.", group: "API:", }, role: { alias: "r", type: "string", - description: - "Role used to run the command. Mutually exclusive with `--secret`.", + description: "Role used to run the command. Can't be used with --secret.", group: "API:", }, }; @@ -118,14 +117,14 @@ const COMMON_CONFIGURABLE_QUERY_OPTIONS = { timeout: { type: "number", description: - "Maximum runtime, in milliseconds, for Fauna Core HTTP API requests made by the command.", + "Maximum query runtime in milliseconds. Only applies to v10 queries.", default: 5000, group: "API:", }, - performanceHints: { + "performance-hints": { type: "boolean", description: - "Output the performance hints for the current query or nothing when no hints are available. Only applies to v10 queries. Sets '--include summary'", + "Output performance hints. Sets --include summary. Only applies to v10 queries. If no performance hints are returned, no hints are output.", default: false, group: "API:", }, @@ -133,7 +132,8 @@ const COMMON_CONFIGURABLE_QUERY_OPTIONS = { type: "array", choices: ["all", "none", ...QUERY_INFO_CHOICES], default: ["summary"], - describe: "Include additional query response data in the output.", + describe: + "Query response info to output. Pass values as a space-separated list. Ex: --include summary queryTags.", }, }; diff --git a/src/lib/docker-containers.mjs b/src/lib/docker-containers.mjs index 23fd99e1..dc8b039c 100644 --- a/src/lib/docker-containers.mjs +++ b/src/lib/docker-containers.mjs @@ -14,7 +14,7 @@ let color = false; * @param {number} options.containerPort The port inside the container Fauna listens on * @param {boolean} options.pull Whether to pull the latest image * @param {number} [options.interval] The interval (in milliseconds) between health check attempts - * @param {number} [options.maxAttempts] The maximum number of health check attempts before declaring the start Fauna continer process as failed + * @param {number} [options.maxAttempts] The maximum number of health check attempts before declaring the start Fauna container process as failed * @returns {Promise} */ export async function ensureContainerRunning({ diff --git a/test/query.mjs b/test/query.mjs index 1c9ca24f..ac2e72e6 100644 --- a/test/query.mjs +++ b/test/query.mjs @@ -307,9 +307,9 @@ describe("query", function () { ); }); - it("can set the performanceHints option to true", async function () { + it("can set the performance-hints option to true", async function () { await run( - `query "Database.all()" --performanceHints --secret=foo`, + `query "Database.all()" --performance-hints --secret=foo`, container, ); expect(runQueryFromString).to.have.been.calledWith( @@ -332,7 +332,7 @@ describe("query", function () { }); await run( - `query "Database.all()" --performanceHints --secret=foo`, + `query "Database.all()" --performance-hints --secret=foo`, container, ); @@ -352,7 +352,7 @@ describe("query", function () { }); await run( - `query "Database.all()" --performanceHints --secret=foo --include none`, + `query "Database.all()" --performance-hints --secret=foo --include none`, container, ); diff --git a/test/shell.mjs b/test/shell.mjs index f30959c6..22acfc17 100644 --- a/test/shell.mjs +++ b/test/shell.mjs @@ -364,7 +364,7 @@ describe("shell", function () { }); const runPromise = run( - `shell --secret "secret" --performanceHints --no-color --format json`, + `shell --secret "secret" --performance-hints --no-color --format json`, container, ); From db872cdfe83cee1a1721a9034578b2f49b2805df Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 17 Dec 2024 12:26:30 -0500 Subject: [PATCH 2/4] Align README with updated help --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18c9babc..170ac140 100644 --- a/README.md +++ b/README.md @@ -53,8 +53,8 @@ To get started: fauna login ``` -4. Run CLI commands. Specify a `--database` path, including the [Region Group - identifier](https://docs.fauna.com/fauna/current/manage/region-groups/#id) and +4. Run CLI commands. Specify a `--database`, including the [Region + Group](https://docs.fauna.com/fauna/current/manage/region-groups/#id) and hierarchy, to run the command in. For example: ```shell From 9322c5bd368087628ffee6d6c26f14f040e86743 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 17 Dec 2024 12:59:16 -0500 Subject: [PATCH 3/4] Fix bad merge --- test/query.mjs | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/test/query.mjs b/test/query.mjs index a8cad801..b3fbf3ba 100644 --- a/test/query.mjs +++ b/test/query.mjs @@ -308,9 +308,9 @@ describe("query", function () { ); }); - it("can set the performance-hints option to true", async function () { + it("can set the performanceHints option to true", async function () { await run( - `query "Database.all()" --performance-hints --secret=foo`, + `query "Database.all()" --performanceHints --secret=foo`, container, ); expect(runQueryFromString).to.have.been.calledWith( @@ -343,10 +343,12 @@ describe("query", function () { expect(logger.stdout).to.have.been.calledWith(sinon.match(/fql/)); }); - await run( - `query "Database.all()" --performance-hints --secret=foo`, - container, - ); + it("still displays performance hints if '--include none' is used", async function () { + runQueryFromString.resolves({ + summary: + "performance_hint: use a more efficient query\n1 | use a more efficient query", + data: "fql", + }); await run( `query "Database.all()" --performanceHints --secret=foo --include none`, @@ -363,10 +365,15 @@ describe("query", function () { expect(logger.stdout).to.have.been.calledWith(sinon.match(/fql/)); }); - await run( - `query "Database.all()" --performance-hints --secret=foo --include none`, - container, - ); + it("does not display anything if info fields are empty", async function () { + runQueryFromString.resolves({ + txn_ts: "", + schema_version: "", + summary: "", + query_tags: "", + stats: "", + data: "fql", + }); await run(`query "test" --secret=foo --include all`, container); From 8636d4571624397e07d5650581baf19a814ae2c8 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 17 Dec 2024 13:06:55 -0500 Subject: [PATCH 4/4] Re-add kebab case --- test/query.mjs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/test/query.mjs b/test/query.mjs index b3fbf3ba..40a54ce2 100644 --- a/test/query.mjs +++ b/test/query.mjs @@ -310,7 +310,7 @@ describe("query", function () { it("can set the performanceHints option to true", async function () { await run( - `query "Database.all()" --performanceHints --secret=foo`, + `query "Database.all()" --performance-hints --secret=foo`, container, ); expect(runQueryFromString).to.have.been.calledWith( @@ -329,7 +329,7 @@ describe("query", function () { }); await run( - `query "Database.all()" --performanceHints --secret=foo`, + `query "Database.all()" --performance-hints --secret=foo`, container, ); @@ -351,7 +351,7 @@ describe("query", function () { }); await run( - `query "Database.all()" --performanceHints --secret=foo --include none`, + `query "Database.all()" --performance-hints --secret=foo --include none`, container, );