exclude pathnames

desentio · Nov 14, 2024 · b2c2da1 · b2c2da1
1 parent db80062
commit b2c2da1
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -31,6 +31,7 @@ Place the following script inside your <head> tag
 - **data-use-browser-language**: Automatically sets the language based on the user's browser language. Set to `false` to disable.
 - **data-exclude-classes**: List CSS class names to exclude from translation, separated by commas (e.g., `chatbot, no-translate`).
 - **data-exclude-ids**: List IDs to exclude from translation, separated by commas (e.g., `user-comment, code-snippet` will prevent translation of elements with ID `user-comment` and `code-snippet`).
+- **data-exclude-paths**: List URL paths to exclude from translation, separated by commas (e.g., `/admin, /blog` will prevent translation of URLs containing `/admin` and `/blog`). NOTE: Each path should start with a `/`.
 
 #### Server Side Rendering Configuration:
 - **data-translation-mode**: Modify the translated pages logic. Set to `subdomain` to point to subdomains (for example: de.domain.com), or `subdirectory` to point to paths (for example: domain.com/de). *DONT USE* if you are not using SSR (SSR only available in higher plans).

diff --git a/extractOptionsFromScript.js b/extractOptionsFromScript.js
@@ -71,6 +71,7 @@ function extractOptionsFromScript(window, optsArgs = {
   const DATA_USE_BROWSER_LANG = "data-use-browser-language"; // default: true
   const DATA_EXCLUDE_CLASSES = "data-exclude-classes";
   const DATA_EXCLUDE_IDS = "data-exclude-ids";
+  const DATA_EXCLUDE_PATHS = "data-exclude-paths";
   const DATA_REPLACE_LINKS = "data-replace-links"; // default: true
   const DATA_AUTO_CREATE_SELECTOR = "data-auto-create-selector"; // default: true
   const DATA_DELAY = "data-timeout"; // default: 0
@@ -424,6 +425,13 @@ function extractOptionsFromScript(window, optsArgs = {
   const mergedExcludeIds = [...excludeIdsByComma, ...excludeIdsBySpace];
   const excludeIds = [...new Set(mergedExcludeIds)]; // get unique values
 
+  // exclude paths
+  const excludePathsAttr = (window.translationScriptTag.getAttribute(DATA_EXCLUDE_PATHS) || "").trim()
+  const excludePathsByComma = excludePathsAttr.split(",").filter(path => !!path).map(path => path.trim());
+  const excludePathsBySpace = excludePathsAttr.split(" ").filter(path => !!path).map(path => path.trim().replaceAll(",", ""));
+  const mergedExcludePaths = [...excludePathsByComma, ...excludePathsBySpace];
+  const excludePaths = [...new Set(mergedExcludePaths)]; // get unique values
+
   // exclude contents
   const excludeContentsAttr = (window.translationScriptTag.getAttribute(DATA_EXCLUDE_CONTENTS) || "").trim()
   const splittedContents = getTextInsideBrackets(excludeContentsAttr);
@@ -456,6 +464,7 @@ function extractOptionsFromScript(window, optsArgs = {
     createSelector: createSelector,
     excludeClasses,
     excludeIds,
+    excludePaths,
     excludeContents,
     originalLanguage: originalLang,
     allowedLanguages: allowedLangs,

diff --git a/utils/options/setOptions.js b/utils/options/setOptions.js
@@ -20,6 +20,7 @@ function setOptions(window, apiKey, optsArgs) {
     pathOptions: optsArgs.pathOptions || {},
     apiKey,
     excludeIds: optsArgs.excludeIds || [],
+    excludePaths: optsArgs.excludePaths || [],
     excludeClasses: optsArgs.excludeClasses || [],
     excludeContents: optsArgs.excludeContents || [],
     definedLanguages: getDefinedLanguages(optsArgs.originalLanguage, optsArgs.allowedLanguages),

diff --git a/utils/translation/isExcluded.js b/utils/translation/isExcluded.js
@@ -15,3 +15,11 @@ function isExcludedId(window, id) {
   return globalseoOptions.excludeIds.length && globalseoOptions.excludeIds.some(excludeId => excludeId && id.includes(excludeId))
 }
 exports.isExcludedId = isExcludedId;
+
+function isExcludedPath(window) {
+  const globalseoOptions = getGlobalseoOptions(window);
+  const path = window.location.pathname;
+
+  return globalseoOptions.excludePaths.length && globalseoOptions.excludePaths.some(excludePath => excludePath && path.includes(excludePath))
+}
+exports.isExcludedPath = isExcludedPath;
diff --git a/utils/translation/startTranslationCycle.js b/utils/translation/startTranslationCycle.js
@@ -3,6 +3,7 @@ const { getLanguageFromLocalStorage } = require("../languages/getSelectedLanguag
 const modifyHtmlStrings = require("./modifyHtmlStrings");
 const { debounce } = require("../debounce");
 const { renderSelectorState } = require("../selector/renderSelectorState");
+const { isExcludedPath } = require("./isExcluded");
 
 async function startTranslationCycle(window, node, apiKey, delay, shouldOptimizeSEO = false) {
   if (window.preventInitialTranslation) {
@@ -11,6 +12,11 @@ async function startTranslationCycle(window, node, apiKey, delay, shouldOptimize
   };
   const options = getGlobalseoOptions(window);
 
+  if (isExcludedPath(window)) {
+    renderSelectorState(window, { shouldUpdateActiveLang: true, delay: 0, shouldLog: false })
+    return window;
+  }
+
   if (!window.isWorker && options.translationMode == "subdomain") {      
     await renderSelectorState(window, { shouldUpdateActiveLang: true, delay: 0, shouldLog: false })