feat: display names

Author: davidturnbull

packages/cli/src/cli/loaders/index.ts

@@ -66,17 +66,21 @@ export type BucketLoaderContext = {
 };
 
 export type Bucket = {
+  displayName: string;
   supportsFormatter: boolean;
   supportsInjectLocale: boolean;
   supportsLockedKeys: boolean;
   supportsIgnoredKeys: boolean;
   supportsLockedPatterns: boolean;
   supportsLocalePlaceholder: boolean;
-  createLoader: (ctx: BucketLoaderContext) => ILoader<void, Record<string, any>>;
+  createLoader: (
+    ctx: BucketLoaderContext,
+  ) => ILoader<void, Record<string, any>>;
 };
 
 export const BUCKETS: Record<string, Bucket> = {
   android: {
+    displayName: "Android XML",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -94,6 +98,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   csv: {
+    displayName: "CSV",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -111,6 +116,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   html: {
+    displayName: "HTML",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -120,13 +126,18 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "html", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "html",
+          ctx.bucketPathPattern,
+        ),
         createHtmlLoader(),
         createSyncLoader(),
         createUnlocalizableLoader(ctx.options.returnUnlocalizedKeys),
       ),
   },
   ejs: {
+    displayName: "EJS",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -142,6 +153,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   json: {
+    displayName: "JSON",
     supportsFormatter: true,
     supportsInjectLocale: true,
     supportsLockedKeys: true,
@@ -151,7 +163,11 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "json", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "json",
+          ctx.bucketPathPattern,
+        ),
         createJsonLoader(),
         createEnsureKeyOrderLoader(),
         createFlatLoader(),
@@ -163,6 +179,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   json5: {
+    displayName: "JSON5",
     supportsFormatter: false,
     supportsInjectLocale: true,
     supportsLockedKeys: true,
@@ -183,6 +200,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   jsonc: {
+    displayName: "JSONC",
     supportsFormatter: false,
     supportsInjectLocale: true,
     supportsLockedKeys: true,
@@ -203,6 +221,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   markdown: {
+    displayName: "Markdown",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -212,13 +231,18 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "markdown", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "markdown",
+          ctx.bucketPathPattern,
+        ),
         createMarkdownLoader(),
         createSyncLoader(),
         createUnlocalizableLoader(ctx.options.returnUnlocalizedKeys),
       ),
   },
   markdoc: {
+    displayName: "Markdoc",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -236,6 +260,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   mdx: {
+    displayName: "MDX",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: true,
@@ -245,7 +270,11 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "mdx", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "mdx",
+          ctx.bucketPathPattern,
+        ),
         createMdxCodePlaceholderLoader(),
         createMdxLockedPatternsLoader(ctx.lockedPatterns),
         createMdxFrontmatterSplitLoader(),
@@ -260,6 +289,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   po: {
+    displayName: "PO",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -278,6 +308,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   properties: {
+    displayName: "Properties",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -293,6 +324,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "xcode-strings": {
+    displayName: "Xcode Strings",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -308,6 +340,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "xcode-stringsdict": {
+    displayName: "Xcode Stringsdict",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -325,6 +358,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "xcode-xcstrings": {
+    displayName: "Xcode XCStrings",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: true,
@@ -347,6 +381,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "xcode-xcstrings-v2": {
+    displayName: "Xcode XCStrings (v2)",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: true,
@@ -369,6 +404,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   yaml: {
+    displayName: "YAML",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: true,
@@ -378,7 +414,11 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "yaml", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "yaml",
+          ctx.bucketPathPattern,
+        ),
         createYamlLoader(),
         createFlatLoader(),
         createEnsureKeyOrderLoader(),
@@ -389,6 +429,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "yaml-root-key": {
+    displayName: "YAML Root Key",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -398,7 +439,11 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "yaml", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "yaml",
+          ctx.bucketPathPattern,
+        ),
         createYamlLoader(),
         createRootKeyLoader(true),
         createFlatLoader(),
@@ -408,6 +453,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   flutter: {
+    displayName: "Flutter ARB",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -417,7 +463,11 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "json", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "json",
+          ctx.bucketPathPattern,
+        ),
         createJsonLoader(),
         createEnsureKeyOrderLoader(),
         createFlutterLoader(),
@@ -427,6 +477,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   xliff: {
+    displayName: "XLIFF",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -444,6 +495,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   xml: {
+    displayName: "XML",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -461,6 +513,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   srt: {
+    displayName: "SRT",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -476,6 +529,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   dato: {
+    displayName: "DatoCMS",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -492,6 +546,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   vtt: {
+    displayName: "WebVTT",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -507,6 +562,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   php: {
+    displayName: "PHP",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -524,6 +580,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "vue-json": {
+    displayName: "Vue I18n",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -541,6 +598,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   typescript: {
+    displayName: "TypeScript",
     supportsFormatter: true,
     supportsInjectLocale: false,
     supportsLockedKeys: true,
@@ -565,6 +623,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   txt: {
+    displayName: "Plain text",
     supportsFormatter: false,
     supportsInjectLocale: false,
     supportsLockedKeys: false,
@@ -580,6 +639,7 @@ export const BUCKETS: Record<string, Bucket> = {
       ),
   },
   "json-dictionary": {
+    displayName: "JSON Dictionary",
     supportsFormatter: true,
     supportsInjectLocale: true,
     supportsLockedKeys: true,
@@ -589,7 +649,11 @@ export const BUCKETS: Record<string, Bucket> = {
     createLoader: (ctx) =>
       composeLoaders(
         createTextFileLoader(ctx.bucketPathPattern),
-        createFormatterLoader(ctx.options.formatter, "json", ctx.bucketPathPattern),
+        createFormatterLoader(
+          ctx.options.formatter,
+          "json",
+          ctx.bucketPathPattern,
+        ),
         createJsonLoader(),
         createJsonKeysLoader(),
         createEnsureKeyOrderLoader(),