@intlayer/cli 3.5.4 → 3.5.5

package/dist/esm/audit/index.mjs

@@ -1,96 +0,0 @@
-import { readFileSync, writeFileSync } from "fs";
-import { join, relative } from "path";
-import { getConfiguration } from "@intlayer/config";
-import { getLocaleName } from "@intlayer/core";
-import { OpenAI } from "openai";
-import pLimit from "p-limit";
-import { getContentDeclaration } from '../listContentDeclaration.mjs';
-const projectPath = process.cwd();
-const getFileContent = (filePath) => {
-  const fileContent = readFileSync(filePath, "utf-8");
-  return fileContent;
-};
-const writeFileContent = (filePath, content) => {
-  writeFileSync(filePath, content);
-};
-const getAbsolutePath = (filePath) => {
-  const absolutePath = join(__dirname, filePath);
-  return absolutePath;
-};
-const FILE_TEMPLATE = {
-  ts: getFileContent(getAbsolutePath("./TS_FORMAT.md")),
-  tsx: getFileContent(getAbsolutePath("./TSX_FORMAT.md")),
-  js: getFileContent(getAbsolutePath("./MJS_FORMAT.md")),
-  mjs: getFileContent(getAbsolutePath("./MJS_FORMAT.md")),
-  cjs: getFileContent(getAbsolutePath("./CJS_FORMAT.md")),
-  jsx: getFileContent(getAbsolutePath("./JSX_FORMAT.md")),
-  json: getFileContent(getAbsolutePath("./JSON_FORMAT.md"))
-};
-const CHAT_GPT_PROMPT = getFileContent(getAbsolutePath("./PROMPT.md"));
-const formatLocaleWithName = (locale) => {
-  const localeName = getLocaleName(locale);
-  return `${locale}: ${localeName}`;
-};
-const auditFile = async (filePath, options) => {
-  try {
-    const relativePath = relative(projectPath, filePath);
-    console.info(`Auditing file: ${relativePath}`);
-    const { internationalization } = getConfiguration();
-    const { defaultLocale, locales } = internationalization;
-    const openai = new OpenAI({
-      apiKey: options?.openAiApiKey
-    });
-    const fileContent = getFileContent(filePath);
-    const splitted = filePath.split(".");
-    const fileExtension = splitted[splitted.length - 1];
-    const prompt = options?.customPrompt ?? CHAT_GPT_PROMPT.replace("{{filePath}}", filePath).replace(
-      "{{defaultLocale}}",
-      `{${formatLocaleWithName(defaultLocale)}}`
-    ).replace(
-      "{{otherLocales}}",
-      `{${locales.map(formatLocaleWithName).join(", ")}}`
-    ).replace(
-      "{{declarationsContentTemplate}}",
-      FILE_TEMPLATE[fileExtension]
-    ).replace("{{fileContent}}", fileContent);
-    const chatCompletion = await openai.chat.completions.create({
-      model: options?.model ?? "gpt-4o-mini",
-      messages: [{ role: "system", content: prompt }]
-    });
-    const newContent = chatCompletion.choices[0].message?.content;
-    if (newContent) {
-      writeFileContent(filePath, newContent);
-      console.info(`${options?.logPrefix ?? ""}File ${relativePath} updated`);
-    }
-    console.info(
-      `${options?.logPrefix ?? ""}${chatCompletion.usage?.total_tokens} tokens used in the request`
-    );
-  } catch (error) {
-    console.error(error);
-  }
-};
-const audit = async (options) => {
-  if (!options?.openAiApiKey) {
-    console.error(
-      "OpenAI API key is required to audit the content declaration files."
-    );
-    return;
-  }
-  let contentDeclarationFilesList = options?.files;
-  if (!contentDeclarationFilesList) {
-    const contentDeclarationFilesPath = getContentDeclaration({
-      exclude: options?.excludedGlobs
-    });
-    contentDeclarationFilesList = contentDeclarationFilesPath;
-  }
-  const limit = pLimit(options?.asyncLimit ? Number(options?.asyncLimit) : 5);
-  const pushPromises = contentDeclarationFilesList.map(
-    (filePath) => limit(() => auditFile(filePath, options))
-  );
-  await Promise.all(pushPromises);
-};
-export {
-  audit,
-  auditFile
-};
-//# sourceMappingURL=index.mjs.map

package/dist/esm/audit/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../../../src/audit/index.ts"],"sourcesContent":["import { readFileSync, writeFileSync } from 'fs';\nimport { join, relative } from 'path';\nimport { getConfiguration, Locales } from '@intlayer/config';\nimport { getLocaleName } from '@intlayer/core';\nimport { OpenAI } from 'openai';\nimport pLimit from 'p-limit';\nimport { getContentDeclaration } from '../listContentDeclaration';\n\n// Depending on your implementation, you may need the OpenAI API client.\n// For instance, you can use `openai` npm package (https://www.npmjs.com/package/openai).\n\ntype AuditOptions = {\n  files?: string[];\n  logPrefix?: string;\n  model?: string;\n  customPrompt?: string;\n  asyncLimit?: number;\n  openAiApiKey?: string;\n  excludedGlobs?: string[];\n};\n\nconst projectPath = process.cwd();\n\n/**\n * Reads the content of a file synchronously.\n *\n * @function\n * @param filePath - The relative or absolute path to the target file.\n * @returns The entire contents of the specified file as a UTF-8 encoded string.\n */\nconst getFileContent = (filePath: string): string => {\n  // Read the file content using Node.js fs module.\n  const fileContent = readFileSync(filePath, 'utf-8');\n  return fileContent;\n};\n\nconst writeFileContent = (filePath: string, content: string) => {\n  writeFileSync(filePath, content);\n};\n\nconst getAbsolutePath = (filePath: string): string => {\n  const absolutePath = join(__dirname, filePath);\n\n  return absolutePath;\n};\n\nconst FILE_TEMPLATE: Record<string, string> = {\n  ts: getFileContent(getAbsolutePath('./TS_FORMAT.md')),\n  tsx: getFileContent(getAbsolutePath('./TSX_FORMAT.md')),\n  js: getFileContent(getAbsolutePath('./MJS_FORMAT.md')),\n  mjs: getFileContent(getAbsolutePath('./MJS_FORMAT.md')),\n  cjs: getFileContent(getAbsolutePath('./CJS_FORMAT.md')),\n  jsx: getFileContent(getAbsolutePath('./JSX_FORMAT.md')),\n  json: getFileContent(getAbsolutePath('./JSON_FORMAT.md')),\n};\n\n// The prompt template to send to ChatGPT, requesting an audit of content declaration files.\nconst CHAT_GPT_PROMPT = getFileContent(getAbsolutePath('./PROMPT.md'));\n\n/**\n * Formats a locale with its full name and returns a string representation.\n *\n * @function\n * @param locale - A locale from the project's configuration (e.g., 'en-US', 'fr-FR').\n * @returns A formatted string combining the locale's name and code. Example: \"English (US): en-US\".\n */\nconst formatLocaleWithName = (locale: Locales): string => {\n  // getLocaleName returns a human-readable name for the locale.\n  const localeName = getLocaleName(locale);\n\n  // Concatenate both the readable name and the locale code.\n  return `${locale}: ${localeName}`;\n};\n\n/**\n * Audits a content declaration file by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n * @async\n * @function\n * @param filePath - The relative or absolute path to the target file.\n * @param options - Optional configuration for the audit process.\n * @returns This function returns a Promise that resolves once the audit is complete.\n */\nexport const auditFile = async (filePath: string, options?: AuditOptions) => {\n  try {\n    const relativePath = relative(projectPath, filePath);\n    console.info(`Auditing file: ${relativePath}`);\n\n    // Extract internationalization configuration, including locales and the default locale.\n    const { internationalization } = getConfiguration();\n    const { defaultLocale, locales } = internationalization;\n\n    // Optionally, you could initialize and configure the OpenAI client here, if you intend to make API calls.\n    // Uncomment and configure the following lines if you have `openai` installed and want to call the API:\n\n    const openai = new OpenAI({\n      apiKey: options?.openAiApiKey,\n    });\n\n    // Read the file's content.\n    const fileContent = getFileContent(filePath);\n    const splitted = filePath.split('.');\n    const fileExtension = splitted[splitted.length - 1];\n\n    // Prepare the prompt for ChatGPT by replacing placeholders with actual values.\n    const prompt =\n      options?.customPrompt ??\n      CHAT_GPT_PROMPT.replace('{{filePath}}', filePath)\n        .replace(\n          '{{defaultLocale}}',\n          `{${formatLocaleWithName(defaultLocale)}}`\n        )\n        .replace(\n          '{{otherLocales}}',\n          `{${locales.map(formatLocaleWithName).join(', ')}}`\n        )\n        .replace(\n          '{{declarationsContentTemplate}}',\n          FILE_TEMPLATE[fileExtension]\n        )\n        .replace('{{fileContent}}', fileContent);\n\n    // Example of how you might request a completion from ChatGPT:\n    const chatCompletion = await openai.chat.completions.create({\n      model: options?.model ?? 'gpt-4o-mini',\n      messages: [{ role: 'system', content: prompt }],\n    });\n\n    const newContent = chatCompletion.choices[0].message?.content;\n\n    if (newContent) {\n      writeFileContent(filePath, newContent);\n\n      console.info(`${options?.logPrefix ?? ''}File ${relativePath} updated`);\n    }\n\n    console.info(\n      `${options?.logPrefix ?? ''}${chatCompletion.usage?.total_tokens} tokens used in the request`\n    );\n  } catch (error) {\n    console.error(error);\n  }\n};\n\n/**\n * Audits the content declaration files by constructing a prompt for ChatGPT.\n * The prompt includes details about the project's locales, file paths of content declarations,\n * and requests for identifying issues or inconsistencies. It prints the prompt for each file,\n * and could be adapted to send requests to the ChatGPT model.\n *\n * @async\n * @function\n * @param options - Optional configuration for the audit process.\n * @returns This function returns a Promise that resolves once the audit is complete.\n */\nexport const audit = async (options: AuditOptions) => {\n  if (!options?.openAiApiKey) {\n    console.error(\n      'OpenAI API key is required to audit the content declaration files.'\n    );\n    return;\n  }\n\n  let contentDeclarationFilesList = options?.files;\n\n  if (!contentDeclarationFilesList) {\n    // Retrieve all content declaration file paths using a helper function.\n    const contentDeclarationFilesPath = getContentDeclaration({\n      exclude: options?.excludedGlobs,\n    });\n\n    contentDeclarationFilesList = contentDeclarationFilesPath;\n  }\n\n  const limit = pLimit(options?.asyncLimit ? Number(options?.asyncLimit) : 5); // Limit the number of concurrent requests\n  const pushPromises = contentDeclarationFilesList.map((filePath) =>\n    limit(() => auditFile(filePath, options))\n  );\n  await Promise.all(pushPromises);\n};\n"],"mappings":"AAAA,SAAS,cAAc,qBAAqB;AAC5C,SAAS,MAAM,gBAAgB;AAC/B,SAAS,wBAAiC;AAC1C,SAAS,qBAAqB;AAC9B,SAAS,cAAc;AACvB,OAAO,YAAY;AACnB,SAAS,6BAA6B;AAetC,MAAM,cAAc,QAAQ,IAAI;AAShC,MAAM,iBAAiB,CAAC,aAA6B;AAEnD,QAAM,cAAc,aAAa,UAAU,OAAO;AAClD,SAAO;AACT;AAEA,MAAM,mBAAmB,CAAC,UAAkB,YAAoB;AAC9D,gBAAc,UAAU,OAAO;AACjC;AAEA,MAAM,kBAAkB,CAAC,aAA6B;AACpD,QAAM,eAAe,KAAK,WAAW,QAAQ;AAE7C,SAAO;AACT;AAEA,MAAM,gBAAwC;AAAA,EAC5C,IAAI,eAAe,gBAAgB,gBAAgB,CAAC;AAAA,EACpD,KAAK,eAAe,gBAAgB,iBAAiB,CAAC;AAAA,EACtD,IAAI,eAAe,gBAAgB,iBAAiB,CAAC;AAAA,EACrD,KAAK,eAAe,gBAAgB,iBAAiB,CAAC;AAAA,EACtD,KAAK,eAAe,gBAAgB,iBAAiB,CAAC;AAAA,EACtD,KAAK,eAAe,gBAAgB,iBAAiB,CAAC;AAAA,EACtD,MAAM,eAAe,gBAAgB,kBAAkB,CAAC;AAC1D;AAGA,MAAM,kBAAkB,eAAe,gBAAgB,aAAa,CAAC;AASrE,MAAM,uBAAuB,CAAC,WAA4B;AAExD,QAAM,aAAa,cAAc,MAAM;AAGvC,SAAO,GAAG,MAAM,KAAK,UAAU;AACjC;AAcO,MAAM,YAAY,OAAO,UAAkB,YAA2B;AAC3E,MAAI;AACF,UAAM,eAAe,SAAS,aAAa,QAAQ;AACnD,YAAQ,KAAK,kBAAkB,YAAY,EAAE;AAG7C,UAAM,EAAE,qBAAqB,IAAI,iBAAiB;AAClD,UAAM,EAAE,eAAe,QAAQ,IAAI;AAKnC,UAAM,SAAS,IAAI,OAAO;AAAA,MACxB,QAAQ,SAAS;AAAA,IACnB,CAAC;AAGD,UAAM,cAAc,eAAe,QAAQ;AAC3C,UAAM,WAAW,SAAS,MAAM,GAAG;AACnC,UAAM,gBAAgB,SAAS,SAAS,SAAS,CAAC;AAGlD,UAAM,SACJ,SAAS,gBACT,gBAAgB,QAAQ,gBAAgB,QAAQ,EAC7C;AAAA,MACC;AAAA,MACA,IAAI,qBAAqB,aAAa,CAAC;AAAA,IACzC,EACC;AAAA,MACC;AAAA,MACA,IAAI,QAAQ,IAAI,oBAAoB,EAAE,KAAK,IAAI,CAAC;AAAA,IAClD,EACC;AAAA,MACC;AAAA,MACA,cAAc,aAAa;AAAA,IAC7B,EACC,QAAQ,mBAAmB,WAAW;AAG3C,UAAM,iBAAiB,MAAM,OAAO,KAAK,YAAY,OAAO;AAAA,MAC1D,OAAO,SAAS,SAAS;AAAA,MACzB,UAAU,CAAC,EAAE,MAAM,UAAU,SAAS,OAAO,CAAC;AAAA,IAChD,CAAC;AAED,UAAM,aAAa,eAAe,QAAQ,CAAC,EAAE,SAAS;AAEtD,QAAI,YAAY;AACd,uBAAiB,UAAU,UAAU;AAErC,cAAQ,KAAK,GAAG,SAAS,aAAa,EAAE,QAAQ,YAAY,UAAU;AAAA,IACxE;AAEA,YAAQ;AAAA,MACN,GAAG,SAAS,aAAa,EAAE,GAAG,eAAe,OAAO,YAAY;AAAA,IAClE;AAAA,EACF,SAAS,OAAO;AACd,YAAQ,MAAM,KAAK;AAAA,EACrB;AACF;AAaO,MAAM,QAAQ,OAAO,YAA0B;AACpD,MAAI,CAAC,SAAS,cAAc;AAC1B,YAAQ;AAAA,MACN;AAAA,IACF;AACA;AAAA,EACF;AAEA,MAAI,8BAA8B,SAAS;AAE3C,MAAI,CAAC,6BAA6B;AAEhC,UAAM,8BAA8B,sBAAsB;AAAA,MACxD,SAAS,SAAS;AAAA,IACpB,CAAC;AAED,kCAA8B;AAAA,EAChC;AAEA,QAAM,QAAQ,OAAO,SAAS,aAAa,OAAO,SAAS,UAAU,IAAI,CAAC;AAC1E,QAAM,eAAe,4BAA4B;AAAA,IAAI,CAAC,aACpD,MAAM,MAAM,UAAU,UAAU,OAAO,CAAC;AAAA,EAC1C;AACA,QAAM,QAAQ,IAAI,YAAY;AAChC;","names":[]}

package/dist/types/audit/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/audit/index.ts"],"names":[],"mappings":"AAWA,KAAK,YAAY,GAAG;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAuDF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,aAAoB,MAAM,YAAY,YAAY,kBA2DvE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,YAAmB,YAAY,kBAwBhD,CAAC"}