draft: groundwork for locales workflow

.gitignore

@@ -20,4 +20,5 @@ theme/templates/**/*.json
 theme/sections/*.json
 
 .shopkeeper
+!src/utilities/fixtures/.shopkeeper/
 shopify

README.md

@@ -101,7 +101,10 @@ installation of [Dawn](https://github.com/shopify/dawn):
 .shopkeeper
 ├── production
 │   ├── config
-│   │   └── settings_data.json
+│   │   ├── settings_data.json
+│   ├── locales
+│   │   ├── en.default.json
+│   │   └── es.json
 │   ├── sections
 │   │   ├── footer-group.json
 │   │   └── header-group.json

docs/the_complete_guide.md

@@ -42,6 +42,7 @@ bucket, run `shopkeeper bucket create --bucket production`.
 .shopkeeper
 ├── production
 │   ├── config
+│   ├── locales
 │   ├── sections
 │   ├── templates
 │   ├── .env
@@ -143,6 +144,8 @@ theme/assets
 theme/config/settings_data.json
 theme/templates/**/*.json
 theme/sections/*.json
+theme/locales/*.json
+!theme/locales/*schema*.json
 ```
 
 Adding this config makes only the settings in `.shopkeeper` trackable by `git`.

src/services/bucket/init.ts

@@ -61,4 +61,6 @@ theme/assets
 theme/config/settings_data.json
 theme/templates/**/*.json
 theme/sections/*.json
+theme/locales/*.json
+!theme/locales/*schema*.json
 `

src/utilities/bucket.test.ts

@@ -34,6 +34,7 @@ describe('bucket utilities', () => {
         const configPath = joinPath(shopkeeperRoot, 'production', 'config')
         const templatesPath = joinPath(shopkeeperRoot, 'production', 'templates')
         const sectionsPath = joinPath(shopkeeperRoot, 'production', 'sections')
+        const localesPath = joinPath(shopkeeperRoot, 'production', 'locales')
 
         // When
         await createBuckets(shopkeeperRoot, ['production'])
@@ -46,6 +47,7 @@ describe('bucket utilities', () => {
         expect(await fileExists(configPath)).toBe(true)
         expect(await fileExists(templatesPath)).toBe(true)
         expect(await fileExists(sectionsPath)).toBe(true)
+        expect(await fileExists(localesPath)).toBe(true)
       })
     })
   })
@@ -124,6 +126,7 @@ describe('bucket utilities', () => {
         [
           'config/settings_data.json',
           'templates/product.json',
+          'locales/en.default.json',
           'templates/customers/account.json',
           'templates/metaobject/toy.json',
           'sections/header-group.json',
@@ -148,6 +151,7 @@ describe('bucket utilities', () => {
           'templates/customers/account.json',
           'templates/metaobject/toy.json',
           'sections/header-group.json',
+          'locales/en.default.json',
         ].sort(),
       )
     })
@@ -169,6 +173,7 @@ describe('bucket utilities', () => {
           'templates/customers/account.json',
           'templates/metaobject/toy.json',
           'sections/header-group.json',
+          'locales/en.default.json',
         ].sort(),
       )
     })
@@ -235,7 +240,7 @@ describe('bucket utilities', () => {
       const settingsFolders = getSettingsPatterns()
 
       // Then
-      expect(settingsFolders).toEqual(['config/settings_data.json', 'templates/**/*.json', 'sections/*.json'])
+      expect(settingsFolders).toEqual(['config/settings_data.json', 'templates/**/*.json', 'sections/*.json', 'locales/!(*schema*).json'])
     })
   })
 
@@ -257,6 +262,8 @@ describe('bucket utilities', () => {
         'templates/customers/*.json',
         '--only',
         'templates/metaobject/*.json',
+        '--only',
+        'locales/!(*schema*).json',
       ])
     })
   })
@@ -267,7 +274,7 @@ describe('bucket utilities', () => {
       const settingsFolders = getSettingsFolders()
 
       // Then
-      expect(settingsFolders).toEqual(['config', 'templates', 'sections'])
+      expect(settingsFolders).toEqual(['config', 'templates', 'sections', 'locales'])
     })
   })
 })

src/utilities/bucket.ts

@@ -40,6 +40,7 @@ export async function createBuckets(shopkeeperRoot: string, buckets: string[]) {
       await mkdir(joinPath(bucketPath, 'config'))
       await mkdir(joinPath(bucketPath, 'templates'))
       await mkdir(joinPath(bucketPath, 'sections'))
+      await mkdir(joinPath(bucketPath, 'locales'))
     }),
   )
 }
@@ -137,7 +138,12 @@ export async function getCurrentBucket(shopkeeperRoot: string): Promise<string>
 }
 
 export function getSettingsPatterns(): string[] {
-  return ['config/settings_data.json', 'templates/**/*.json', 'sections/*.json']
+  return [
+    'config/settings_data.json',
+    'templates/**/*.json',
+    'sections/*.json',
+    'locales/!(*schema*).json',
+  ]
 }
 
 export const CLI_SETTINGS_FLAGS = [
@@ -146,6 +152,7 @@ export const CLI_SETTINGS_FLAGS = [
   'templates/*.json',
   'templates/customers/*.json',
   'templates/metaobject/*.json',
+  'locales/!(*schema*).json',
 ]
 
 export function cliSettingFlags() {
@@ -157,7 +164,7 @@ export function cliSettingFlags() {
 }
 
 export function getSettingsFolders() {
-  return ['config', 'templates', 'sections']
+  return ['config', 'templates', 'sections', 'locales']
 }
 
 export async function copyFiles(moves: FileMove[]) {

src/utilities/theme.test.ts

@@ -23,6 +23,7 @@ describe('theme utilities', () => {
         'templates/*.json',
         'templates/customers/*.json',
         'templates/metaobject/*.json',
+        'locales/!(*schema*).json',
       ]
       const flags: PullFlags = {
         only: settingsFlags,
@@ -50,6 +51,7 @@ describe('theme utilities', () => {
         'templates/*.json',
         'templates/customers/*.json',
         'templates/metaobject/*.json',
+        'locales/!(*schema*).json',
       ]
       const flags: PullFlags = {
         only: settingsFlags,
@@ -105,6 +107,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -143,6 +146,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -181,6 +185,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -219,6 +224,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -257,6 +263,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -362,6 +369,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -400,6 +408,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -434,6 +443,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         })
       })
@@ -451,6 +461,7 @@ describe('theme utilities', () => {
             'templates/*.json',
             'templates/customers/*.json',
             'templates/metaobject/*.json',
+            'locales/!(*schema*).json',
           ],
         }))
       })