i18n: define translatable properties in frontmatter schema (github#18964

) * i18n: define translatable properties in frontmatter schema * mark `product` frontmatter as translatable * lint
blueboxes · Apr 26, 2021 · 148c63c · 148c63c
1 parent 53a262a
commit 148c63c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/lib/frontmatter.js b/lib/frontmatter.js
@@ -12,16 +12,20 @@ const schema = {
   properties: {
     title: {
       type: 'string',
-      required: true
+      required: true,
+      translatable: true
     },
     shortTitle: {
-      type: 'string'
+      type: 'string',
+      translatable: true
     },
     intro: {
-      type: 'string'
+      type: 'string',
+      translatable: true
     },
     product: {
-      type: 'string'
+      type: 'string',
+      translatable: true
     },
     permissions: {
       type: 'string'

diff --git a/script/fix-translation-errors.js b/script/fix-translation-errors.js
@@ -20,7 +20,9 @@ const yaml = require('js-yaml')
 const ghesReleaseNotesSchema = require('../lib/release-notes-schema')
 const revalidator = require('revalidator')
 
-const fixableFmProps = ['type', 'changelog', 'mapTopic', 'hidden', 'layout', 'defaultPlatform', 'showMiniToc', 'allowTitleToDifferFromFilename', 'interactive', 'beta_product']
+const fixableFmProps = Object.keys(fm.schema.properties)
+  .filter(property => !fm.schema.properties[property].translatable)
+  .sort()
 const fixableYmlProps = ['date']
 
 const loadAndValidateContent = async (path, schema) => {
@@ -50,6 +52,7 @@ const cmd = 'git diff --name-only origin/main | egrep "^translations/.*/(content
 const changedFilesRelPaths = execSync(cmd).toString().split('\n')
 
 changedFilesRelPaths.forEach(async (relPath) => {
+  // Skip READMEs
   if (!relPath || relPath.endsWith('README.md')) return
 
   const localisedAbsPath = path.join(__dirname, '..', relPath)