Allow '*' for common namespaces declaration (#28)

* Allow '*' for common namespaces declaration * Update package.json
aralroca · Dec 29, 2019 · b40046d · b40046d
1 parent e4aaf8e
commit b40046d
Show file tree

Hide file tree

Showing 8 changed files with 5,863 additions and 127 deletions.
diff --git a/README.md b/README.md
@@ -127,8 +127,9 @@ For a static site you should add a configuration file `i18n.json` in the root of
  "finalPagesDir": "pages",
  "localesPath": "locales",
  "pages": {
- "/": ["common", "home"],
- "/about": ["common", "about"]
+ "*": ["common"],
+ "/": ["home", "example"],
+ "/about": ["about"]
  }
 }
 ```
@@ -279,7 +280,7 @@ In order to use each translation in the project, use the _translation id_ compos
 | `finalPagesDir` | A string with the directory that is going to be used to build the pages. Only "pages" and "src/pages" are possible. IT ONLY APPLIES in static sites. If you use the `appWithI18n` this configuration won't have any effect. | `string` | `"pages"` |
 | `localesPath` | A string with the directory of JSONs locales. THIS ONLY WORKS with static sites. If you use the `appWithI18n` then you should use the `loadLocaleFrom` config. | `string` | `"locales"` |
 | `loadLocaleFrom` | A function to return the dynamic import of each locale. IT ONLY WORKS with a server (`appWithI18n`). For static site use the `localesPath` instead. [See an example](#use-translations-in-your-pages-1) | `Function` | `null` |
-| `pages` | An object that defines the namespaces used in each page. Example of object: `{"/": ["common", "home"]}`. This configuration is for both: static sites and with a server.   | `Object<Array<string>>` | `{}` |
+| `pages` | An object that defines the namespaces used in each page. Example of object: `{"/": ["home", "example"]}`. This configuration is for both: static sites and with a server. To add namespaces to all pages you should use the key `"*"`, ex: `{"*": ["common"]}`. | `Object<Array<string>>` | `{}` |
 
 ## 6. API
 

diff --git a/cli/builder.js b/cli/builder.js
@@ -52,7 +52,7 @@ function readPageNamespaces(langs) {
  .replace(currentPagesDir, '')
  .replace(/(\/index.js)|(\/index.jsx)|(\.js)|(\.jsx)/gm, '') || '/'
 
- const namespaces = pages[pageId] || []
+ const namespaces = [...(pages['*'] || []), ...(pages[pageId] || [])]
 
  if (!isNextInternal(page)) {
  console.log(`🔨 ${pageId}`, namespaces)

diff --git a/examples/static-site/i18n.json b/examples/static-site/i18n.json
@@ -2,8 +2,8 @@
  "allLanguages": ["en", "ca", "es"],
  "defaultLanguage": "en",
  "pages": {
- "/": ["common", "home"],
- "/more-examples": ["common", "more-examples"],
- "/more-examples/dynamic-namespace": ["common"]
+ "*": ["common"],
+ "/": ["home"],
+ "/more-examples": ["more-examples"]
  }
 }
diff --git a/examples/with-server/i18n.js b/examples/with-server/i18n.js
@@ -5,8 +5,8 @@ module.exports = {
  loadLocaleFrom: (lang, ns) =>
  import(`./locales/${lang}/${ns}.json`).then(m => m.default),
  pages: {
- '/': ['common', 'home'],
- '/more-examples': ['common', 'more-examples'],
- '/more-examples/dynamic-namespace': ['common'],
+ '*': ['common'],
+ '/': ['home'],
+ '/more-examples': ['more-examples'],
  },
 }
diff --git a/examples/with-server/yarn.lock b/examples/with-server/yarn.lock
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "next-translate",
- "version": "0.1.8",
+ "version": "0.2.0",
  "description": "Next.js utility to translate pages without the need of a server (static i18n pages generator).",
  "license": "MIT",
  "keywords": [
@@ -38,9 +38,9 @@
  "next-translate": "./cli/builder.js"
  },
  "devDependencies": {
- "@babel/cli": "7.7.5",
- "@babel/core": "7.7.5",
- "@babel/preset-env": "7.7.6",
+ "@babel/cli": "7.7.7",
+ "@babel/core": "7.7.7",
+ "@babel/preset-env": "7.7.7",
  "@testing-library/react": "9.4.0",
  "babel-jest": "24.9.0",
  "babel-plugin-transform-es2015-modules-commonjs": "6.26.2",

diff --git a/src/appWithI18n.js b/src/appWithI18n.js
@@ -33,13 +33,16 @@ export default function appWithI18n(AppToTranslate, config = {}) {
  let appProps = { pageProps: {} }
 
  if (AppToTranslate.getInitialProps) {
- appProps = (await AppToTranslate.getInitialProps({
- Component, ctx, lang
- })) || {}
+ appProps =
+ (await AppToTranslate.getInitialProps({
+ Component,
+ ctx,
+ lang,
+ })) || {}
  }
  const page = removeTrailingSlash(ctx.pathname)
  const { pages = {} } = config
- const namespaces = pages[page] || []
+ const namespaces = [...(pages['*'] || []), ...(pages[page] || [])]
  const pageNamespaces = await Promise.all(
  namespaces.map(ns =>
  typeof config.loadLocaleFrom === 'function'