i18n support for file collections - closes #4483

dev-test/config.yml

@@ -6,6 +6,11 @@ site_url: https://example.com
 publish_mode: editorial_workflow
 media_folder: assets/uploads
 
+i18n:
+  structure: multiple_files
+  locales: [en, sv]
+  default_locale: en
+
 collections: # A list of collections the CMS should be able to edit
   - name: 'posts' # Used in routes, ie.: /admin/collections/:slug/edit
     label: 'Posts' # Used in the UI
@@ -259,3 +264,106 @@ collections: # A list of collections the CMS should be able to edit
               - { label: 'Date', name: 'date', widget: 'date' }
               - { label: 'Image', name: 'image', widget: 'image' }
               - { label: 'File', name: 'file', widget: 'file' }
+
+  - name: 'i18n_posts' # Used in routes, ie.: /admin/collections/:slug/edit
+    label: 'i18n Posts' # Used in the UI
+    label_singular: 'i18n Post' # Used in the UI, ie: "New Post"
+    description: >
+      The description is a great place for tone setting, high level information, and editing
+      guidelines that are specific to a collection.
+    folder: '_i18n_posts'
+    slug: '{{year}}-{{month}}-{{day}}-{{slug}}'
+    summary: '{{title}} -- {{year}}/{{month}}/{{day}}'
+    create: true # Allow users to create new documents in this collection
+    i18n:
+      structure: single_file
+    view_filters:
+      - label: Posts With Index
+        field: title
+        pattern: 'This is post #'
+      - label: Posts Without Index
+        field: title
+        pattern: front matter post
+      - label: Drafts
+        field: draft
+        pattern: true
+
+    fields: # The fields each document in this collection have
+      - { label: 'Title', name: 'title', widget: 'string', tagname: 'h1', i18n: true }
+      - { label: 'Draft', name: 'draft', widget: 'boolean', default: false, i18n: true }
+      - {
+          label: 'Publish Date',
+          name: 'date',
+          widget: 'datetime',
+          date_format: 'YYYY-MM-DD',
+          time_format: 'HH:mm',
+          format: 'YYYY-MM-DD HH:mm',
+          i18n: duplicate,
+        }
+      - label: 'Cover Image'
+        name: 'image'
+        widget: 'image'
+        required: false
+        tagname: ''
+        i18n: duplicate
+
+      - {
+          label: 'Body',
+          name: 'body',
+          widget: 'markdown',
+          hint: 'Main content goes here.',
+          i18n: true,
+        }
+
+  - name: 'i18n_settings'
+    label: 'i18n Settings'
+    delete: false # Prevent users from deleting documents in this collection
+    editor:
+      preview: false
+    i18n:
+      structure: single_file
+    files:
+      - name: 'general'
+        label: 'Site Settings'
+        file: '_i18n_data/settings.json'
+        description: 'General Site Settings'
+        i18n: true
+        fields:
+          - { label: 'Global title', name: 'site_title', widget: 'string', i18n: true }
+          - label: 'Post Settings'
+            name: posts
+            widget: 'object'
+            i18n: true
+            fields:
+              - {
+                  label: 'Number of posts on frontpage',
+                  name: front_limit,
+                  widget: number,
+                  min: 1,
+                  max: 10,
+                  i18n: true,
+                }
+              - { label: 'Default Author', name: author, widget: string, i18n: true }
+              - {
+                  label: 'Default Thumbnail',
+                  name: thumb,
+                  widget: image,
+                  class: 'thumb',
+                  required: false,
+                  i18n: true,
+                }
+
+      - name: 'authors'
+        label: 'Authors'
+        file: '_i18n_data/authors.yml'
+        description: 'Author descriptions'
+        i18n: true
+        fields:
+          - name: authors
+            label: Authors
+            label_singular: 'Author'
+            widget: list
+            i18n: true
+            fields:
+              - { label: 'Name', name: 'name', widget: 'string', hint: 'First and Last' }
+              - { label: 'Description', name: 'description', widget: 'markdown' }

packages/netlify-cms-core/src/actions/__tests__/config.spec.js

@@ -636,7 +636,7 @@ describe('config', () => {
         ).toEqual({ structure: 'multiple_folders', locales: ['en', 'fr'], default_locale: 'fr' });
       });
 
-      it('should throw when i18n is set on files collection', () => {
+      it('should throw when i18n structure is not single_file on files collection', () => {
         expect(() =>
           applyDefaults(
             fromJS({
@@ -654,7 +654,77 @@ describe('config', () => {
               ],
             }),
           ),
-        ).toThrow('i18n configuration is not supported for files collection');
+        ).toThrow('i18n configuration for files collections is limited to single_file structures');
+      });
+
+      it('should throw when i18n structure is set to multiple_folders and contains a single file collection', () => {
+        expect(() =>
+          applyDefaults(
+            fromJS({
+              i18n: {
+                structure: 'multiple_folders',
+                locales: ['en', 'de'],
+              },
+              collections: [
+                {
+                  files: [
+                    { name: 'file', file: 'file', fields: [{ name: 'title', widget: 'string' }] },
+                  ],
+                  i18n: true,
+                },
+              ],
+            }),
+          ),
+        ).toThrow('i18n configuration for files collections is limited to single_file structures');
+      });
+
+      it('should throw when i18n structure is set to multiple_files and contains a single file collection', () => {
+        expect(() =>
+          applyDefaults(
+            fromJS({
+              i18n: {
+                structure: 'multiple_files',
+                locales: ['en', 'de'],
+              },
+              collections: [
+                {
+                  files: [
+                    { name: 'file', file: 'file', fields: [{ name: 'title', widget: 'string' }] },
+                  ],
+                  i18n: true,
+                },
+              ],
+            }),
+          ),
+        ).toThrow('i18n configuration for files collections is limited to single_file structures');
+      });
+
+      it('should set i18n value to translate on field when i18n=true for field in files collection', () => {
+        expect(
+          applyDefaults(
+            fromJS({
+              i18n: {
+                structure: 'multiple_folders',
+                locales: ['en', 'de'],
+              },
+              collections: [
+                {
+                  files: [
+                    {
+                      name: 'file',
+                      file: 'file',
+                      i18n: true,
+                      fields: [{ name: 'title', widget: 'string', i18n: true }],
+                    },
+                  ],
+                  i18n: {
+                    structure: 'single_file',
+                  },
+                },
+              ],
+            }),
+          ).getIn(['collections', 0, 'files', 0, 'fields', 0, 'i18n']),
+        ).toEqual('translate');
       });
 
       it('should set i18n value to translate on field when i18n=true for field', () => {

packages/netlify-cms-core/src/actions/config.js

@@ -6,7 +6,7 @@ import * as publishModes from 'Constants/publishModes';
 import { validateConfig } from 'Constants/configSchema';
 import { selectDefaultSortableFields, traverseFields } from '../reducers/collections';
 import { resolveBackend } from 'coreSrc/backend';
-import { I18N, I18N_FIELD } from '../lib/i18n';
+import { I18N, I18N_FIELD, isI18nAllowed } from '../lib/i18n';
 
 export const CONFIG_REQUEST = 'CONFIG_REQUEST';
 export const CONFIG_SUCCESS = 'CONFIG_SUCCESS';
@@ -90,14 +90,33 @@ const setI18nDefaults = (i18n, collection) => {
 
     if (collectionI18n !== false) {
       // set default values for i18n fields
-      collection = collection.set('fields', traverseFields(collection.get('fields'), setI18nField));
+      if (collection.has('fields')) {
+        collection = collection.set(
+          'fields',
+          traverseFields(collection.get('fields'), setI18nField),
+        );
+      }
+
+      if (collection.has('files')) {
+        collection = collection.set('files', traverseFields(collection.get('files'), setI18nField));
+      }
     }
   } else {
     collection = collection.delete(I18N);
-    collection = collection.set(
-      'fields',
-      traverseFields(collection.get('fields'), field => field.delete(I18N)),
-    );
+
+    if (collection.has('fields')) {
+      collection = collection.set(
+        'fields',
+        traverseFields(collection.get('fields'), field => field.delete(I18N)),
+      );
+    }
+
+    if (collection.has('files')) {
+      collection = collection.set(
+        'files',
+        traverseFields(collection.get('files'), field => field.delete(I18N)),
+      );
+    }
   }
   return collection;
 };
@@ -244,9 +263,12 @@ export function applyDefaults(config) {
 
           const files = collection.get('files');
           if (files) {
-            if (i18n && collection.has(I18N)) {
-              throw new Error('i18n configuration is not supported for files collection');
+            if (isI18nAllowed(i18n, collection)) {
+              throw new Error(
+                'i18n configuration for files collections is limited to single_file structures',
+              );
             }
+
             collection = collection.delete('nested');
             collection = collection.delete('meta');
             collection = collection.set(
@@ -258,9 +280,11 @@ export function applyDefaults(config) {
                   'fields',
                   traverseFields(file.get('fields'), setDefaultPublicFolder),
                 );
+                file = setI18nDefaults(i18n, file);
                 return file;
               }),
             );
+            collection = setI18nDefaults(i18n, collection);
           }
 
           if (!collection.has('sortable_fields')) {

packages/netlify-cms-core/src/lib/__tests__/i18n.spec.js

@@ -400,6 +400,33 @@ describe('i18n', () => {
         raw: '',
       });
     });
+
+    it('should default to empty data object when file is empty and structure is I18N_STRUCTURE.SINGLE_FILE', async () => {
+      const data = {
+        'src/content/index.md': {
+          slug: 'index',
+          path: 'src/content/index.md',
+          data: {},
+        },
+      };
+      const getEntryValue = jest.fn(path => Promise.resolve(data[path]));
+
+      await expect(
+        i18n.getI18nEntry(
+          fromJS({
+            i18n: { structure: i18n.I18N_STRUCTURE.SINGLE_FILE, locales, default_locale },
+          }),
+          ...args,
+          getEntryValue,
+        ),
+      ).resolves.toEqual({
+        slug: 'index',
+        path: 'src/content/index.md',
+        data: {},
+        i18n: {},
+        raw: '',
+      });
+    });
   });
 
   describe('groupEntries', () => {

packages/netlify-cms-core/src/lib/i18n.ts

@@ -1,6 +1,13 @@
 import { Map, List } from 'immutable';
 import { set, trimEnd, groupBy } from 'lodash';
-import { Collection, Entry, EntryDraft, EntryField, EntryMap } from '../types/redux';
+import {
+  Collection,
+  Entry,
+  EntryDraft,
+  EntryField,
+  EntryMap,
+  i18n as i18nType,
+} from '../types/redux';
 import { selectEntrySlug } from '../reducers/collections';
 import { EntryValue } from '../valueObjects/Entry';
 
@@ -18,6 +25,15 @@ export enum I18N_FIELD {
   NONE = 'none',
 }
 
+export const isI18nAllowed = (i18n: i18nType, collection: Collection) => {
+  return (
+    i18n &&
+    collection.has(I18N) &&
+    i18n.get('structure') !== I18N_STRUCTURE.SINGLE_FILE &&
+    collection.getIn([I18N, 'structure']) !== I18N_STRUCTURE.SINGLE_FILE
+  );
+};
+
 export const hasI18n = (collection: Collection) => {
   return collection.has(I18N);
 };
@@ -244,7 +260,7 @@ const mergeValues = (
 };
 
 const mergeSingleFileValue = (entryValue: EntryValue, defaultLocale: string, locales: string[]) => {
-  const data = entryValue.data[defaultLocale];
+  const data = entryValue.data[defaultLocale] || {};
   const i18n = locales
     .filter(l => l !== defaultLocale)
     .map(l => ({ locale: l, value: entryValue.data[l] }))

packages/netlify-cms-core/src/types/redux.ts

@@ -184,7 +184,7 @@ type MetaObject = {
 
 type Meta = StaticallyTypedRecord<MetaObject>;
 
-type i18n = StaticallyTypedRecord<{
+export type i18n = StaticallyTypedRecord<{
   structure: string;
   locales: string[];
   default_locale: string;

website/content/docs/beta-features.md

@@ -130,7 +130,7 @@ collections:
 
 ### Limitations
 
-1. File collections are not supported.
+1. File collections currently only support `structure: single_file`.
 2. List widgets only support `i18n: true`. `i18n` configuration on sub fields is ignored.
 3. Object widgets only support `i18n: true` and `i18n` configuration should be done per field: