Add support for tracking only dictionaries (#67)

* Add support to tracking only dictionaries

* Create ten-lions-rush.md

Author: yanthomasdev

.changeset/ten-lions-rush.md

@@ -0,0 +1,5 @@
+---
+"@lunariajs/core": patch
+---
+
+Add support for tracking only dictionaries

packages/core/config.schema.json

@@ -260,7 +260,7 @@
               "additionalProperties": false
             }
           },
-          "required": ["label", "lang", "content"],
+          "required": ["label", "lang"],
           "additionalProperties": false
         },
         "locales": {

packages/core/src/schemas/locale.ts

@@ -41,24 +41,28 @@ const ContentSchema = z.object({
 		.describe('Array of glob patterns to be ignored from matching.'),
 });
 
-export const LocaleSchema = z.object({
-	/** The label of the locale to show in the status dashboard, e.g. `"English"`, `"Português"`, or `"Español"`. */
-	label: z
-		.string()
-		.describe(
-			'The label of the locale to show in the status dashboard, e.g. `"English"`, `"Português"`, or `"Español"`.'
-		),
-	/** The BCP-47 tag of the locale, both to use in smaller widths and to differentiate regional variants, e.g. `"en-US"` (American English) or `"en-GB"` (British English). */
-	lang: z
-		.string()
-		.describe(
-			'The BCP-47 tag of the locale, both to use in smaller widths and to differentiate regional variants, e.g. `"en-US"` (American English) or `"en-GB"` (British English).'
-		),
-	/** Information about any of your UI dictionaries. */
-	dictionaries: DictionariesSchema,
-	/** Information about your content. */
-	content: ContentSchema,
-});
+export const LocaleSchema = z
+	.object({
+		/** The label of the locale to show in the status dashboard, e.g. `"English"`, `"Português"`, or `"Español"`. */
+		label: z
+			.string()
+			.describe(
+				'The label of the locale to show in the status dashboard, e.g. `"English"`, `"Português"`, or `"Español"`.'
+			),
+		/** The BCP-47 tag of the locale, both to use in smaller widths and to differentiate regional variants, e.g. `"en-US"` (American English) or `"en-GB"` (British English). */
+		lang: z
+			.string()
+			.describe(
+				'The BCP-47 tag of the locale, both to use in smaller widths and to differentiate regional variants, e.g. `"en-US"` (American English) or `"en-GB"` (British English).'
+			),
+		/** Information about any of your UI dictionaries. */
+		dictionaries: DictionariesSchema.optional(),
+		/** Information about your content. */
+		content: ContentSchema.optional(),
+	})
+	.refine((locale) => locale.content || locale.dictionaries, {
+		message: 'A locale needs to include a `dictionaries` or `content` field to be tracked.',
+	});
 
 export type Locale = z.output<typeof LocaleSchema>;
 export type OptionalKeys = z.infer<typeof OptionalKeysSchema>;

packages/core/src/tracker.ts

@@ -122,35 +122,41 @@ export async function getContentIndex(opts: LunariaConfig, isShallowRepo: boolea
 	const pathResolver = getPathResolver(routingStrategy, allLangs);
 
 	for (const { lang, content, dictionaries } of allLocales) {
-		const localeContentPaths = await glob(content.location, {
-			cwd: process.cwd(),
-			ignore: ['node_modules', ...content.ignore],
-		});
-
-		const genericContentIndex = await Promise.all(
-			localeContentPaths.sort().map(async (filePath) => {
-				const sharedPath = pathResolver.toSharedPath(filePath);
-
-				return {
-					lang,
-					filePath,
-					sharedPath,
-					fileData: await getFileData(
-						filePath,
-						isShallowRepo,
-						repository.rootDir,
-						translatableProperty,
-						ignoreKeywords
-					),
-					additionalData: {
-						type: 'generic',
-					},
-				} as IndexData;
-			})
-		);
+		const genericContentIndex = [];
+		if (content) {
+			const { location, ignore } = content;
 
-		const dictionaryContentIndex = [];
+			const localeContentPaths = await glob(location, {
+				cwd: process.cwd(),
+				ignore: ['node_modules', ...ignore],
+			});
 
+			genericContentIndex.push(
+				...(await Promise.all(
+					localeContentPaths.sort().map(async (filePath) => {
+						const sharedPath = pathResolver.toSharedPath(filePath);
+
+						return {
+							lang,
+							filePath,
+							sharedPath,
+							fileData: await getFileData(
+								filePath,
+								isShallowRepo,
+								repository.rootDir,
+								translatableProperty,
+								ignoreKeywords
+							),
+							meta: {
+								type: 'generic',
+							},
+						} as IndexData;
+					})
+				))
+			);
+		}
+
+		const dictionaryContentIndex = [];
 		if (dictionaries) {
 			const { location, ignore, optionalKeys } = dictionaries;
 
@@ -175,7 +181,7 @@ export async function getContentIndex(opts: LunariaConfig, isShallowRepo: boolea
 								translatableProperty,
 								ignoreKeywords
 							),
-							additionalData: {
+							meta: {
 								type: 'dictionary',
 								optionalKeys: optionalKeys,
 							},
@@ -186,12 +192,12 @@ export async function getContentIndex(opts: LunariaConfig, isShallowRepo: boolea
 		}
 
 		[...dictionaryContentIndex, ...genericContentIndex].forEach(
-			({ lang, sharedPath, fileData, additionalData }) => {
+			({ lang, sharedPath, fileData, meta }) => {
 				fileContentIndex[lang] = {
 					...fileContentIndex[lang],
 					[sharedPath]: {
 						...fileData,
-						...additionalData,
+						...meta,
 					},
 				};
 			}

packages/core/src/types.ts

@@ -2,31 +2,31 @@ import type { TemplateResult } from 'lit-html';
 import type { LunariaConfig } from './schemas/config.js';
 import type { OptionalKeys } from './schemas/locale.js';
 
-type DictionaryContentData = {
+type DictionaryContentMeta = {
 	type: 'dictionary';
 	optionalKeys: OptionalKeys;
 };
 
-type GenericContentData = {
+type GenericContentMeta = {
 	type: 'generic';
 };
 
-type AdditionalContentData = DictionaryContentData | GenericContentData;
+type ContentMeta = DictionaryContentMeta | GenericContentMeta;
 
 export type * from './schemas/config.js';
 export type * from './schemas/dashboard.js';
 export type * from './schemas/locale.js';
 export type * from './schemas/misc.js';
 
-export type AugmentedFileData = FileData & AdditionalContentData;
+export type AugmentedFileData = FileData & ContentMeta;
 export type FileContentIndex = Record<string, Record<string, AugmentedFileData>>;
 
 export type IndexData = {
 	lang: string;
 	filePath: string;
 	sharedPath: string;
 	fileData: FileData;
-	additionalData: AdditionalContentData;
+	meta: ContentMeta;
 };
 
 export type FileData = {