Remove configFolder option and replace it with absoluteConfigFolderPath for improved configuration handling

Author: Raul Melo

.changeset/yellow-crews-fall.md

@@ -0,0 +1,5 @@
+---
+"@layerfig/config": patch
+---
+
+Remove configFolder from type

docs/src/content/docs/migrate-to-v3.mdx

@@ -58,6 +58,41 @@ These are useful if you want to:
 
 ## Breaking Changes
 
+### Remove `configFolder`
+
+Before, if you wanted to point out a different config folder to Layerfig search for files, you would use the `configFolder` option:
+
+```ts
+import path from "node:path";
+
+const config = new ConfigBuilder({
+  validate: (finalConfig) => schema.parse(finalConfig),
+  configFolder: "./path/to/config-folder",
+})
+  .addSource(new FileSource("base.json"))
+  .build();
+```
+
+The problem was that internally, Layerfig would use `process.cwd()` and resolve to the folder you've specified but in some cases this caused issues.
+
+Now, if you want to change the default folder (or have a different one based on the environment), you can use the `absoluteConfigFolderPath` option:
+
+```ts
+import path from "node:path";
+
+const config = new ConfigBuilder({
+  validate: (finalConfig) => schema.parse(finalConfig),
+  absoluteConfigFolderPath: path.resolve(
+    process.cwd(),
+    "./path/to/config-folder"
+  ),
+})
+  .addSource(new FileSource("base.json"))
+  .build();
+```
+
+Please notice that as the name states, this option expects an **absolute** path to the folder where Layerfig should look for configuration files. If not it will throw an error.
+
 ### Custom Parser API
 
 In v2, creating a custom configuration parser looked like this:

docs/src/content/docs/setup/configuration.mdx

@@ -43,23 +43,33 @@ export const config = new ConfigBuilder({
   .build();
 ```
 
-## options.configFolder
+## options.absoluteConfigFolderPath
 
-> Default: `'./config'`
+> Default: `'<process.cwd()>/config'`
 
-By default, file-based sources added via `addSource` are loaded from a `config` folder in the project's root. You can customize this path using the `configFolder` option:
+By default, file-based sources added via `addSource` are loaded from a `config` folder in the project's root. You can customize this path using the `absoluteConfigFolderPath` option:
 
 ```ts
+import path from "node:path";
+
 const config = new ConfigBuilder({
   validate: (finalConfig) => schema.parse(finalConfig),
-  configFolder: "./path/to/config-folder",
+  absoluteConfigFolderPath: path.resolve(
+    process.cwd(),
+    "./path/to/config-folder"
+  ),
 })
   .addSource(new FileSource("base.json"))
   .build();
 ```
 
 In this example, the library will look for `<root>/path/to/config-folder/base.json`.
 
+<Aside type="danger">
+  `absoluteConfigFolderPath` must be an absolute path, otherwise it'll throw an
+  error.
+</Aside>
+
 ## options.parser
 
 > Default: simple json parser

docs/src/content/docs/setup/sources.mdx

@@ -21,7 +21,7 @@ export const config = new ConfigBuilder({
   .build();
 ```
 
-In this case, `base.json` is a file located in the `<root-project-dir>/config` directory (or the one specified via `configFolder`).
+In this case, `base.json` is a file located in the `<root-project-dir>/config` directory (or the one specified via `absoluteConfigFolderPath`).
 
 <Aside>Without a specified parser, you can only load `.json`.</Aside>
 

packages/config/src/server/types.ts

@@ -20,7 +20,6 @@ export const ServerConfigBuilderOptionsSchema: z.ZodMiniType<ValidatedServerConf
 				),
 			path.resolve(process.cwd(), "./config"),
 		),
-		configFolder: z._default(z.string(), "./config"),
 		runtimeEnv: z._default(RuntimeEnv, process.env),
 		parser: z._default(z.custom<ConfigParser>(), basicJsonParser),
 		validate: z.custom<ServerConfigBuilderOptions["validate"]>(),