docs: Fix documentation of JSON config options#1627
Merged
Conversation
Shinigami92
previously approved these changes
May 29, 2026
The documentation currently shows that JSON config options should be given in camelCase. However, this is incorrect - [readJson uses the same keys as the CLI argument values](https://github.com/salsita/node-pg-migrate/blob/main/bin/node-pg-migrate.ts#L325). So for example `"migrationsDir": "migrations"` will never be applied, it should instead be `"migrations-dir": "migrations"`. It looks like this has always been the case - the old documentation mentions using the CLI argument names but this was replaced with a JSON example when the docs were rewritten in salsita#1132. I have also added an example showing the support for using different config sections and the `-config-value` flag, which is not currently documented AFAICS.
Shinigami92
approved these changes
May 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation currently shows that JSON config options should be given in camelCase.
However, this is incorrect - readJson uses the same keys as the CLI argument values.
So for example
"migrationsDir": "migrations"will never be applied, it should instead be"migrations-dir": "migrations". It looks like this has always been the case - the old documentation mentions using the CLI argument names but this was replaced with a JSON example when the docs were rewritten in #1132.I have also added an example showing the support for using different config sections and the
-config-valueflag, which is not currently documented AFAICS.