Improve --typechecked help text (#544)

* Improve `--typechecked` help text * Default fauna local --typechecked to true but only when --database is set --------- Co-authored-by: E. Cooper <[email protected]>
fauna · Dec 18, 2024 · 604edc2 · 604edc2
1 parent 5c01868
commit 604edc2
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 4 deletions.
diff --git a/src/commands/database/create.mjs b/src/commands/database/create.mjs
@@ -85,7 +85,7 @@ function buildCreateCommand(yargs) {
       typechecked: {
         type: "boolean",
         description:
-          "Enable typechecking for the database. Defaults to the typechecking setting of the parent database.",
+          "Enable typechecking for the database. Use --no-typechecked to disable. Defaults to enabled for top-level databases. Inherits the parent database's setting for child databases.",
       },
       protected: {
         type: "boolean",

diff --git a/src/commands/local.mjs b/src/commands/local.mjs
@@ -70,6 +70,15 @@ async function createDatabase(argv) {
       color,
     }),
   );
+
+  // In the docker container, typechecked will be false by default if not set.
+  // We need to set it to true if it's not set. We can't do it in the options,
+  // because we don't want to validate it unless --database is set.
+  let typechecked = argv.typechecked;
+  if (argv.database && argv.typechecked === undefined) {
+    typechecked = true;
+  }
+
   try {
     const db = await runQuery({
       secret: "secret",
@@ -78,7 +87,7 @@ async function createDatabase(argv) {
       let name = ${argv.database}
       let database = Database.byName(name)
       let protected = ${argv.protected ?? null}
-      let typechecked = ${argv.typechecked ?? null}
+      let typechecked = ${typechecked}
       let priority = ${argv.priority ?? null}
       if (database == null) {
         Database.create({
@@ -167,8 +176,9 @@ function buildLocalCommand(yargs) {
       },
       typechecked: {
         describe:
-          "Enable typechecking for the database. Valid only if --database is set.",
+          "Enable typechecking for the database. Use --no-typechecked to disable. Defaults to enabled. Valid only if --database is set.",
         type: "boolean",
+        default: undefined,
       },
       protected: {
         describe:
@@ -196,7 +206,7 @@ function buildLocalCommand(yargs) {
           "--interval must be greater than or equal to 0.",
         );
       }
-      if (argv.typechecked && !argv.database) {
+      if (argv.typechecked !== undefined && !argv.database) {
         throw new ValidationError(
           "--typechecked can only be set if --database is set.",
         );