Make formatter a required option for config bucket (#4)

k0d13 · web-flow · commit 7b75d7c14154 · 2026-03-30T21:08:54.000+13:00
* Make formatter a required option for config bucket, remove support for non js/ts config files
diff --git a/.changeset/plain-oranges-wonder.md b/.changeset/plain-oranges-wonder.md
@@ -0,0 +1,5 @@
+---
+"@saykit/config": patch
+---
+
+Make formatter a required option for config bucket
diff --git a/examples/carbon-tsdown/package.json b/examples/carbon-tsdown/package.json
@@ -18,6 +18,7 @@
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20260210.0",
     "@saykit/config": "workspace:^",
+    "@saykit/format-po": "workspace:^",
     "typescript": "^5.9.3",
     "unplugin-saykit": "workspace:^",
     "wrangler": "^4.64.0"
diff --git a/examples/carbon-tsdown/saykit.config.json b/examples/carbon-tsdown/saykit.config.json
diff --git a/examples/carbon-tsdown/saykit.config.ts b/examples/carbon-tsdown/saykit.config.ts
@@ -0,0 +1,14 @@
+import { defineConfig } from '@saykit/config';
+import createFormatter from '@saykit/format-po';
+
+export default defineConfig({
+  sourceLocale: 'en',
+  locales: ['en', 'fr'],
+  buckets: [
+    {
+      include: ['src/**/*.{ts,tsx}'],
+      output: 'src/locales/{locale}/messages.{extension}',
+      formatter: createFormatter(),
+    },
+  ],
+});
diff --git a/examples/nextjs-babel/package.json b/examples/nextjs-babel/package.json
@@ -20,6 +20,7 @@
   "devDependencies": {
     "@saykit/babel-plugin": "workspace:^",
     "@saykit/config": "workspace:^",
+    "@saykit/format-po": "workspace:^",
     "@types/react": "^19.2.13"
   }
 }
diff --git a/examples/nextjs-babel/saykit.config.ts b/examples/nextjs-babel/saykit.config.ts
@@ -1,4 +1,5 @@
 import { defineConfig } from '@saykit/config';
+import createFormatter from '@saykit/format-po';
 
 export default defineConfig({
   sourceLocale: 'en',
@@ -7,6 +8,7 @@ export default defineConfig({
     {
       include: ['src/**/*.{ts,tsx}'],
       output: 'src/locales/{locale}/messages.{extension}',
+      formatter: createFormatter(),
     },
   ],
 });
diff --git a/packages/config/package.json b/packages/config/package.json
@@ -45,7 +45,6 @@
     "@commander-js/extra-typings": "^14.0.0",
     "@saykit/babel-plugin": "workspace:*",
     "commander": "^14.0.3",
-    "neverthrow": "^8.2.0",
     "picomatch": "^4.0.3",
     "zod": "^4.3.6"
   },
diff --git a/packages/config/src/features/compile.ts b/packages/config/src/features/compile.ts
@@ -63,7 +63,7 @@ export async function writeTranslationsToDisk(
   bucket: Bucket,
   locale: string,
   translations: Record<string, string>,
-  path = expandOutputPath(bucket, locale, 'json'),
+  path = expandOutputPath(bucket, locale, '.json'),
 ) {
   const content = JSON.stringify(translations, null, 2);
   await mkdir(dirname(path), { recursive: true });
diff --git a/packages/config/src/features/extract.ts b/packages/config/src/features/extract.ts
@@ -72,7 +72,7 @@ export function expandOutputPath(
 ) {
   const outputMessageTemplate = bucket.output
     .replaceAll('{locale}', locale)
-    .replaceAll('{extension}', extension);
+    .replaceAll('{extension}', extension.slice(1));
   return resolve(outputMessageTemplate);
 }
 
diff --git a/packages/config/src/features/loader/explorer.ts b/packages/config/src/features/loader/explorer.ts
@@ -3,26 +3,12 @@ import { join } from 'node:path';
 
 function getFilesToTry<Name extends string>(name: Name) {
   return [
-    `.${name}rc`,
-    `.${name}rc.json`,
-    `.${name}rc.yaml`,
-    `.${name}rc.yml`,
-    `.${name}rc.js`,
-    `.${name}rc.cjs`,
-    `.${name}rc.mjs`,
-    `.${name}rc.ts`,
-    `.${name}rc.mts`,
-    `.${name}rc.cts`,
-
-    `${name}.config.json`,
     `${name}.config.js`,
     `${name}.config.cjs`,
     `${name}.config.mjs`,
     `${name}.config.ts`,
     `${name}.config.mts`,
     `${name}.config.cts`,
-
-    'package.json',
   ] as const;
 }
 
diff --git a/packages/config/src/features/loader/loaders.ts b/packages/config/src/features/loader/loaders.ts
@@ -24,112 +24,6 @@ export const js: Loader = async (path, _content) => {
   }
 };
 
-export const json: Loader = async (_path, content) => {
-  try {
-    return JSON.parse(content);
-  } catch (error) {
-    throw new Error('Failed to parse JSON', {
-      cause: error,
-    });
-  }
-};
-
-namespace YAML {
-  type YAMLValue = string | number | boolean | null | YAMLObject | YAMLArray;
-  type YAMLObject = { [key: string]: YAMLValue };
-  type YAMLArray = YAMLValue[];
-
-  type StackFrame = { indent: number; container: YAMLObject | YAMLArray };
-
-  export function parse(text: string) {
-    const lines = text
-      .split(/\r?\n/)
-      .filter((l) => l.trim() !== '')
-      .map((l) => [l.match(/^\s*/)![0].length, l] as const);
-    const root: YAMLObject = {};
-    const stack: [StackFrame, ...StackFrame[]] = [{ indent: -1, container: root }];
-
-    function parseValue(value: string, fallback?: YAMLValue): YAMLValue {
-      if (value === 'true') return true;
-      if (value === 'false') return false;
-      if (!Number.isNaN(Number(value)) && value !== '') return Number(value);
-      if (value.startsWith('[') && value.endsWith(']')) {
-        return value
-          .slice(1, -1)
-          .split(',')
-          .map((e) => parseValue(e.trim()));
-      }
-      return value || fallback || value;
-    }
-
-    for (let [indent, line] of lines) {
-      const parent = stack.at(-1)!;
-      while (stack.length > 1 && indent <= parent.indent) stack.pop();
-
-      if (line.startsWith('- ')) {
-        line = line.slice(2).trim();
-
-        let value: YAMLValue;
-        if (line === '') {
-          value = {};
-        } else if (line.includes(':')) {
-          const [k, ...r] = line.split(':');
-          value = { [k!.trim()]: parseValue(r.join(':').trim()) };
-        } else {
-          value = parseValue(line);
-        }
-
-        if (!Array.isArray(parent.container)) {
-          const upper = stack.at(-2)!;
-
-          if (!Array.isArray(upper.container)) {
-            for (const key in upper.container) {
-              if (upper.container[key] === parent.container) {
-                upper.container[key] = [value];
-                stack.push({ indent, container: upper.container[key] });
-                break;
-              }
-            }
-          } else {
-            throw new Error('Invalid YAML: expected parent object for array conversion');
-          }
-        } else {
-          parent.container.push(value);
-        }
-
-        if (typeof value === 'object' && value && !Array.isArray(value)) {
-          stack.push({ indent, container: value });
-        }
-      } else {
-        const [key, ...rest] = line.split(':');
-        const value = parseValue(rest.join(':').trim(), {});
-
-        if (!Array.isArray(parent.container)) {
-          parent.container[key!.trim()] = value;
-        } else {
-          throw new Error('Invalid YAML: cannot assign key to non-object');
-        }
-
-        if (typeof value === 'object' && value && !Array.isArray(value)) {
-          stack.push({ indent, container: value });
-        }
-      }
-    }
-
-    return root;
-  }
-}
-
-export const yaml: Loader = async (_path, content) => {
-  try {
-    return YAML.parse(content);
-  } catch (error) {
-    throw new Error('Failed to parse YAML', {
-      cause: error,
-    });
-  }
-};
-
 export const ts: Loader = async (path, content) => {
   const ts = await import('typescript');
   const outputPath = `${path}.${Date.now()}.js`;
@@ -161,26 +55,10 @@ export const ts: Loader = async (path, content) => {
   }
 };
 
-export const detect: Loader = async (path, content) => {
-  try {
-    return await yaml(path, content);
-  } catch {
-    try {
-      return await json(path, content);
-    } catch {
-      return undefined;
-    }
-  }
-};
-
 export default Object.freeze({
   '.js': js,
   '.mjs': js,
   '.cjs': js,
-  '.json': json,
-  '.yaml': yaml,
-  '.yml': yaml,
-  '': detect,
   '.ts': ts,
   '.mts': ts,
   '.cts': ts,
diff --git a/packages/config/src/features/loader/resolve.ts b/packages/config/src/features/loader/resolve.ts
@@ -8,7 +8,8 @@ export async function useConfig(name = 'saykit') {
   if (!file) throw new Error(`Could not find config file for "${name}"`);
 
   const ext = extname(file.id).toLowerCase();
-  const loader = ext in loaders ? loaders[ext as keyof typeof loaders] : loaders[''];
+  const loader = ext in loaders ? loaders[ext as keyof typeof loaders] : null;
+  if (!loader) throw new Error(`Unsupported config file type "${ext}" for "${name}"`);
 
   let config = await loader(file.id, file.content);
   if (!config || typeof config !== 'object') throw new Error(`Invalid config file for "${name}"`);
diff --git a/packages/config/src/shapes.ts b/packages/config/src/shapes.ts
@@ -1,7 +1,3 @@
-import { createRequire } from 'node:module';
-import { join } from 'node:path';
-import { pathToFileURL } from 'node:url';
-import { err, ok } from 'neverthrow';
 import picomatch from 'picomatch';
 import * as z from 'zod';
 
@@ -16,7 +12,7 @@ export const Message = z.object({
 export type Message = z.infer<typeof Message>;
 
 export const Formatter = z.object({
-  extension: z.templateLiteral(['.', z.string()]).transform((v) => v.slice(1)),
+  extension: z.templateLiteral(['.', z.string()]),
   parse: z.custom<(content: string, context: { locale: string }) => Promise<Message[]>>(
     (v) => typeof v === 'function',
   ),
@@ -26,39 +22,12 @@ export const Formatter = z.object({
 });
 export type Formatter = z.infer<typeof Formatter>;
 
-async function tryImport(id: string) {
-  const require = createRequire(join(process.cwd(), 'noop.js'));
-  try {
-    const url = pathToFileURL(require.resolve(id));
-    return ok(await import(url.toString()));
-  } catch {
-    return err(`Cannot find package '${id}', required by saykit`);
-  }
-}
-
 export const Bucket = z
   .object({
     include: z.array(z.string()),
     exclude: z.array(z.string()).optional(),
     output: z.templateLiteral([z.string(), '{locale}', z.string(), '.{extension}']),
-
-    formatter: Formatter.optional().transform(async (formatter, context) => {
-      if (formatter) return formatter;
-
-      const module = await tryImport('@saykit/format-po');
-      if (module.isErr()) {
-        context.addIssue(module.error);
-        return z.NEVER;
-      }
-      formatter = module.value.default();
-
-      const result = Formatter.safeParse(formatter);
-      if (result.error) {
-        for (const issue of result.error.issues) context.addIssue({ ...issue });
-        return z.NEVER;
-      }
-      return result.data;
-    }),
+    formatter: Formatter,
   })
   .transform((v) => ({
     ...v,
@@ -73,8 +42,5 @@ export const Configuration = z
     fallbackLocales: z.record(z.string(), z.array(z.string())).optional(),
     buckets: z.array(Bucket),
   })
-  .refine(
-    (c) => c.sourceLocale === c.locales[0],
-    'sourceLocale must be the same as the first locale',
-  );
+  .refine((c) => c.sourceLocale === c.locales[0], 'sourceLocale must be the same as locales[0]');
 export type Configuration = z.infer<typeof Configuration>;
diff --git a/packages/config/tsdown.config.ts b/packages/config/tsdown.config.ts
@@ -1,18 +1,5 @@
-import { writeFile } from 'node:fs/promises';
 import { defineConfig } from 'tsdown';
 
 export default defineConfig({
   entry: ['src/index.ts', 'src/commands/index.ts'],
-  async onSuccess() {
-    const { Configuration } = await import('./src/shapes.ts');
-    const schema = Configuration.toJSONSchema({
-      target: 'draft-7',
-      io: 'input',
-      unrepresentable: 'any',
-      override(ctx) {
-        if (ctx.path.includes('formatter')) ctx.jsonSchema.type = 'null';
-      },
-    });
-    await writeFile('dist/schema.json', JSON.stringify(schema, null, 2));
-  },
 });
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@saykit/config": patch
 +---
++
 +Make formatter a required option for config bucket
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@`
`20`	`20`	`"devDependencies": {`
`21`	`21`	`"@saykit/babel-plugin": "workspace:^",`
`22`	`22`	`"@saykit/config": "workspace:^",`
	`23`	`+ "@saykit/format-po": "workspace:^",`
`23`	`24`	`"@types/react": "^19.2.13"`
`24`	`25`	`}`
`25`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ export function expandOutputPath(`
`72`	`72`	`) {`
`73`	`73`	`const outputMessageTemplate = bucket.output`
`74`	`74`	`.replaceAll('{locale}', locale)`
`75`		`- .replaceAll('{extension}', extension);`
	`75`	`+ .replaceAll('{extension}', extension.slice(1));`
`76`	`76`	`return resolve(outputMessageTemplate);`
`77`	`77`	`}`
`78`	`78`