gtx-cli 2.1.8 → 2.1.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,23 @@
1
1
  # gtx-cli
2
2
 
3
+ ## 2.1.10
4
+
5
+ ### Patch Changes
6
+
7
+ - [#600](https://github.com/generaltranslation/gt/pull/600) [`e94aac2`](https://github.com/generaltranslation/gt/commit/e94aac2b2554a279245d090b0872f6f64eb71c62) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Added handling of fragment URLs (i.e. href="#my-mdx-id") for correct routing across locales.
8
+
9
+ ## 2.1.9
10
+
11
+ ### Patch Changes
12
+
13
+ - [#604](https://github.com/generaltranslation/gt/pull/604) [`43c6a76`](https://github.com/generaltranslation/gt/commit/43c6a76be3d3be420e892b86188ef41c45ae8ffe) Thanks [@archie-mckenzie](https://github.com/archie-mckenzie)! - Refactored useGT and useMessages in order to make useMessages function like an unlintable useGT
14
+
15
+ ## 2.1.8
16
+
17
+ ### Patch Changes
18
+
19
+ - [#599](https://github.com/generaltranslation/gt/pull/599) [`5950592`](https://github.com/generaltranslation/gt/commit/5950592ca44197915216ec5c8e26f9714cb4f55c) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - feat: msg() function
20
+
3
21
  ## 2.1.8
4
22
 
5
23
  ### Patch Changes
@@ -5,6 +5,7 @@ import { getStagedVersions } from '../../fs/config/updateVersions.js';
5
5
  import copyFile from '../../fs/copyFile.js';
6
6
  import flattenJsonFiles from '../../utils/flattenJsonFiles.js';
7
7
  import localizeStaticUrls from '../../utils/localizeStaticUrls.js';
8
+ import processAnchorIds from '../../utils/processAnchorIds.js';
8
9
  import { noFilesError, noVersionIdError } from '../../console/index.js';
9
10
  // Downloads translations that were completed
10
11
  export async function handleTranslate(options, settings, filesTranslationResponse) {
@@ -34,13 +35,16 @@ export async function handleDownload(options, settings) {
34
35
  await checkFileTranslations(stagedVersionData, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale][sourcePath] ?? null, settings);
35
36
  }
36
37
  export async function postProcessTranslations(settings) {
37
- // Localize static urls (/docs -> /[locale]/docs) for non-default locales only
38
+ // Localize static urls (/docs -> /[locale]/docs) and preserve anchor IDs for non-default locales
38
39
  // Default locale is processed earlier in the flow in base.ts
39
40
  if (settings.options?.experimentalLocalizeStaticUrls) {
40
41
  const nonDefaultLocales = settings.locales.filter((locale) => locale !== settings.defaultLocale);
41
42
  if (nonDefaultLocales.length > 0) {
42
43
  await localizeStaticUrls(settings, nonDefaultLocales);
43
44
  }
45
+ // Add explicit anchor IDs to translated MDX/MD files to preserve navigation
46
+ // Uses inline {#id} format by default, or div wrapping if experimentalAddHeaderAnchorIds is 'mintlify'
47
+ await processAnchorIds(settings);
44
48
  }
45
49
  // Flatten json files into a single file
46
50
  if (settings.options?.experimentalFlattenJsonFiles) {
@@ -1,3 +1,8 @@
1
+ export declare const MSG_TRANSLATION_HOOK = "msg";
2
+ export declare const INLINE_TRANSLATION_HOOK = "useGT";
3
+ export declare const INLINE_TRANSLATION_HOOK_ASYNC = "getGT";
4
+ export declare const INLINE_MESSAGE_HOOK = "useMessages";
5
+ export declare const INLINE_MESSAGE_HOOK_ASYNC = "getMessages";
1
6
  export declare const GT_TRANSLATION_FUNCS: string[];
2
7
  export declare const VARIABLE_COMPONENTS: string[];
3
8
  export declare const GT_ATTRIBUTES_WITH_SUGAR: string[];
@@ -1,7 +1,15 @@
1
+ export const MSG_TRANSLATION_HOOK = 'msg';
2
+ export const INLINE_TRANSLATION_HOOK = 'useGT';
3
+ export const INLINE_TRANSLATION_HOOK_ASYNC = 'getGT';
4
+ export const INLINE_MESSAGE_HOOK = 'useMessages';
5
+ export const INLINE_MESSAGE_HOOK_ASYNC = 'getMessages';
1
6
  // GT translation functions
2
7
  export const GT_TRANSLATION_FUNCS = [
3
- 'useGT',
4
- 'getGT',
8
+ INLINE_TRANSLATION_HOOK,
9
+ INLINE_TRANSLATION_HOOK_ASYNC,
10
+ INLINE_MESSAGE_HOOK,
11
+ INLINE_MESSAGE_HOOK_ASYNC,
12
+ MSG_TRANSLATION_HOOK,
5
13
  'T',
6
14
  'Var',
7
15
  'DateTime',
@@ -1,6 +1,6 @@
1
1
  import * as t from '@babel/types';
2
2
  import { isStaticExpression } from '../evaluateJsx.js';
3
- import { GT_ATTRIBUTES_WITH_SUGAR, mapAttributeName } from './constants.js';
3
+ import { GT_ATTRIBUTES_WITH_SUGAR, MSG_TRANSLATION_HOOK, INLINE_TRANSLATION_HOOK, INLINE_TRANSLATION_HOOK_ASYNC, mapAttributeName, INLINE_MESSAGE_HOOK, INLINE_MESSAGE_HOOK_ASYNC, } from './constants.js';
4
4
  import { warnNonStaticExpressionSync, warnNonStringSync, warnTemplateLiteralSync, warnAsyncUseGT, warnSyncGetGT, } from '../../../console/index.js';
5
5
  import generateModule from '@babel/generator';
6
6
  import traverseModule from '@babel/traverse';
@@ -22,7 +22,7 @@ import resolve from 'resolve';
22
22
  * - Metadata extraction from options object
23
23
  * - Error reporting for non-static expressions and template literals with expressions
24
24
  */
25
- function processTranslationCall(tPath, updates, errors, file) {
25
+ function processTranslationCall(tPath, updates, errors, file, ignoreAdditionalData, ignoreDynamicContent) {
26
26
  if (tPath.parent.type === 'CallExpression' &&
27
27
  tPath.parent.arguments.length > 0) {
28
28
  const arg = tPath.parent.arguments[0];
@@ -43,7 +43,7 @@ function processTranslationCall(tPath, updates, errors, file) {
43
43
  if (!result.isStatic) {
44
44
  errors.push(warnNonStaticExpressionSync(file, attribute, generate(prop.value).code, `${prop.loc?.start?.line}:${prop.loc?.start?.column}`));
45
45
  }
46
- if (result.isStatic && result.value) {
46
+ if (result.isStatic && result.value && !ignoreAdditionalData) {
47
47
  // Map $id and $context to id and context
48
48
  metadata[mapAttributeName(attribute)] = result.value;
49
49
  }
@@ -59,10 +59,14 @@ function processTranslationCall(tPath, updates, errors, file) {
59
59
  }
60
60
  else if (t.isTemplateLiteral(arg)) {
61
61
  // warn if template literal
62
- errors.push(warnTemplateLiteralSync(file, generate(arg).code, `${arg.loc?.start?.line}:${arg.loc?.start?.column}`));
62
+ if (!ignoreDynamicContent) {
63
+ errors.push(warnTemplateLiteralSync(file, generate(arg).code, `${arg.loc?.start?.line}:${arg.loc?.start?.column}`));
64
+ }
63
65
  }
64
66
  else {
65
- errors.push(warnNonStringSync(file, generate(arg).code, `${arg.loc?.start?.line}:${arg.loc?.start?.column}`));
67
+ if (!ignoreDynamicContent) {
68
+ errors.push(warnNonStringSync(file, generate(arg).code, `${arg.loc?.start?.line}:${arg.loc?.start?.column}`));
69
+ }
66
70
  }
67
71
  }
68
72
  }
@@ -145,11 +149,11 @@ function resolveVariableAliases(scope, variableName, visited = new Set()) {
145
149
  * This covers both direct translation calls (t('hello')) and prop drilling
146
150
  * where the translation callback is passed to other functions (getData(t)).
147
151
  */
148
- function handleFunctionCall(tPath, updates, errors, file, importMap) {
152
+ function handleFunctionCall(tPath, updates, errors, file, importMap, ignoreAdditionalData, ignoreDynamicContent) {
149
153
  if (tPath.parent.type === 'CallExpression' &&
150
154
  tPath.parent.callee === tPath.node) {
151
155
  // Direct translation call: t('hello')
152
- processTranslationCall(tPath, updates, errors, file);
156
+ processTranslationCall(tPath, updates, errors, file, ignoreAdditionalData, ignoreDynamicContent);
153
157
  }
154
158
  else if (tPath.parent.type === 'CallExpression' &&
155
159
  t.isExpression(tPath.node) &&
@@ -161,7 +165,7 @@ function handleFunctionCall(tPath, updates, errors, file, importMap) {
161
165
  const calleeBinding = tPath.scope.getBinding(callee.name);
162
166
  if (calleeBinding && calleeBinding.path.isFunction()) {
163
167
  const functionPath = calleeBinding.path;
164
- processFunctionIfMatches(callee.name, argIndex, functionPath.node, functionPath, updates, errors, file);
168
+ processFunctionIfMatches(callee.name, argIndex, functionPath.node, functionPath, updates, errors, file, ignoreAdditionalData, ignoreDynamicContent);
165
169
  }
166
170
  // Handle arrow functions assigned to variables: const getData = (t) => {...}
167
171
  else if (calleeBinding &&
@@ -170,14 +174,14 @@ function handleFunctionCall(tPath, updates, errors, file, importMap) {
170
174
  (t.isArrowFunctionExpression(calleeBinding.path.node.init) ||
171
175
  t.isFunctionExpression(calleeBinding.path.node.init))) {
172
176
  const initPath = calleeBinding.path.get('init');
173
- processFunctionIfMatches(callee.name, argIndex, calleeBinding.path.node.init, initPath, updates, errors, file);
177
+ processFunctionIfMatches(callee.name, argIndex, calleeBinding.path.node.init, initPath, updates, errors, file, ignoreAdditionalData, ignoreDynamicContent);
174
178
  }
175
179
  // If not found locally, check if it's an imported function
176
180
  else if (importMap.has(callee.name)) {
177
181
  const importPath = importMap.get(callee.name);
178
182
  const resolvedPath = resolveImportPath(file, importPath);
179
183
  if (resolvedPath) {
180
- findFunctionInFile(resolvedPath, callee.name, argIndex, updates, errors);
184
+ findFunctionInFile(resolvedPath, callee.name, argIndex, updates, errors, ignoreAdditionalData, ignoreDynamicContent);
181
185
  }
182
186
  }
183
187
  }
@@ -188,12 +192,12 @@ function handleFunctionCall(tPath, updates, errors, file, importMap) {
188
192
  * Validates the function has enough parameters and traces how the translation callback
189
193
  * is used within that function's body.
190
194
  */
191
- function processFunctionIfMatches(_functionName, argIndex, functionNode, functionPath, updates, errors, filePath) {
195
+ function processFunctionIfMatches(_functionName, argIndex, functionNode, functionPath, updates, errors, filePath, ignoreAdditionalData, ignoreDynamicContent) {
192
196
  if (functionNode.params.length > argIndex) {
193
197
  const param = functionNode.params[argIndex];
194
198
  const paramName = extractParameterName(param);
195
199
  if (paramName) {
196
- findFunctionParameterUsage(functionPath, paramName, updates, errors, filePath);
200
+ findFunctionParameterUsage(functionPath, paramName, updates, errors, filePath, ignoreAdditionalData, ignoreDynamicContent);
197
201
  }
198
202
  }
199
203
  }
@@ -205,7 +209,7 @@ function processFunctionIfMatches(_functionName, argIndex, functionNode, functio
205
209
  * Example: In function getInfo(t) { return t('hello'); }, this finds the t('hello') call.
206
210
  * Example: In function getData(t) { return getFooter(t); }, this finds and traces into getFooter.
207
211
  */
208
- function findFunctionParameterUsage(functionPath, parameterName, updates, errors, file) {
212
+ function findFunctionParameterUsage(functionPath, parameterName, updates, errors, file, ignoreAdditionalData, ignoreDynamicContent) {
209
213
  // Look for the function body and find all usages of the parameter
210
214
  if (functionPath.isFunction()) {
211
215
  const functionScope = functionPath.scope;
@@ -220,7 +224,7 @@ function findFunctionParameterUsage(functionPath, parameterName, updates, errors
220
224
  const binding = functionScope.bindings[name];
221
225
  if (binding) {
222
226
  binding.referencePaths.forEach((refPath) => {
223
- handleFunctionCall(refPath, updates, errors, file, importMap);
227
+ handleFunctionCall(refPath, updates, errors, file, importMap, ignoreAdditionalData, ignoreDynamicContent);
224
228
  });
225
229
  }
226
230
  });
@@ -299,7 +303,7 @@ function resolveImportPath(currentFile, importPath) {
299
303
  * - export function getInfo(t) { ... }
300
304
  * - const getInfo = (t) => { ... }
301
305
  */
302
- function findFunctionInFile(filePath, functionName, argIndex, updates, errors) {
306
+ function findFunctionInFile(filePath, functionName, argIndex, updates, errors, ignoreAdditionalData, ignoreDynamicContent) {
303
307
  try {
304
308
  const code = fs.readFileSync(filePath, 'utf8');
305
309
  const ast = parse(code, {
@@ -310,7 +314,7 @@ function findFunctionInFile(filePath, functionName, argIndex, updates, errors) {
310
314
  // Handle function declarations: function getInfo(t) { ... }
311
315
  FunctionDeclaration(path) {
312
316
  if (path.node.id?.name === functionName) {
313
- processFunctionIfMatches(functionName, argIndex, path.node, path, updates, errors, filePath);
317
+ processFunctionIfMatches(functionName, argIndex, path.node, path, updates, errors, filePath, ignoreAdditionalData, ignoreDynamicContent);
314
318
  }
315
319
  },
316
320
  // Handle variable declarations: const getInfo = (t) => { ... }
@@ -321,7 +325,7 @@ function findFunctionInFile(filePath, functionName, argIndex, updates, errors) {
321
325
  (t.isArrowFunctionExpression(path.node.init) ||
322
326
  t.isFunctionExpression(path.node.init))) {
323
327
  const initPath = path.get('init');
324
- processFunctionIfMatches(functionName, argIndex, path.node.init, initPath, updates, errors, filePath);
328
+ processFunctionIfMatches(functionName, argIndex, path.node.init, initPath, updates, errors, filePath, ignoreAdditionalData, ignoreDynamicContent);
325
329
  }
326
330
  },
327
331
  });
@@ -348,21 +352,40 @@ export function parseStrings(importName, originalName, path, updates, errors, fi
348
352
  const importMap = buildImportMap(path.scope.getProgramParent().path);
349
353
  const referencePaths = path.scope.bindings[importName]?.referencePaths || [];
350
354
  for (const refPath of referencePaths) {
351
- // Find call expressions of useGT() / await getGT()
355
+ // Handle msg() calls directly without variable assignment
356
+ if (originalName === MSG_TRANSLATION_HOOK) {
357
+ const ignoreAdditionalData = false;
358
+ const ignoreDynamicContent = false;
359
+ // Check if this is a direct call to msg('string')
360
+ if (refPath.parent.type === 'CallExpression' &&
361
+ refPath.parent.callee === refPath.node) {
362
+ processTranslationCall(refPath, updates, errors, file, ignoreAdditionalData, ignoreDynamicContent);
363
+ }
364
+ continue;
365
+ }
366
+ // Handle useGT(), getGT(), useMessages(), and getMessages() calls that need variable assignment
352
367
  const callExpr = refPath.findParent((p) => p.isCallExpression());
353
368
  if (callExpr) {
354
369
  // Get the parent, handling both await and non-await cases
355
370
  const parentPath = callExpr.parentPath;
356
371
  const parentFunction = refPath.getFunctionParent();
357
372
  const asyncScope = parentFunction?.node.async;
358
- if (asyncScope && originalName === 'useGT') {
373
+ if (asyncScope &&
374
+ (originalName === INLINE_TRANSLATION_HOOK ||
375
+ originalName === INLINE_MESSAGE_HOOK)) {
359
376
  errors.push(warnAsyncUseGT(file, `${refPath.node.loc?.start?.line}:${refPath.node.loc?.start?.column}`));
360
377
  return;
361
378
  }
362
- else if (!asyncScope && originalName === 'getGT') {
379
+ else if (!asyncScope &&
380
+ (originalName === INLINE_TRANSLATION_HOOK_ASYNC ||
381
+ originalName === INLINE_MESSAGE_HOOK_ASYNC)) {
363
382
  errors.push(warnSyncGetGT(file, `${refPath.node.loc?.start?.line}:${refPath.node.loc?.start?.column}`));
364
383
  return;
365
384
  }
385
+ const isMessageHook = originalName === INLINE_MESSAGE_HOOK ||
386
+ originalName === INLINE_MESSAGE_HOOK_ASYNC;
387
+ const ignoreAdditionalData = isMessageHook;
388
+ const ignoreDynamicContent = isMessageHook;
366
389
  const effectiveParent = parentPath?.node.type === 'AwaitExpression'
367
390
  ? parentPath.parentPath
368
391
  : parentPath;
@@ -372,10 +395,16 @@ export function parseStrings(importName, originalName, path, updates, errors, fi
372
395
  const tFuncName = effectiveParent.node.id.name;
373
396
  // Get the scope from the variable declaration
374
397
  const variableScope = effectiveParent.scope;
375
- const tReferencePaths = variableScope.bindings[tFuncName]?.referencePaths || [];
376
- for (const tPath of tReferencePaths) {
377
- handleFunctionCall(tPath, updates, errors, file, importMap);
378
- }
398
+ // Resolve all aliases of the translation function
399
+ // Example: translate -> [translate, t, a, b] for const t = translate; const a = t; const b = a;
400
+ const allTranslationNames = resolveVariableAliases(variableScope, tFuncName);
401
+ // Process references for all translation function names and their aliases
402
+ allTranslationNames.forEach((name) => {
403
+ const tReferencePaths = variableScope.bindings[name]?.referencePaths || [];
404
+ for (const tPath of tReferencePaths) {
405
+ handleFunctionCall(tPath, updates, errors, file, importMap, ignoreAdditionalData, ignoreDynamicContent);
406
+ }
407
+ });
379
408
  }
380
409
  }
381
410
  }
@@ -1,4 +1,5 @@
1
1
  import { warnAsyncUseGT, warnSyncGetGT } from '../../../console/index.js';
2
+ import { INLINE_TRANSLATION_HOOK, INLINE_TRANSLATION_HOOK_ASYNC, } from './constants.js';
2
3
  /**
3
4
  * Validate useGT() / await getGT() calls
4
5
  * 1. Validates that the call does not violate the rules of React (no hooks in async functions)
@@ -12,13 +13,13 @@ export function validateStringFunction(localImportName, path, updates, errors, f
12
13
  callPath.node.callee.name === localImportName) {
13
14
  // Check the function scope
14
15
  const functionScope = callPath.getFunctionParent();
15
- if (originalImportName === 'useGT') {
16
+ if (originalImportName === INLINE_TRANSLATION_HOOK) {
16
17
  // useGT should NOT be in an async function
17
18
  if (functionScope && functionScope.node.async) {
18
19
  errors.push(warnAsyncUseGT(file, `${callPath.node.loc?.start?.line}:${callPath.node.loc?.start?.column}`));
19
20
  }
20
21
  }
21
- else if (originalImportName === 'getGT') {
22
+ else if (originalImportName === INLINE_TRANSLATION_HOOK_ASYNC) {
22
23
  // getGT should be in an async function
23
24
  if (!functionScope || !functionScope.node.async) {
24
25
  errors.push(warnSyncGetGT(file, `${callPath.node.loc?.start?.line}:${callPath.node.loc?.start?.column}`));
@@ -8,7 +8,7 @@ import { parseJSXElement } from '../jsx/utils/parseJsx.js';
8
8
  import { parseStrings } from '../jsx/utils/parseStringFunction.js';
9
9
  import { extractImportName } from '../jsx/utils/parseAst.js';
10
10
  import { logError } from '../../console/logging.js';
11
- import { GT_TRANSLATION_FUNCS } from '../jsx/utils/constants.js';
11
+ import { GT_TRANSLATION_FUNCS, INLINE_TRANSLATION_HOOK, INLINE_TRANSLATION_HOOK_ASYNC, INLINE_MESSAGE_HOOK, INLINE_MESSAGE_HOOK_ASYNC, MSG_TRANSLATION_HOOK, } from '../jsx/utils/constants.js';
12
12
  import { matchFiles } from '../../fs/matchFiles.js';
13
13
  import { DEFAULT_SRC_PATTERNS } from '../../config/generateSettings.js';
14
14
  export async function createInlineUpdates(pkg, validate, filePatterns) {
@@ -38,7 +38,11 @@ export async function createInlineUpdates(pkg, validate, filePatterns) {
38
38
  if (path.node.source.value.startsWith(pkg)) {
39
39
  const importName = extractImportName(path.node, pkg, GT_TRANSLATION_FUNCS);
40
40
  for (const name of importName) {
41
- if (name.original === 'useGT' || name.original === 'getGT') {
41
+ if (name.original === INLINE_TRANSLATION_HOOK ||
42
+ name.original === INLINE_TRANSLATION_HOOK_ASYNC ||
43
+ name.original === INLINE_MESSAGE_HOOK ||
44
+ name.original === INLINE_MESSAGE_HOOK_ASYNC ||
45
+ name.original === MSG_TRANSLATION_HOOK) {
42
46
  translationPaths.push({
43
47
  localName: name.local,
44
48
  path,
@@ -65,7 +69,11 @@ export async function createInlineUpdates(pkg, validate, filePatterns) {
65
69
  if (parentPath.isVariableDeclaration()) {
66
70
  const importName = extractImportName(parentPath.node, pkg, GT_TRANSLATION_FUNCS);
67
71
  for (const name of importName) {
68
- if (name.original === 'useGT' || name.original === 'getGT') {
72
+ if (name.original === INLINE_TRANSLATION_HOOK ||
73
+ name.original === INLINE_TRANSLATION_HOOK_ASYNC ||
74
+ name.original === INLINE_MESSAGE_HOOK ||
75
+ name.original === INLINE_MESSAGE_HOOK_ASYNC ||
76
+ name.original === MSG_TRANSLATION_HOOK) {
69
77
  translationPaths.push({
70
78
  localName: name.local,
71
79
  path: parentPath,
@@ -21,6 +21,7 @@ export type Options = {
21
21
  experimentalHideDefaultLocale?: boolean;
22
22
  experimentalFlattenJsonFiles?: boolean;
23
23
  experimentalLocalizeStaticImports?: boolean;
24
+ experimentalAddHeaderAnchorIds?: 'mintlify';
24
25
  };
25
26
  export type TranslateFlags = {
26
27
  config?: string;
@@ -41,6 +42,7 @@ export type TranslateFlags = {
41
42
  experimentalHideDefaultLocale?: boolean;
42
43
  experimentalFlattenJsonFiles?: boolean;
43
44
  experimentalLocalizeStaticImports?: boolean;
45
+ experimentalAddHeaderAnchorIds?: 'mintlify';
44
46
  excludeStaticUrls?: string[];
45
47
  excludeStaticImports?: string[];
46
48
  };
@@ -139,6 +141,7 @@ export type AdditionalOptions = {
139
141
  copyFiles?: string[];
140
142
  experimentalLocalizeStaticImports?: boolean;
141
143
  experimentalLocalizeStaticUrls?: boolean;
144
+ experimentalAddHeaderAnchorIds?: 'mintlify';
142
145
  experimentalHideDefaultLocale?: boolean;
143
146
  experimentalFlattenJsonFiles?: boolean;
144
147
  baseDomain?: string;
@@ -0,0 +1,24 @@
1
+ /**
2
+ * Represents a heading with its position and metadata
3
+ */
4
+ export interface HeadingInfo {
5
+ text: string;
6
+ level: number;
7
+ slug: string;
8
+ position: number;
9
+ }
10
+ /**
11
+ * Extracts heading information from content (read-only, no modifications)
12
+ */
13
+ export declare function extractHeadingInfo(mdxContent: string): HeadingInfo[];
14
+ /**
15
+ * Applies anchor IDs to translated content based on source heading mapping
16
+ */
17
+ export declare function addExplicitAnchorIds(translatedContent: string, sourceHeadingMap: HeadingInfo[], settings?: any, sourcePath?: string, translatedPath?: string): {
18
+ content: string;
19
+ hasChanges: boolean;
20
+ addedIds: Array<{
21
+ heading: string;
22
+ id: string;
23
+ }>;
24
+ };
@@ -0,0 +1,263 @@
1
+ import { unified } from 'unified';
2
+ import remarkParse from 'remark-parse';
3
+ import remarkMdx from 'remark-mdx';
4
+ import remarkFrontmatter from 'remark-frontmatter';
5
+ import remarkStringify from 'remark-stringify';
6
+ import { visit } from 'unist-util-visit';
7
+ import { logErrorAndExit } from '../console/logging.js';
8
+ /**
9
+ * Generates a slug from heading text
10
+ */
11
+ function generateSlug(text) {
12
+ return text
13
+ .toLowerCase()
14
+ .replace(/[^\w\s-]/g, '') // Remove special chars except spaces and hyphens
15
+ .trim()
16
+ .replace(/\s+/g, '-') // Replace spaces with hyphens
17
+ .replace(/-+/g, '-') // Replace multiple hyphens with single hyphen
18
+ .replace(/^-|-$/g, ''); // Remove leading/trailing hyphens
19
+ }
20
+ /**
21
+ * Extracts text content from heading nodes
22
+ */
23
+ function extractHeadingText(heading) {
24
+ let text = '';
25
+ visit(heading, ['text', 'inlineCode'], (node) => {
26
+ if ('value' in node && typeof node.value === 'string') {
27
+ text += node.value;
28
+ }
29
+ });
30
+ return text;
31
+ }
32
+ /**
33
+ * Checks if a heading is already wrapped in a div with id
34
+ */
35
+ function hasExplicitId(heading, ast) {
36
+ const lastChild = heading.children[heading.children.length - 1];
37
+ if (lastChild?.type === 'text') {
38
+ return /(\{#[^}]+\}|\[[^\]]+\])$/.test(lastChild.value);
39
+ }
40
+ return false;
41
+ }
42
+ /**
43
+ * Extracts heading information from content (read-only, no modifications)
44
+ */
45
+ export function extractHeadingInfo(mdxContent) {
46
+ const headings = [];
47
+ // Parse the MDX content into an AST
48
+ let processedAst;
49
+ try {
50
+ const parseProcessor = unified()
51
+ .use(remarkParse)
52
+ .use(remarkFrontmatter, ['yaml', 'toml'])
53
+ .use(remarkMdx);
54
+ const ast = parseProcessor.parse(mdxContent);
55
+ processedAst = parseProcessor.runSync(ast);
56
+ }
57
+ catch (error) {
58
+ console.warn(`Failed to parse MDX content: ${error instanceof Error ? error.message : String(error)}`);
59
+ return [];
60
+ }
61
+ let position = 0;
62
+ visit(processedAst, 'heading', (heading) => {
63
+ const headingText = extractHeadingText(heading);
64
+ if (headingText) {
65
+ const slug = generateSlug(headingText);
66
+ headings.push({
67
+ text: headingText,
68
+ level: heading.depth,
69
+ slug,
70
+ position: position++,
71
+ });
72
+ }
73
+ });
74
+ return headings;
75
+ }
76
+ /**
77
+ * Applies anchor IDs to translated content based on source heading mapping
78
+ */
79
+ export function addExplicitAnchorIds(translatedContent, sourceHeadingMap, settings, sourcePath, translatedPath) {
80
+ const addedIds = [];
81
+ const useDivWrapping = settings?.options?.experimentalAddHeaderAnchorIds === 'mintlify';
82
+ // Extract headings from translated content
83
+ const translatedHeadings = extractHeadingInfo(translatedContent);
84
+ // Pre-processing validation: check if header counts match
85
+ if (sourceHeadingMap.length !== translatedHeadings.length) {
86
+ const sourceFile = sourcePath
87
+ ? `Source file: ${sourcePath}`
88
+ : 'Source file';
89
+ const translatedFile = translatedPath
90
+ ? `translated file: ${translatedPath}`
91
+ : 'translated file';
92
+ logErrorAndExit(`Header count mismatch detected! ${sourceFile} has ${sourceHeadingMap.length} headers but ${translatedFile} has ${translatedHeadings.length} headers. ` +
93
+ `This likely means your source file was edited after translation was requested, causing a mismatch between ` +
94
+ `the number of headers in your source file vs the translated file. Please re-translate this file to resolve the issue.`);
95
+ }
96
+ // Create ID mapping based on positional matching
97
+ const idMappings = new Map();
98
+ sourceHeadingMap.forEach((sourceHeading, index) => {
99
+ const translatedHeading = translatedHeadings[index];
100
+ // Match by position and level for safety
101
+ if (translatedHeading && translatedHeading.level === sourceHeading.level) {
102
+ idMappings.set(index, sourceHeading.slug);
103
+ addedIds.push({
104
+ heading: translatedHeading.text,
105
+ id: sourceHeading.slug,
106
+ });
107
+ }
108
+ });
109
+ if (idMappings.size === 0) {
110
+ return {
111
+ content: translatedContent,
112
+ hasChanges: false,
113
+ addedIds: [],
114
+ };
115
+ }
116
+ // Apply IDs to translated content
117
+ let content;
118
+ if (useDivWrapping) {
119
+ content = applyDivWrappedIds(translatedContent, translatedHeadings, idMappings);
120
+ }
121
+ else {
122
+ content = applyInlineIds(translatedContent, idMappings);
123
+ }
124
+ return {
125
+ content,
126
+ hasChanges: addedIds.length > 0,
127
+ addedIds,
128
+ };
129
+ }
130
+ /**
131
+ * Adds inline {#id} syntax to headings (standard markdown approach)
132
+ */
133
+ function applyInlineIds(translatedContent, idMappings) {
134
+ // Parse the translated content
135
+ let processedAst;
136
+ try {
137
+ const parseProcessor = unified()
138
+ .use(remarkParse)
139
+ .use(remarkFrontmatter, ['yaml', 'toml'])
140
+ .use(remarkMdx);
141
+ const ast = parseProcessor.parse(translatedContent);
142
+ processedAst = parseProcessor.runSync(ast);
143
+ }
144
+ catch (error) {
145
+ console.warn(`Failed to parse translated MDX content: ${error instanceof Error ? error.message : String(error)}`);
146
+ return translatedContent;
147
+ }
148
+ // Apply IDs to headings based on position
149
+ let headingIndex = 0;
150
+ visit(processedAst, 'heading', (heading) => {
151
+ const id = idMappings.get(headingIndex);
152
+ if (id) {
153
+ // Skip if heading already has explicit ID
154
+ if (hasExplicitId(heading, processedAst)) {
155
+ headingIndex++;
156
+ return;
157
+ }
158
+ // Add the ID to the heading
159
+ const lastChild = heading.children[heading.children.length - 1];
160
+ if (lastChild?.type === 'text') {
161
+ lastChild.value += ` {#${id}}`;
162
+ }
163
+ else {
164
+ // If last child is not text, add a new text node
165
+ heading.children.push({
166
+ type: 'text',
167
+ value: ` {#${id}}`,
168
+ });
169
+ }
170
+ }
171
+ headingIndex++;
172
+ });
173
+ // Convert the modified AST back to MDX string
174
+ try {
175
+ const stringifyProcessor = unified()
176
+ .use(remarkStringify, {
177
+ bullet: '-',
178
+ emphasis: '_',
179
+ strong: '*',
180
+ rule: '-',
181
+ ruleRepetition: 3,
182
+ ruleSpaces: false,
183
+ handlers: {
184
+ // Custom handler to prevent escaping of {#id} syntax
185
+ text(node) {
186
+ return node.value;
187
+ },
188
+ },
189
+ })
190
+ .use(remarkFrontmatter, ['yaml', 'toml'])
191
+ .use(remarkMdx);
192
+ let content = stringifyProcessor.stringify(processedAst);
193
+ // Handle newline formatting to match original input
194
+ if (content.endsWith('\n') && !translatedContent.endsWith('\n')) {
195
+ content = content.slice(0, -1);
196
+ }
197
+ // Preserve leading newlines from original content
198
+ if (translatedContent.startsWith('\n') && !content.startsWith('\n')) {
199
+ content = '\n' + content;
200
+ }
201
+ return content;
202
+ }
203
+ catch (error) {
204
+ console.warn(`Failed to stringify translated MDX content: ${error instanceof Error ? error.message : String(error)}`);
205
+ return translatedContent;
206
+ }
207
+ }
208
+ /**
209
+ * Wraps headings in divs with IDs (Mintlify approach)
210
+ */
211
+ function applyDivWrappedIds(translatedContent, translatedHeadings, idMappings) {
212
+ // Extract all heading lines from the translated markdown
213
+ const lines = translatedContent.split('\n');
214
+ const headingLines = [];
215
+ lines.forEach((line, index) => {
216
+ const headingMatch = line.match(/^(#{1,6})\s+(.+)$/);
217
+ if (headingMatch) {
218
+ const level = headingMatch[1].length;
219
+ headingLines.push({ line, level, index });
220
+ }
221
+ });
222
+ // Use string-based approach to wrap headings in divs
223
+ let content = translatedContent;
224
+ const headingsToWrap = [];
225
+ // Match translated headings with their corresponding lines by position and level
226
+ translatedHeadings.forEach((heading, position) => {
227
+ const id = idMappings.get(position);
228
+ if (id) {
229
+ // Find the corresponding original line for this heading
230
+ const matchingLine = headingLines.find((hl) => {
231
+ // Extract clean text from the original line for comparison
232
+ const lineCleanText = hl.line.replace(/^#{1,6}\s+/, '').trim();
233
+ // Create a version without markdown formatting for comparison
234
+ const cleanLineText = lineCleanText
235
+ .replace(/\*\*(.*?)\*\*/g, '$1') // Remove bold
236
+ .replace(/\*(.*?)\*/g, '$1') // Remove italic
237
+ .replace(/`(.*?)`/g, '$1') // Remove inline code
238
+ .replace(/\[(.*?)\]\(.*?\)/g, '$1') // Remove links, keep text
239
+ .trim();
240
+ return cleanLineText === heading.text && hl.level === heading.level;
241
+ });
242
+ if (matchingLine) {
243
+ headingsToWrap.push({
244
+ originalLine: matchingLine.line,
245
+ id,
246
+ });
247
+ }
248
+ }
249
+ });
250
+ if (headingsToWrap.length > 0) {
251
+ // Process headings from longest to shortest original line to avoid partial matches
252
+ const sortedHeadings = headingsToWrap.sort((a, b) => b.originalLine.length - a.originalLine.length);
253
+ for (const heading of sortedHeadings) {
254
+ // Escape the original line for use in regex
255
+ const escapedLine = heading.originalLine.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
256
+ const headingPattern = new RegExp(`^${escapedLine}\\s*$`, 'gm');
257
+ content = content.replace(headingPattern, (match) => {
258
+ return `<div id="${heading.id}">\n ${match.trim()}\n</div>\n`;
259
+ });
260
+ }
261
+ }
262
+ return content;
263
+ }
@@ -87,6 +87,10 @@ export default async function localizeStaticUrls(settings, targetLocales) {
87
87
  * Determines if a URL should be processed based on pattern matching
88
88
  */
89
89
  function shouldProcessUrl(originalUrl, patternHead, targetLocale, defaultLocale, baseDomain) {
90
+ // Check fragment-only URLs like "#id-name"
91
+ if (/^\s*#/.test(originalUrl)) {
92
+ return false;
93
+ }
90
94
  const patternWithoutSlash = patternHead.replace(/\/$/, '');
91
95
  // Handle absolute URLs with baseDomain
92
96
  let urlToCheck = originalUrl;
@@ -0,0 +1,6 @@
1
+ import { Settings } from '../types/index.js';
2
+ /**
3
+ * Processes all translated MD/MDX files to add explicit anchor IDs
4
+ * This preserves navigation links when headings are translated
5
+ */
6
+ export default function processAnchorIds(settings: Settings): Promise<void>;
@@ -0,0 +1,43 @@
1
+ import { addExplicitAnchorIds, extractHeadingInfo, } from './addExplicitAnchorIds.js';
2
+ import { readFile } from '../fs/findFilepath.js';
3
+ import { createFileMapping } from '../formats/files/fileMapping.js';
4
+ import * as fs from 'fs';
5
+ /**
6
+ * Processes all translated MD/MDX files to add explicit anchor IDs
7
+ * This preserves navigation links when headings are translated
8
+ */
9
+ export default async function processAnchorIds(settings) {
10
+ if (!settings.files)
11
+ return;
12
+ const { resolvedPaths, placeholderPaths, transformPaths } = settings.files;
13
+ const fileMapping = createFileMapping(resolvedPaths, placeholderPaths, transformPaths, settings.locales, settings.defaultLocale);
14
+ // Process each locale's translated files
15
+ const processPromises = Object.entries(fileMapping)
16
+ .filter(([locale, filesMap]) => locale !== settings.defaultLocale) // Skip default locale
17
+ .map(async ([locale, filesMap]) => {
18
+ // Get all translated files that are md or mdx
19
+ const translatedFiles = Object.values(filesMap).filter((path) => path && (path.endsWith('.md') || path.endsWith('.mdx')));
20
+ for (const translatedPath of translatedFiles) {
21
+ try {
22
+ // Find the corresponding source file
23
+ const sourcePath = Object.keys(filesMap).find((key) => filesMap[key] === translatedPath);
24
+ if (!sourcePath) {
25
+ continue;
26
+ }
27
+ // Extract heading info from source file
28
+ const sourceContent = readFile(sourcePath);
29
+ const sourceHeadingMap = extractHeadingInfo(sourceContent);
30
+ // Read translated file and apply anchor IDs
31
+ const translatedContent = readFile(translatedPath);
32
+ const result = addExplicitAnchorIds(translatedContent, sourceHeadingMap, settings, sourcePath, translatedPath);
33
+ if (result.hasChanges) {
34
+ fs.writeFileSync(translatedPath, result.content, 'utf8');
35
+ }
36
+ }
37
+ catch (error) {
38
+ console.warn(`Failed to process IDs for ${translatedPath}: ${error instanceof Error ? error.message : String(error)}`);
39
+ }
40
+ }
41
+ });
42
+ await Promise.all(processPromises);
43
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "gtx-cli",
3
- "version": "2.1.8",
3
+ "version": "2.1.10",
4
4
  "main": "dist/index.js",
5
5
  "bin": "dist/main.js",
6
6
  "files": [