Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS]: Clarify Relativity of srcDir Option #572

Open
ITenthusiasm opened this issue Mar 5, 2024 · 0 comments
Open

[DOCS]: Clarify Relativity of srcDir Option #572

ITenthusiasm opened this issue Mar 5, 2024 · 0 comments

Comments

@ITenthusiasm
Copy link

The Problem

I just spent roughly 15-30min trying to get the pgtyped CLI to recognize my .sql files. 😅 Ultimately, the issue came down to the fact that the CLI seems to resolve srcDir relative to where the command is executed (instead of being relative to where the configuration file is located). I fixed the problem by using __dirname instead of ./.

The Solution

I think additional documentation would be super helpful here! It's so close! Perhaps we could make a minor modification for clarity:

Directory to scan or watch for query files (relative to where the pgtyped command is executed).

This would've saved me a lot of time. 😅


I know it's a small change, but I'm not able to fork and open a PR now. If you think this is a good idea and can't get to it this week, maybe I can try by the weekend? I'm assuming it would be a small change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant