feat: omit placeholders plugin option

Author: Henrixounez

providers/deepl/README.md

@@ -21,6 +21,8 @@ module.exports = {
           // use uppercase here!
           EN: 'EN-US',
         },
+        // controls if placeholder text inside double curly brackets should be omitted from translation
+        omitPlaceholders: false,
         apiOptions: {
           // see <https://github.com/DeepLcom/deepl-node#text-translation-options> for supported options.
           // note that tagHandling Mode cannot be set this way.

providers/deepl/lib/__tests__/deepl.test.js

@@ -395,6 +395,27 @@ describe('deepl provider', () => {
         await expect(deeplProvider.usage()).resolves.toBeTruthy()
       })
 
+      it('omits placeholders when option used', async () => {
+        server.use(http.post(`${DEEPL_PAID_API}/translate`, translateHandler))
+
+        const deeplProvider = provider.init({
+          apiKey: authKey,
+          omitPlaceholders: true,
+        })
+
+        // given
+        const params = {
+          sourceLocale: 'en',
+          targetLocale: 'de',
+          text: 'Some text with a placeholder {{placeholder}} in it and an {{other}} one',
+        }
+        // when
+        const result = await deeplProvider.translate(params)
+
+        // then
+        expect(result).toEqual([params.text])
+      })
+
       describe('api options used', () => {
         const registerHandlerEnforceParams = (
           requiredParams,

providers/deepl/lib/index.js

@@ -31,6 +31,7 @@ module.exports = {
       typeof providerOptions.apiOptions === 'object'
         ? providerOptions.apiOptions
         : {}
+    const omitPlaceholders = providerOptions.omitPlaceholders || false
 
     const client = new deepl.Translator(apiKey, {
       serverUrl: apiUrl,
@@ -74,12 +75,23 @@ module.exports = {
           textArray = formatService.markdownToHtml(textArray)
         }
 
+        let placeholderTexts = [];
+
+        if (omitPlaceholders) {
+          textArray = textArray.map((text) =>
+            text.replace(/{{(.*?)}}/g, (match) => {
+              placeholderTexts.push(match)
+              return `<m id=${placeholderTexts.length - 1} />`
+            })
+          )
+        }
+
         const { chunks, reduceFunction } = chunksService.split(textArray, {
           maxLength: DEEPL_API_MAX_TEXTS,
           maxByteSize: DEEPL_API_ROUGH_MAX_REQUEST_SIZE,
         })
 
-        const result = reduceFunction(
+        let result = reduceFunction(
           await Promise.all(
             chunks.map(async (texts) => {
               const result = await rateLimitedTranslate.withOptions(
@@ -99,6 +111,12 @@ module.exports = {
           )
         )
 
+        if (omitPlaceholders) {
+          result = result.map((text) =>
+            text.replace(/<m id=(.*?) \/>/g, (_, id) => placeholderTexts[id])
+          )
+        }
+
         if (format === 'markdown') {
           return formatService.htmlToMarkdown(result)
         }