Rename and mark config exports as const

jerboa88 · jerboa88 · commit a2b8959e62ea · 2024-12-22T19:56:04.000-07:00
diff --git a/src/config/color-mappings.ts b/src/config/color-mappings.ts
@@ -3,9 +3,9 @@
 	---------------------------------------------------
 */
 
-import type { ColorMappingsConfig } from '../types/other';
+import type { ColorMappingsConfig } from '../types/other.ts';
 
-export const colorMappingsConfig: ColorMappingsConfig = {
+export const COLOR_MAPPINGS_CONFIG: ColorMappingsConfig = {
 	default: 'bg-rose-600',
 	projectType: {
 		'android app': 'bg-lime-600',
@@ -26,4 +26,4 @@ export const colorMappingsConfig: ColorMappingsConfig = {
 		internship: 'bg-rose-600',
 		'summer job': 'bg-rose-600',
 	},
-};
+} as const;
diff --git a/src/config/content/roles.ts b/src/config/content/roles.ts
@@ -5,7 +5,7 @@
 
 import { RoleType, type RolesConfig } from '../../types/content/roles.ts';
 
-export const rolesConfig: RolesConfig = {
+export const ROLES_CONFIG: RolesConfig = {
 	[RoleType.Employment]: [
 		{
 			type: 'internship',
@@ -136,4 +136,4 @@ export const rolesConfig: RolesConfig = {
 			],
 		},
 	],
-};
+} as const;
diff --git a/src/config/content/skills.ts b/src/config/content/skills.ts
@@ -5,7 +5,7 @@
 
 import { SkillType, type SkillsConfig } from '../../types/content/skills.ts';
 
-export const skillsConfig: SkillsConfig = {
+export const SKILLS_CONFIG: SkillsConfig = {
 	[SkillType.Languages]: [
 		'Bash',
 		'C/C++',
@@ -70,4 +70,4 @@ export const skillsConfig: SkillsConfig = {
 		'OOP',
 		'Unit Testing',
 	],
-};
+} as const;
diff --git a/src/config/external-services.ts b/src/config/external-services.ts
@@ -3,11 +3,11 @@
 	-------------------------------------------
 */
 
-import type { ExternalServicesConfig } from '../types/other';
+import type { ExternalServicesConfig } from '../types/other.ts';
 
 // TODO: Move these values to constants instead
 
-export const externalServicesConfig: ExternalServicesConfig = {
+export const EXTERNAL_SERVICES_CONFIG: ExternalServicesConfig = {
 	botpoisonPublicKey: 'pk_eca5c4ea-ccb4-46da-beb0-15c581b6980e',
 	contactFormPostUrl: 'https://submit-form.com/re6Xbd2gs',
-};
+} as const;
diff --git a/src/config/metadata/pages.ts b/src/config/metadata/pages.ts
@@ -11,7 +11,7 @@ import {
 	RESUME_PATH,
 } from '../constants.ts';
 
-export const pagesMetadataConfig: PagesMetadataConfig = {
+export const PAGES_METADATA_CONFIG: PagesMetadataConfig = {
 	[PRIVACY_POLICY_PATH]: {
 		title: 'Privacy Policy',
 		shortTitle: 'Privacy',
@@ -35,4 +35,4 @@ export const pagesMetadataConfig: PagesMetadataConfig = {
 		shortTitle: '404',
 		description: "Oof, there's nothing here.",
 	},
-};
+} as const;
diff --git a/src/config/metadata/site.ts b/src/config/metadata/site.ts
@@ -5,7 +5,7 @@
 
 import type { SiteMetadataConfig } from '../../types/other.ts';
 
-export const siteMetadataConfig: SiteMetadataConfig = {
+export const SITE_METADATA_CONFIG: SiteMetadataConfig = {
 	iconPath: 'images/icon.svg',
 	siteUrl: 'https://johng.io/',
 	sourceUrl: 'https://github.com/jerboa88/jerboa88.github.io/',
@@ -29,4 +29,4 @@ export const siteMetadataConfig: SiteMetadataConfig = {
 			country: 'Canada',
 		},
 	},
-};
+} as const;
diff --git a/src/config/social-images-generation.ts b/src/config/social-images-generation.ts
@@ -8,7 +8,7 @@ import {
 	type SocialImagesGenerationConfig,
 } from '../types/other.ts';
 
-export const socialImagesGenerationConfig: SocialImagesGenerationConfig = {
+export const SOCIAL_IMAGES_GENERATION_CONFIG: SocialImagesGenerationConfig = {
 	defaults: {
 		type: 'webp',
 		quality: 100,
@@ -28,4 +28,4 @@ export const socialImagesGenerationConfig: SocialImagesGenerationConfig = {
 			},
 		},
 	},
-};
+} as const;
diff --git a/src/config/themes.ts b/src/config/themes.ts
@@ -3,9 +3,9 @@
 	---------------------------
 */
 
-import { ThemeType, type ThemesConfig } from '../types/other';
+import { ThemeType, type ThemesConfig } from '../types/other.ts';
 
-export const themesConfig: ThemesConfig = {
+export const THEMES_CONFIG: ThemesConfig = {
 	[ThemeType.Light]: {
 		primary: '#0F766E', // TW Teal 700
 		secondary: '#E11D48', // TW Rose 600
@@ -36,4 +36,4 @@ export const themesConfig: ThemesConfig = {
 		'base-content': '#FFF', // Pure white
 		'neutral-content': '#E5E5E5', // TW Neutral 200
 	},
-};
+} as const;
diff --git a/src/managers/config.ts b/src/managers/config.ts
@@ -4,13 +4,13 @@
 */
 
 import type { JobOptions } from 'gatsby-plugin-component-to-image/lib/types';
-import { colorMappingsConfig } from '../config/color-mappings.ts';
+import { COLOR_MAPPINGS_CONFIG } from '../config/color-mappings.ts';
 import { PAGES_CONTENT_CONFIG } from '../config/content/pages.ts';
-import { externalServicesConfig } from '../config/external-services.ts';
-import { pagesMetadataConfig } from '../config/metadata/pages.ts';
-import { siteMetadataConfig } from '../config/metadata/site.ts';
-import { socialImagesGenerationConfig } from '../config/social-images-generation.ts';
-import { themesConfig } from '../config/themes.ts';
+import { EXTERNAL_SERVICES_CONFIG } from '../config/external-services.ts';
+import { PAGES_METADATA_CONFIG } from '../config/metadata/pages.ts';
+import { SITE_METADATA_CONFIG } from '../config/metadata/site.ts';
+import { SOCIAL_IMAGES_GENERATION_CONFIG } from '../config/social-images-generation.ts';
+import { THEMES_CONFIG } from '../config/themes.ts';
 import { warn } from '../node/logger.ts';
 import type { PageContentConfig } from '../types/content/content.ts';
 import type {
@@ -69,7 +69,7 @@ type SiteMetadata = {
 
 // Returns metadata for the site
 export function getSiteMetadata(): SiteMetadata {
-	const config = siteMetadataConfig;
+	const config = SITE_METADATA_CONFIG;
 	const authorFullName: Capitalize<string> =
 		`${config.author.name.first} ${config.author.name.last}` as typeof config.author.name.first;
 
@@ -115,7 +115,7 @@ export function getSiteMetadata(): SiteMetadata {
 // Returns the metadata for a given page
 export function getPageMetadata(pagePath: string): PageMetadata {
 	const config =
-		pagesMetadataConfig[pagePath as keyof typeof pagesMetadataConfig];
+		PAGES_METADATA_CONFIG[pagePath as keyof typeof PAGES_METADATA_CONFIG];
 
 	if (!config) {
 		warn(`Page metadata for ${pagePath} not found`);
@@ -138,14 +138,14 @@ export function getPageContentConfig(pagePath: string): PageContentConfig {
 
 // Returns the social image generation config for a given type
 export function getSocialImageGenerationConfigDefaults(): SocialImagesGenerationConfig['defaults'] {
-	return socialImagesGenerationConfig.defaults;
+	return SOCIAL_IMAGES_GENERATION_CONFIG.defaults;
 }
 
 // Returns the social image generation config for a given type
 export function getSocialImageGenerationConfigForType(
 	type: SocialImageType,
 ): Partial<JobOptions> {
-	const config = socialImagesGenerationConfig.types[type];
+	const config = SOCIAL_IMAGES_GENERATION_CONFIG.types[type];
 
 	if (!config) {
 		warn(`Social image generation config for '${type}' not found`);
@@ -155,12 +155,12 @@ export function getSocialImageGenerationConfigForType(
 }
 
 export function getExternalServices() {
-	return externalServicesConfig;
+	return EXTERNAL_SERVICES_CONFIG;
 }
 
 // Returns a daisyUI theme given its name
 export function getTheme(themeName: keyof ThemesConfig): Theme {
-	const config = themesConfig[themeName];
+	const config = THEMES_CONFIG[themeName];
 
 	if (!config) {
 		throw new Error(`Theme '${themeName}' not found`);
@@ -173,7 +173,7 @@ export function getTheme(themeName: keyof ThemesConfig): Theme {
 export function getProjectTypeColor(
 	projectType: string | undefined | null,
 ): BgColorString | '' {
-	const colorMap = colorMappingsConfig.projectType;
+	const colorMap = COLOR_MAPPINGS_CONFIG.projectType;
 	const key = projectType?.toLowerCase();
 
 	if (isDefined(key)) {
@@ -184,14 +184,14 @@ export function getProjectTypeColor(
 		warn(`Color for project type '${projectType}' not found`);
 	}
 
-	return colorMappingsConfig.default;
+	return COLOR_MAPPINGS_CONFIG.default;
 }
 
 // Returns the color for a given role type
 export function getRoleTypeColor(
 	roleType: string | undefined | null,
 ): BgColorString | '' {
-	const colorMap = colorMappingsConfig.roleType;
+	const colorMap = COLOR_MAPPINGS_CONFIG.roleType;
 	const key = roleType?.toLowerCase();
 
 	if (isDefined(key)) {
@@ -202,5 +202,5 @@ export function getRoleTypeColor(
 		warn(`Color for role type '${roleType}' not found`);
 	}
 
-	return colorMappingsConfig.default;
+	return COLOR_MAPPINGS_CONFIG.default;
 }
diff --git a/src/managers/content/roles.ts b/src/managers/content/roles.ts
@@ -3,7 +3,7 @@
 	----------------------------------------------------------------------
 */
 
-import { rolesConfig } from '../../config/content/roles.ts';
+import { ROLES_CONFIG } from '../../config/content/roles.ts';
 import {
 	type EducationRole,
 	type EmploymentRole,
@@ -79,7 +79,7 @@ export function getRolesForPage(pagePath: string) {
 	for (const roleType of roleTypes) {
 		roleSubsets[roleType] = filterEntries(
 			pagePath,
-			rolesConfig[roleType].map(buildRole),
+			ROLES_CONFIG[roleType].map(buildRole),
 			pageRolesConfig[roleType],
 			getRoleId,
 		);
diff --git a/src/managers/content/skills.ts b/src/managers/content/skills.ts
@@ -3,7 +3,7 @@
 	-----------------------------------------------------------------------
 */
 
-import { skillsConfig } from '../../config/content/skills.ts';
+import { SKILLS_CONFIG } from '../../config/content/skills.ts';
 import {
 	type Skill,
 	SkillType,
@@ -33,7 +33,7 @@ export function getSkillsForPage(pagePath: string) {
 	for (const skillType of skillTypes) {
 		skillSubsets[skillType] = filterEntries<Skill>(
 			pagePath,
-			skillsConfig[skillType],
+			SKILLS_CONFIG[skillType],
 			pageSkillsConfig[skillType],
 			(skill: Skill) => skill,
 		);
diff --git a/src/managers/content/utils.ts b/src/managers/content/utils.ts
@@ -41,7 +41,7 @@ export function getPageEntriesLimit<T>(
  */
 export function filterEntries<T>(
 	pagePath: string,
-	allEntries: T[],
+	allEntries: readonly T[],
 	pageContentEntryConfig: PageContentEntryConfig<T>,
 	getEntryId: (entry: T) => string,
 	doPinEntry?: FilterFn<T>,
