upgrade string/locale cms collection to utility functions

Author: hugur

example/content/locales/en/translations.json

@@ -1,7 +1,5 @@
 {
   "Hello": "Hello",
   "404.title": "404: Not found",
-  "404.message": "You just hit a route that doesn't exist... sadness doesn't exist only suffering does",
-  "posts.title": "Blog",
-  "tags.title": "Tags"
+  "404.message": "You just hit a route that doesn't exist... sadness doesn't exist only suffering does"
 }

example/src/cms/collections/locales.js

@@ -0,0 +1,12 @@
+import {buildLocalesCollection} from '@w3f/gatsby-theme-w3f/src/cms/collections/locales.js';
+import translations from '../../../content/locales/en/translations.json';
+
+const stringFiles = [
+    {
+        name: 'translations',
+        strings: translations,
+    }
+]
+const locales = buildLocalesCollection(stringFiles);
+
+export default locales

example/src/cms/index.js

@@ -7,22 +7,22 @@ import options from "./options";
 const netlifyCmsGitLocal = process.env.GATSBY_NETLIFY_CMS_GIT_LOCAL === "true";
 
 if (netlifyCmsGitLocal) {
-  options.config.local_backend = true;
-  options.config.backend = {
-    name: "git-gateway",
-  };
+    options.config.local_backend = true;
+    options.config.backend = {
+        name: "git-gateway",
+    };
+} else {
+    // in a real project, use a real backend
+    options.config.backend = {
+        name: 'github',
+        repo: 'organisation/project-repo',
+        branch: 'main',
+        auth_scope: 'repo',
+        open_authoring: true,
+        use_graphql: true,
+    };
 }
 
-// in a real project, use a real backend
-/* options.config.backend = {
- *   name: 'github',
- *   repo: 'organisation/project-repo',
- *   branch: 'main',
- *   auth_scope: 'repo',
- *   open_authoring: true,
- *   use_graphql: true,
- * }; */
-
 /* initialize the CMS editor-components*/
 CMS.registerEditorComponent(LinkCTA);
 

example/src/cms/options.js

@@ -1,25 +1,23 @@
-/* theme collections */
-import strings from '@w3f/gatsby-theme-w3f/src/cms/collections/strings';
+import locales from './collections/locales.js';
 
-const collections = [strings]
+const collections = [locales]
 
 const cmsOptions = {
-  config: {
-    collections: collections,
-    display_url: window.location.origin,
-    publish_mode: 'editorial_workflow',
+    config: {
+        collections,
+        display_url: window.location.origin,
 
-    // both folder values, are overwritten
-    // by some local collections config
-    media_folder: '/content/media',
-    public_folder: '/public',
+        // both folder values, are overwritten
+        // by some local collections config
+        media_folder: '/content/media',
+        public_folder: '/public',
 
-    // re-defined in ./index.js, from env (for local backend)
-    backend: {
-      name: 'test-repo',
-      branch: 'main',
+        // re-defined in ./index.js, from env (for local backend)
+        backend: {
+            name: 'test-repo',
+            branch: 'main',
+        },
     },
-  },
 };
 
 export default cmsOptions;

gatsby-theme-w3f/src/cms/collections/index.js

@@ -1,5 +1,14 @@
-import strings from './strings';
+import translations from '../../../content/locales/en/translations.json';
+import {buildLocalesCollection} from './locales';
+
+const stringFiles = [
+  {
+    name: 'translations',
+    strings: translations,
+  }
+]
+const locales = buildLocalesCollection(stringFiles);
 
 export default {
-  strings
+  locales
 };

…theme-w3f/src/cms/collections/strings.js …theme-w3f/src/cms/collections/locales.jsgatsby-theme-w3f/src/cms/collections/strings.js renamed to gatsby-theme-w3f/src/cms/collections/locales.js gatsby-theme-w3f/src/cms/collections/strings.js renamed to gatsby-theme-w3f/src/cms/collections/locales.js

@@ -1,16 +1,21 @@
-import translations from '../../../content/locales/en/translations.json';
-
-/* model-strings is the model responsible for english (en) language strings */
-
-/* List of file names (without .json extension)
+/* `stringFiles`: list of file names (without .json extension)
  * and the object with all language strings */
-const stringFiles = [
-  {
-    name: 'translations',
-    strings: translations,
-  },
-];
-
+const buildLocalesCollection = (stringFiles) => {
+  /* generate the files list and their fields
+     from the string in json files */
+  const strings = {
+    name: 'configs',
+    label: 'Locales',
+    delete: false,
+    editor: {
+      preview: false,
+    },
+    files: buildFiles(stringFiles),
+    description:
+    'Strings of text, which `value` is used to replace the `key` in the site; with the different equivalent in languages. Here is only the english content. These values are the bits of text that are not part of other content types in the cms.',
+  };
+  return strings;
+}
 /* methods to build files and fields */
 const buildFiles = files => {
   return files.map(file => {
@@ -32,18 +37,6 @@ const buildFields = fieldsJson => {
   });
 };
 
-/* generate the files list and their fields
-   from the string in json files */
-const strings = {
-  name: 'configs',
-  label: 'Strings',
-  delete: false,
-  editor: {
-    preview: false,
-  },
-  files: buildFiles(stringFiles),
-  description:
-    'Strings of text, which `value` is used to replace the `key` in the site; with the different equivalent in languages. Here is only the english content. These values are the bits of text that are not part of other content types in the cms.',
+export {
+  buildLocalesCollection
 };
-
-export default strings;