Add JSDocs

Author: aryaemami59

.size-limit.mts

@@ -4,9 +4,28 @@ import type { Configuration } from 'webpack'
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url))
 
+/**
+ * An array of all possible Node environments.
+ */
+const allNodeEnvs = ['development', 'production'] as const
+
+/**
+ * Represents a specific environment for a Node.js application.
+ */
+type NodeEnv = (typeof allNodeEnvs)[number]
+
+/**
+ * Set of entry points from the `package.json` file.
+ */
 const packageJsonEntryPoints = new Set<string>()
 
-const getPackageJsonExports = async (
+/**
+ * Recursively collects entry points from the `package.json` exports field.
+ *
+ * @param packageJsonExports - The exports field from `package.json`.
+ * @returns - A set of package entry points.
+ */
+const collectPackageJsonExports = async (
   packageJsonExports:
     | string
     | Record<string, any>
@@ -31,22 +50,37 @@ const getPackageJsonExports = async (
             condition !== './package.json' && condition !== 'types',
         )
         .map(([_condition, entryPoint]) => entryPoint)
-        .map(getPackageJsonExports),
+        .map(collectPackageJsonExports),
     )
   }
 
   return packageJsonEntryPoints
 }
 
+/**
+ * Gets all package entry points from the `package.json` file.
+ *
+ * @returns A promise that resolves to an array of unique package entry points.
+ */
 const getAllPackageEntryPoints = async () => {
   const packageJson = await import('./package.json', { with: { type: 'json' } })
 
-  const packageExports = await getPackageJsonExports(packageJson.exports)
+  const packageExports = await collectPackageJsonExports(packageJson.exports)
 
   return [...new Set(packageExports)]
 }
 
-const getAllImports = async (
+/**
+ * Gets all import configurations for a given entry point.
+ * This function dynamically imports the specified entry point and generates a size limit configuration
+ * for each named export found within the module. It includes configurations for named imports,
+ * wildcard imports, and the default import.
+ *
+ * @param entryPoint - The entry point to import.
+ * @param index - The index of the entry point in the list.
+ * @returns A promise that resolves to a size limit configuration object.
+ */
+const getAllImportsForEntryPoint = async (
   entryPoint: string,
   index: number,
 ): Promise<SizeLimitConfig> => {
@@ -71,10 +105,12 @@ const getAllImports = async (
     ])
 }
 
-const allNodeEnvs = ['development', 'production'] as const
-
-type NodeEnv = (typeof allNodeEnvs)[number]
-
+/**
+ * Sets the `NODE_ENV` for a given Webpack configuration.
+ *
+ * @param nodeEnv - The `NODE_ENV` to set (either 'development' or 'production').
+ * @returns A function that modifies the Webpack configuration.
+ */
 const setNodeEnv = (nodeEnv: NodeEnv) => {
   const modifyWebpackConfig = ((config: Configuration) => {
     ;(config.optimization ??= {}).nodeEnv = nodeEnv
@@ -84,11 +120,17 @@ const setNodeEnv = (nodeEnv: NodeEnv) => {
   return modifyWebpackConfig
 }
 
+/**
+ * Gets all import configurations with a specified `NODE_ENV`.
+ *
+ * @param nodeEnv - The `NODE_ENV` to set (either 'development' or 'production').
+ * @returns A promise that resolves to a size limit configuration object.
+ */
 const getAllImportsWithNodeEnv = async (nodeEnv: NodeEnv) => {
   const allPackageEntryPoints = await getAllPackageEntryPoints()
 
   const allImportsFromAllEntryPoints = (
-    await Promise.all(allPackageEntryPoints.map(getAllImports))
+    await Promise.all(allPackageEntryPoints.map(getAllImportsForEntryPoint))
   ).flat()
 
   const modifyWebpackConfig = setNodeEnv(nodeEnv)
@@ -104,6 +146,11 @@ const getAllImportsWithNodeEnv = async (nodeEnv: NodeEnv) => {
   return allImportsWithNodeEnv
 }
 
+/**
+ * Gets the size limit configuration for all `NODE_ENV`s.
+ *
+ * @returns A promise that resolves to the size limit configuration object.
+ */
 const getSizeLimitConfig = async (): Promise<SizeLimitConfig> => {
   const sizeLimitConfig = (
     await Promise.all(allNodeEnvs.map(getAllImportsWithNodeEnv))