Programmatic Usage Examples

// scripts/validate-i18n.ts
import { resolveContext, scanProjectDynamicKeySites } from '@zamdevio/i18nprune/core';
import { exactLiteralKeys } from '@zamdevio/i18nprune/core';
 
const ctx = resolveContext();
const dynamicSites = scanProjectDynamicKeySites(ctx);
 
if (dynamicSites.length > 0) {
  console.warn(`${dynamicSites.length} dynamic translation keys found.`);
  process.exit(1);
}

import {
  resolveContext,
  collectStringLeaves,
  scanSources,
  readJsonFile,
  exactLiteralKeys,
} from '@zamdevio/i18nprune/core';
 
const ctx = resolveContext();
const sourceData = readJsonFile(ctx.paths.sourceLocale);
const usedKeys = new Set(exactLiteralKeys(scanSources(ctx.paths.srcRoot), ctx.config.functions));
 
const unused = collectStringLeaves(sourceData)
  .map((l) => l.path)
  .filter((k) => !usedKeys.has(k));
 
console.log('Unused keys:', unused);

import { defineConfig } from '@zamdevio/i18nprune/config';
 
export default defineConfig({
  source: 'packages/design-system/locales/en.json',
  localesDir: 'packages/design-system/locales',
  src: 'packages/**/*.{ts,tsx}',
  functions: ['t'],
});

import { resolveContext, clearContextCache } from '@zamdevio/i18nprune/core';
 
test('resolves context correctly', () => {
  clearContextCache();
  const ctx = resolveContext(fixturePath);
  expect(ctx.meta.fieldSources.source).toBe('file');
});

import { context, extractor, dynamic, validate, files } from '@zamdevio/i18nprune/core';
 
const ctx = context.resolveContext();
const usage = extractor.scanProjectLiteralKeyUsage(ctx);
const sites = dynamic.scanProjectDynamicKeySites(ctx);
const raw = files.readJsonFile(ctx.paths.sourceLocale);
const missing = validate.computeMissingLiteralKeys(ctx, raw);