Merge branch 'compiletime-types' into 'main'

Add types to compileTime modules

See merge request soapbox-pub/soapbox!2733

src/build-config-compiletime.ts

@@ -28,12 +28,16 @@ const sanitizeBasename = (path: string | undefined = ''): string => {
   return `/${trim(path, '/')}`;
 };
 
-export default () => ({
+const env = {
-  data: {
   NODE_ENV: NODE_ENV || 'development',
   BACKEND_URL: sanitizeURL(BACKEND_URL),
   FE_SUBDIRECTORY: sanitizeBasename(FE_SUBDIRECTORY),
   FE_INSTANCE_SOURCE_DIR: FE_INSTANCE_SOURCE_DIR || 'instance',
   SENTRY_DSN,
-  },
+};
+
+export type SoapboxEnv = typeof env;
+
+export default () => ({
+  data: env,
 });

src/build-config.ts

@@ -1,16 +1,9 @@
-// @ts-nocheck
+import type { SoapboxEnv } from './build-config-compiletime';
-const {
-  NODE_ENV,
-  BACKEND_URL,
-  FE_SUBDIRECTORY,
-  FE_INSTANCE_SOURCE_DIR,
-  SENTRY_DSN,
-} = import.meta.compileTime('./build-config-compiletime.ts');
 
-export {
+export const {
   NODE_ENV,
   BACKEND_URL,
   FE_SUBDIRECTORY,
   FE_INSTANCE_SOURCE_DIR,
   SENTRY_DSN,
-};
+} = import.meta.compileTime<SoapboxEnv>('./build-config-compiletime.ts');

src/service-worker/sw.ts

@@ -9,7 +9,7 @@ import type {
   Status as StatusEntity,
 } from 'soapbox/types/entities';
 
-const locales = import.meta.compileTime('./web-push-locales.ts');
+const locales = import.meta.compileTime<Record<string, Record<string, string>>>('./web-push-locales.ts');
 
 /** Limit before we start grouping device notifications into a single notification. */
 const MAX_NOTIFICATIONS = 5;

src/utils/code-compiletime.ts

@@ -35,8 +35,7 @@ const version = (pkg: Record<string, any>) => {
   return pkg.version;
 };
 
-export default () => ({
+const code = {
-  data: {
   name: pkg.name,
   displayName: pkg.displayName,
   url: pkg.repository.url,
@@ -44,5 +43,10 @@ export default () => ({
   version: version(pkg),
   homepage: pkg.homepage,
   ref: CI_COMMIT_TAG || CI_COMMIT_SHA || tryGit('git rev-parse HEAD'),
-  },
+};
+
+export type Code = typeof code;
+
+export default () => ({
+  data: code,
 });

src/utils/code.ts

@@ -1,3 +1,3 @@
-const data: any = import.meta.compileTime('./code-compiletime.ts');
+import type { Code } from './code-compiletime';
 
-export default data;
+export default import.meta.compileTime<Code>('./code-compiletime.ts');