chore: rename option --dump-schema to --dump-schema-cache

PostgREST · May 12, 2024 · cce425e · cce425e
1 parent 2529098
commit cce425e
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,6 +26,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
  - #3248, Add more config examples to CLI - @taimoorzaeem
    + Now accepts ``--example-file``, ``--example-db``, and ``--example-env``
    + Replace ``-e`` and ``--example`` with ``--example-file``
+   + Rename option ``--dump-schema`` to ``--dump-schema-cache``
 
 ### Fixed
 

diff --git a/docs/references/cli.rst b/docs/references/cli.rst
@@ -43,6 +43,6 @@ Schema Cache
 
 .. code:: bash
 
-  $ postgrest [--dump-schema] [FILENAME]
+  $ postgrest [--dump-schema-cache] [FILENAME]
 
 Here ``FILENAME`` is the path to configuration file.
diff --git a/nix/tools/tests.nix b/nix/tools/tests.nix
@@ -119,7 +119,7 @@ let
   dumpSchema =
     checkedShellScript
       {
-        name = "postgrest-dump-schema";
+        name = "postgrest-dump-schema-cache";
         docs = "Dump the loaded schema's SchemaCache in JSON format.";
         workingDir = "/";
         withEnv = postgrest.env;
@@ -128,7 +128,7 @@ let
       ''
         ${withTools.withPg} -f test/spec/fixtures/load.sql \
             ${cabal-install}/bin/cabal v2-run ${devCabalOptions} --verbose=0 -- \
-            postgrest --dump-schema
+            postgrest --dump-schema-cache
       '';
 
   coverage =

diff --git a/src/PostgREST/CLI.hs b/src/PostgREST/CLI.hs
@@ -44,7 +44,7 @@ main CLI{cliCommand, cliPath} = do
       CmdDumpConfig -> do
         when configDbConfig $ AppState.reReadConfig True appState
         putStr . Config.toText =<< AppState.getConfig appState
-      CmdDumpSchema -> putStrLn =<< dumpSchema appState
+      CmdDumpSchemaCache -> putStrLn =<< dumpSchema appState
       CmdRun -> App.run appState)
 
 -- | Dump SchemaCache schema to JSON
@@ -70,7 +70,7 @@ data CLI = CLI
 data Command
   = CmdRun
   | CmdDumpConfig
-  | CmdDumpSchema
+  | CmdDumpSchemaCache
 
 data Example = ExampleFile | ExampleDb | ExampleEnv
 
@@ -115,7 +115,7 @@ readCLIShowHelp =
     cliParser :: O.Parser CLI
     cliParser =
       CLI
-        <$> (dumpConfigFlag <|> dumpSchemaFlag)
+        <$> (dumpConfigFlag <|> dumpSchemaCacheFlag)
         <*> O.optional configFileOption
 
     configFileOption =
@@ -128,9 +128,9 @@ readCLIShowHelp =
         O.long "dump-config"
         <> O.help "Dump loaded configuration and exit"
 
-    dumpSchemaFlag =
-      O.flag CmdRun CmdDumpSchema $
-        O.long "dump-schema"
+    dumpSchemaCacheFlag =
+      O.flag CmdRun CmdDumpSchemaCache $
+        O.long "dump-schema-cache"
         <> O.help "Dump loaded schema as JSON and exit (for debugging, output structure is unstable)"
 
 exampleConfig :: Example -> [Char]

diff --git a/test/io/fixtures.yaml b/test/io/fixtures.yaml
@@ -17,7 +17,7 @@ cli:
   - name: dump config
     args: ['--dump-config']
   - name: dump schema
-    args: ['--dump-schema']
+    args: ['--dump-schema-cache']
     use_defaultenv: true
   - name: no config
 # failures: config files

diff --git a/test/io/test_cli.py b/test/io/test_cli.py
@@ -261,7 +261,9 @@ def test_invalid_openapi_mode(invalidopenapimodes, defaultenv):
 def test_schema_cache_snapshot(baseenv, key, snapshot_yaml):
     "Dump of schema cache should match snapshot."
 
-    schema_cache = yaml.load(cli(["--dump-schema"], env=baseenv), Loader=yaml.Loader)
+    schema_cache = yaml.load(
+        cli(["--dump-schema-cache"], env=baseenv), Loader=yaml.Loader
+    )
     formatted = yaml.dump(
         schema_cache[key],
         encoding="utf8",