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

refactor: Use serialize-javascript #954

Merged
merged 1 commit into from
Feb 21, 2021
Merged

Conversation

isaachinman
Copy link
Contributor

@isaachinman isaachinman commented Feb 21, 2021

Uses serialize-javascript to stringify a user's i18next config, which may contain primitives (like functions) that NextJs will refuse to serialise out of the box.

The config gets serialised in serverSideTranslations, and then reparsed in appWithTranslation via Function().

This allows us to maintain a next-i18next.config.js file, without requiring the user to import it themselves, or pass it as arguments into any of next-i18next's functions.

Fixes #931.

@isaachinman isaachinman merged commit ce3ca48 into next-v10 Feb 21, 2021
@isaachinman isaachinman deleted the next-v10-serialize branch February 21, 2021 16:29
@filipesmedeiros
Copy link
Contributor

Hey! I don't love "hammering" the Function call, but hey, if it's safe and it works, I'm all for it. My only question is: how do we know for sure that the config is a function and not an object, for example?

@isaachinman
Copy link
Contributor Author

@filipesmedeiros Not sure I catch your meaning – the config is an object. It also happens to contain functions, etc.

@filipesmedeiros
Copy link
Contributor

filipesmedeiros commented Feb 21, 2021

Doesn't Function only eval functions?

EDIT: Nevermind, I read the code wrong!

isaachinman added a commit that referenced this pull request Feb 24, 2021
* Core changes to support NextJs v10

* Add default config file reading functionality

* Reimplement hoistNonReactStatics

* Update dependencies

* Strip out tests and unnecessary dependencies

* Fix linting setup

* Upgrade core dependencies

* Migrate config options to mirror NextJs

* v8.0.0-beta.0

* Remove deprecated config options and types

* Update example lockfile

* Remove need for locales and defaultLocale entirely

* Update example to use hooks

* Add documentation

* v8.0.0-beta.1

* Add NodeJs v14 to CircleCI

* Create serverSideTranslations.d.ts

* v8.0.0-beta.2

* fix: TS issues for v8-beta (#922)

* fix: export appWithTranslation type

also changed AppWithTranslation type: param is a React Component, not a React Component instance

* chore: remove unused NextI18Next exports

* fix: run-example prod script by adding the build step before it

* v8.0.0-beta.3

* fix: Remove server side code from client bundle (#926)

* Remove static dir entirely

* v8.0.0-beta.4

* feat: Add an ESM entry point to allow better bundle optimizations (#937)

* Add an ESM entry point to allow better tree-shaking & module concatenation

* Include ie11

* fix: added Trans to TS definition v8-beta (#951)

* added Trans to types

* fix: removed unused typess

* refactor: Use serialize-javascript (#954)

* refactor: Use NextJs i18n config API (#955)

* test: Add tests for config and consoleMessage (#956)

* test: Add coverage for createClient (#957)

* refactor: Update eslint config (#958)

* refactor: Update eslint config

* Fix lint

* test: Add e2e coverage via Cypress (#959)

* feat: Disable FS backend when user provides one (#930)

* feat: Disable FS backend when user provides one

* fixup! feat: Disable FS backend when user provides one

* fixup! feat: Disable FS backend when user provides one

* fixup! feat: Disable FS backend when user provides one

* test: Add test coverage to appWithTranslation and serverSideTranslations (#960)

* docs: Update README (#961)

* v8.0.0-beta.5

* docs: Update README (#962)

* v8.0.0-beta.6

* chore: Update example lockfile (#964)

* chore: Update example lockfile

* Update package.json

* fix: Deep merge options.backend, closes #848 (#849)

* fix: Make create-config defaultFile use localeStructure (#966)

use @cescoallegrini modifications from
#934

* Update README.md

Co-authored-by: Léonard Drouillas <leonard.drouillas@gmail.com>

* chore: Lint examples dir (#969)

* fix: Add server side loading of fallbackLng (#970)

* refactor: Remove i18next-http-backend (#971)

* refactor: Remove i18next-http-backend

* Update config.yml

* Update basic.e2e.ts

* refactor: Add react-i18next useSuspense (#973)

* docs: Update README (#975)

* refactor: Add typeof window check to createConfig (#976)

* refactor: Remove serialize-javascript and add configOverride to appWithTranslation (#972)

* refactor: Remove serialize-javascript and add configOverride to appWithTranslation

* Add serializeConfig option

* Add docs

* Update README.md

* docs: Update README (#977)

* Update peerDependencies and version

Co-authored-by: Francesco Moro <franzmoro@users.noreply.github.com>
Co-authored-by: Felix Mosheev <9304194+felixmosh@users.noreply.github.com>
Co-authored-by: Tobias Koller <34249734+TKone7@users.noreply.github.com>
Co-authored-by: Filipe Medeiros <filipesilvamedeiros@gmail.com>
Co-authored-by: Léonard Drouillas <leonard.drouillas@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants