feat: adapt section indent and babel packages for languages

GreatWizard · Jun 28, 2024 · 2247a5b · 2247a5b
1 parent 72d80c3
commit 2247a5b
Show file tree

Hide file tree

Showing 22 changed files with 205 additions and 140 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,7 +18,7 @@ jobs:
       - uses: actions/setup-java@v4
         with:
           distribution: 'temurin'
-          java-version: '17'
+          java-version: '11'
       - run: |
           PANDOC_URL=$(curl https://api.github.com/repos/jgm/pandoc/releases/latest | jq -r ".assets[] | select(.name | test(\"amd64.deb$\")) | .browser_download_url")
           curl --silent --show-error --location --fail --retry 4 --retry-delay 5 --output pandoc.deb $PANDOC_URL

diff --git a/README.md b/README.md
@@ -125,7 +125,7 @@ pdf:
     rights: 'ISBN: 123-4-5678901-6-7'
   # latex packages option is only used by pdf format
   latexPackages:
-    - '[frenchb]{babel}'
+    - '[french]{babel}'
 ```
 
 ### Commands

diff --git a/package.json b/package.json
@@ -43,7 +43,8 @@
     "lint": "eslint . --cache",
     "lint:fix": "eslint . --fix",
     "pretest": "node scripts/github-releases.js",
-    "test": "npm-run-all pretest test:unit test:acceptance",
+    "pretest:acceptance": "find ./test -type f \\( -iname '*.epub' -o -iname '*.mobi' -o -iname '*.pdf' \\) -delete",
+    "test": "npm-run-all pretest test:unit pretest:acceptance test:acceptance",
     "test:acceptance": "npm-run-all test:acceptance:*",
     "test:acceptance:custom-fonts-ttf": "node ./src/index.js --debug --non-interactive --epub --pdf test/acceptance/custom-fonts-ttf && java -jar github_releases/w3c/epubcheck/epubcheck-*/epubcheck.jar test/acceptance/custom-fonts-ttf/*.epub",
     "test:acceptance:custom-fonts-otf": "node ./src/index.js --debug --non-interactive --epub --pdf test/acceptance/custom-fonts-otf && java -jar github_releases/w3c/epubcheck/epubcheck-*/epubcheck.jar test/acceptance/custom-fonts-otf/*.epub",
@@ -56,6 +57,7 @@
     "test:acceptance:metadata": "node ./src/index.js --debug --non-interactive --epub test/acceptance/metadata && java -jar github_releases/w3c/epubcheck/epubcheck-*/epubcheck.jar test/acceptance/metadata/*.epub",
     "test:acceptance:toc": "node ./src/index.js --debug --non-interactive --epub --pdf test/acceptance/toc && java -jar github_releases/w3c/epubcheck/epubcheck-*/epubcheck.jar test/acceptance/toc/*.epub",
     "test:acceptance:mobi": "node ./src/index.js --debug --non-interactive --mobi test/acceptance/latex-multi-files",
+    "test:acceptance:french": "node ./src/index.js --debug --non-interactive --epub --pdf test/acceptance/french && java -jar github_releases/w3c/epubcheck/epubcheck-*/epubcheck.jar test/acceptance/french/*.epub",
     "test:unit": "mocha test/unit/**/*.test.js",
     "build": "pkg . --out-path=build",
     "start": "node ./src/index.js"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/build.js b/src/build.js
@@ -7,8 +7,9 @@ const yaml = require('js-yaml')
 const nodePandoc = require('./node-pandoc-promise')
 
 const { latexHeader, latexNumber, latexImage, latexTOC, latexTitle, latexNewPage } = require('./helpers/latex')
-const { defaultStylesheet, generateFontsStylesheet } = require('./helpers/stylesheet')
-const { parseBool, generateFontFilename } = require('./utils')
+const { defaultStylesheet, generateFontsStylesheet, getLanguageStylesheet } = require('./helpers/stylesheet')
+const { generateFontFilename } = require('./helpers/fonts')
+const { parseBool } = require('./utils')
 const { epubToMobi } = require('./kindlegen')
 const {
   extract,
@@ -95,6 +96,7 @@ module.exports = async (config, options = {}) => {
     ;(config.styleSheets || []).forEach((filename) => {
       cssContent += fs.readFileSync(path.join(cwd, filename), 'utf8')
     })
+    cssContent += getLanguageStylesheet(config.metadata.lang)
     cssContent += generateFontsStylesheet(config.fonts)
     cssContent = new CleanCSS({
       level: {
@@ -119,6 +121,11 @@ module.exports = async (config, options = {}) => {
   }
 
   if (config.format === 'pdf') {
+    if (config.metadata.lang) {
+      // Pass the lang option to the template
+      args.push('-V', `lang=${config.metadata.lang.split('-')[0]}`)
+    }
+
     // use pdf engine
     args.push('--pdf-engine=xelatex')
 

diff --git a/src/helpers/fonts.js b/src/helpers/fonts.js
@@ -0,0 +1,5 @@
+module.exports.generateFontFilename = (fonts = {}, type = 'main', shape = 'upright') => {
+  let filename = ((fonts[type].shapes || [])[shape] || '*').replace('*', fonts[type].baseFilename)
+  let extension = fonts[type].extension
+  return `${filename}${extension}`
+}
diff --git a/src/helpers/languages.js b/src/helpers/languages.js
@@ -0,0 +1,18 @@
+const En = require('./languages/en')
+const Fr = require('./languages/fr')
+
+const languages = [En, Fr]
+
+module.exports.getLanguageData = (lang) => {
+  if (lang) {
+    let language = languages.find((l) => l.codes.includes(lang))
+    if (language) {
+      return language
+    }
+    language = languages.find((l) => l.codes.includes(lang.split('-')[0]))
+    if (language) {
+      return language
+    }
+  }
+  return En
+}
diff --git a/src/helpers/languages/en.js b/src/helpers/languages/en.js
@@ -0,0 +1,9 @@
+module.exports = {
+  codes: ['en'],
+  css: `section:not(.titlepage) p {
+  margin: 0;
+}
+section:not(.titlepage) p:not(:nth-child(2)) {
+  text-indent: 1.5em;
+}`,
+}
diff --git a/src/helpers/languages/fr.js b/src/helpers/languages/fr.js
@@ -0,0 +1,7 @@
+module.exports = {
+  codes: ['fr'],
+  css: `section:not(.titlepage) p {
+  margin: 0;
+  text-indent: 1.5em;
+}`,
+}
diff --git a/src/helpers/latex.js b/src/helpers/latex.js
@@ -1,14 +1,15 @@
-const defaultPackages = ['{tikz}', '{graphicx}', '{sectsty}']
+const { cleanArray } = require('../utils')
+const { generateFontFilename } = require('./fonts')
 
-const { generateFontFilename } = require('../utils')
+const defaultPackages = ['{tikz}', '{graphicx}', '{sectsty}']
 
 module.exports.latexHeader = (latexPackages = [], fonts = {}) => {
   let header = ''
-  let allPackages = defaultPackages.concat(latexPackages)
+  let allPackages = [...defaultPackages, ...latexPackages]
   if (fonts.main) {
     allPackages.push('{fontspec}')
   }
-  allPackages.forEach((packageName) => {
+  cleanArray(allPackages).forEach((packageName) => {
     header += `\\usepackage${packageName}\n`
   })
   if (fonts.main) {

diff --git a/src/helpers/stylesheet.js b/src/helpers/stylesheet.js
@@ -1,5 +1,7 @@
 const path = require('path')
-const { generateFontFilename } = require('../utils')
+
+const { generateFontFilename } = require('./fonts')
+const { getLanguageData } = require('./languages')
 
 module.exports.defaultStylesheet = `body {
   margin: 5%;
@@ -79,11 +81,6 @@ div.column {
 div.hanging-indent {
   margin-left: 1.5em;
   text-indent: -1.5em;
-}
-
-section:not(.titlepage) p {
-  margin: 0;
-  text-indent: 1.5em;
 }\n`
 
 module.exports.generateFontsStylesheet = (fonts = {}) => {
@@ -113,3 +110,7 @@ module.exports.generateFontsStylesheet = (fonts = {}) => {
 
   return result
 }
+
+module.exports.getLanguageStylesheet = (lang) => {
+  return `${getLanguageData(lang).css}\n`
+}
diff --git a/src/utils.js b/src/utils.js
@@ -45,8 +45,4 @@ module.exports.humanizePlatformArch = (platform, arch) => {
   }
 }
 
-module.exports.generateFontFilename = (fonts = {}, type = 'main', shape = 'upright') => {
-  let filename = ((fonts[type].shapes || [])[shape] || '*').replace('*', fonts[type].baseFilename)
-  let extension = fonts[type].extension
-  return `${filename}${extension}`
-}
+module.exports.cleanArray = (array = []) => [...new Set(array)].filter(Boolean)
diff --git a/test/acceptance/custom-fonts-otf/reliure.yml b/test/acceptance/custom-fonts-otf/reliure.yml
@@ -20,7 +20,6 @@ default:
     subtitle: EB Garamond
     author: Guillaume Gérard
     date: 2021-10
-    lang: fr-FR
 
   textSubstitutions:
     - regex: <p>\*{3}</p>

diff --git a/test/acceptance/custom-fonts-ttf/reliure.yml b/test/acceptance/custom-fonts-ttf/reliure.yml
@@ -19,7 +19,6 @@ default:
     subtitle: Literata
     author: Guillaume Gérard
     date: 2021-10
-    lang: fr-FR
 
   textSubstitutions:
     - regex: <p>\*{3}</p>

diff --git a/test/acceptance/french/reliure.yml b/test/acceptance/french/reliure.yml
@@ -0,0 +1,17 @@
+filename: My Ebook
+
+default:
+  styleSheets:
+    - ../center.css
+  files:
+    - ../latex-one-file/ebook.tex
+
+  metadata:
+    title: Test - French
+    author: Guillaume Gérard
+    date: 2020-11
+    lang: fr-FR
+
+  textSubstitutions:
+    - regex: <p>\*{3}</p>
+      replacement: <p class="center">***</p>
diff --git a/test/acceptance/latex-multi-files/reliure.yml b/test/acceptance/latex-multi-files/reliure.yml
@@ -16,7 +16,6 @@ default:
     subtitle: With multiple files
     author: Guillaume Gérard
     date: 2020-11
-    lang: fr-FR
 
   extraMetadata:
     'calibre:series': My Collection

diff --git a/test/acceptance/latex-one-file/reliure.yml b/test/acceptance/latex-one-file/reliure.yml
@@ -12,7 +12,6 @@ default:
     subtitle: With one file
     author: Guillaume Gérard
     date: 2020-11
-    lang: fr-FR
 
   extraMetadata:
     'calibre:series': My Collection

diff --git a/test/acceptance/markdown-multi-files/reliure.yml b/test/acceptance/markdown-multi-files/reliure.yml
@@ -16,7 +16,6 @@ default:
     subtitle: With multiple files
     author: Guillaume Gérard
     date: 2020-11
-    lang: fr-FR
 
   extraMetadata:
     'calibre:series': My Collection

diff --git a/test/acceptance/markdown-one-file/reliure.yml b/test/acceptance/markdown-one-file/reliure.yml
@@ -12,7 +12,6 @@ default:
     subtitle: With one file
     author: Guillaume Gérard
     date: 2020-11
-    lang: fr-FR
 
   extraMetadata:
     'calibre:series': My Collection

diff --git a/test/acceptance/metadata/reliure.yml b/test/acceptance/metadata/reliure.yml
@@ -21,7 +21,6 @@ default:
       - role: crr
         text: contributor contributor 1
     date: '2021-10-11'
-    lang: fr-FR
     subject:
       - subject 1
       - subject 2

diff --git a/test/acceptance/odt-one-file/reliure.yml b/test/acceptance/odt-one-file/reliure.yml
@@ -12,7 +12,6 @@ default:
     subtitle: With one file
     author: Guillaume Gérard
     date: 2020-11
-    lang: fr-FR
 
   extraMetadata:
     'calibre:series': My Collection

diff --git a/test/acceptance/toc/reliure.yml b/test/acceptance/toc/reliure.yml
@@ -10,7 +10,6 @@ default:
     title: Test - ToC
     author: Guillaume Gérard
     date: 2021-11
-    lang: fr-FR
 
 pdf:
   coverImage: ../cover-a4.jpg