Allow function type for localePath

[lucaslcode]

Fixes #1500

localePath as a function is of the form (locale: string, namespace: string, env: 'client' | 'server', missing: boolean) => string returning the entire path including filename and extension. When missing is true, return the path for the addPath option of i18next-fs-backend, when false, return the path for the loadPath option. More info at the i18next-fs-backend repo.

See comments

Tests added Wasn't sure how to add tests for the additional functionality - any guidance appreciated (maybe I should add tests for the error cases and that the function is correctly in the final config by calling it?)

[vercel]

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/isaachinman/next-i18next/26jw96b8bTAGiXYCFLEu3sdVAMRz
✅ Preview: https://next-i18next-git-fork-couchers-org-function-943f13-isaachinman.vercel.app

[lucaslcode]

Has to be const to satisfy typescript, since line 157 uses a closure.

[lucaslcode]

Additionally, it seems to me this stripping of /public on the client isn't necessary, since nothing is even read on the client - I'm not totally sure though.

[isaachinman]

Yeah, we can probably remove the stripping of /public. It's a remnant of when this package used to use i18next-http-backend by default, and used getInitialProps, necessitating client side loading of namespaces.

[isaachinman]

Thanks @lucaslcode! Just wanted to give a heads up that I am travelling now, and probably won't be able to review this until sometime in January. Rest assured I will work with you to get this merged as soon as possible.

[lucaslcode]

Thanks for the update, no worries!

…

On Tue, 28 Dec 2021, 06:07 Isaac Hinman, ***@***.***> wrote: Thanks @lucaslcode <https://github.com/lucaslcode>! Just wanted to give a heads up that I am travelling now, and probably won't be able to review this until sometime in January. Rest assured I will work with you to get this merged as soon as possible. — Reply to this email directly, view it on GitHub <#1593 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHUPIP3VCHONHVHQZCSYQQTUTDPTNANCNFSM5KTAU4XA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[isaachinman]

Thanks for your patience – finally had a chance to get to this.

Just a few comments to discuss a bit, but overall I am extremely impressed with both the quality of the code, and your ability to understand the wider repo.

Massive thanks for this contribution!

[isaachinman]

Yeah, we can probably remove the stripping of /public. It's a remnant of when this package used to use i18next-http-backend by default, and used getInitialProps, necessitating client side loading of namespaces.

[lucaslcode]

@isaachinman thanks for the review (and the compliment 😄). I've addressed the feedback, including removing the stripping of /public and therefore no longer including env: 'server' | 'client' in the callback parameters, since there isn't a use-case for it as far as I can tell.

[isaachinman]

Looks great @lucaslcode, thanks for all your help!

Weirdly this PR is not running tests in Circle – I think it's related to a CircleCI OAuth issue a couple weeks ago. Can you try rebasing against latest master? If that doesn't work, we may need to recreate the PR entirely.

[lucaslcode]

I'll try a new PR