-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: enable usage of config files when package.json
type=module (#8455
- Loading branch information
Showing
19 changed files
with
248 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "app-builder-lib": patch | ||
| "electron-builder": patch | ||
| --- | ||
|
|
||
| fix: allow usage of "module" typ config files |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| import { promises as fs } from "fs" | ||
| import { load } from "js-yaml" | ||
| import * as path from "path" | ||
| import { Lazy } from "lazy-val" | ||
| import { parse as parseEnv } from "dotenv" | ||
| import { loadTsConfig } from "config-file-ts" | ||
| import { DotenvParseInput, expand } from "dotenv-expand" | ||
| import { resolveModule } from "../resolve" | ||
| import { log } from "builder-util" | ||
|
|
||
| export interface ReadConfigResult<T> { | ||
| readonly result: T | ||
| readonly configFile: string | null | ||
| } | ||
|
|
||
| async function readConfig<T>(configFile: string, request: ReadConfigRequest): Promise<ReadConfigResult<T>> { | ||
| const data = await fs.readFile(configFile, "utf8") | ||
| let result: any | ||
| if (configFile.endsWith(".json5") || configFile.endsWith(".json")) { | ||
| result = require("json5").parse(data) | ||
| } else if (configFile.endsWith(".js") || configFile.endsWith(".cjs" || configFile.endsWith(".mjs"))) { | ||
| const json = await orNullIfFileNotExist(fs.readFile(path.join(process.cwd(), "package.json"), "utf8")) | ||
| const moduleType = json === null ? null : JSON.parse(json).type | ||
| result = await resolveModule(moduleType, configFile) | ||
| if (result.default != null) { | ||
| result = result.default | ||
| } | ||
| if (typeof result === "function") { | ||
| result = result(request) | ||
| } | ||
| result = await Promise.resolve(result) | ||
| } else if (configFile.endsWith(".ts")) { | ||
| result = loadTsConfig(configFile) | ||
| if (typeof result === "function") { | ||
| result = result(request) | ||
| } | ||
| result = await Promise.resolve(result) | ||
| } else if (configFile.endsWith(".toml")) { | ||
| result = require("toml").parse(data) | ||
| } else { | ||
| result = load(data) | ||
| } | ||
| return { result, configFile } | ||
| } | ||
|
|
||
| export async function findAndReadConfig<T>(request: ReadConfigRequest): Promise<ReadConfigResult<T> | null> { | ||
| const prefix = request.configFilename | ||
| for (const configFile of [`${prefix}.yml`, `${prefix}.yaml`, `${prefix}.json`, `${prefix}.json5`, `${prefix}.toml`, `${prefix}.js`, `${prefix}.cjs`, `${prefix}.ts`]) { | ||
| const data = await orNullIfFileNotExist(readConfig<T>(path.join(request.projectDir, configFile), request)) | ||
| if (data != null) { | ||
| return data | ||
| } | ||
| } | ||
|
|
||
| return null | ||
| } | ||
|
|
||
| export function orNullIfFileNotExist<T>(promise: Promise<T>): Promise<T | null> { | ||
| return orIfFileNotExist(promise, null) | ||
| } | ||
|
|
||
| export function orIfFileNotExist<T>(promise: Promise<T>, fallbackValue: T): Promise<T> { | ||
| return promise.catch(e => { | ||
| if (e.code === "ENOENT" || e.code === "ENOTDIR") { | ||
| return fallbackValue | ||
| } | ||
| throw e | ||
| }) | ||
| } | ||
|
|
||
| export interface ReadConfigRequest { | ||
| packageKey: string | ||
| configFilename: string | ||
|
|
||
| projectDir: string | ||
| packageMetadata: Lazy<{ [key: string]: any } | null> | null | ||
| } | ||
|
|
||
| export async function loadConfig<T>(request: ReadConfigRequest): Promise<ReadConfigResult<T> | null> { | ||
| let packageMetadata = request.packageMetadata == null ? null : await request.packageMetadata.value | ||
| if (packageMetadata == null) { | ||
| const json = await orNullIfFileNotExist(fs.readFile(path.join(request.projectDir, "package.json"), "utf8")) | ||
| packageMetadata = json == null ? null : JSON.parse(json) | ||
| } | ||
|
|
||
| const data: T = packageMetadata == null ? null : packageMetadata[request.packageKey] | ||
| return data == null ? findAndReadConfig<T>(request) : { result: data, configFile: null } | ||
| } | ||
|
|
||
| export function getConfig<T>(request: ReadConfigRequest, configPath?: string | null): Promise<ReadConfigResult<T> | null> { | ||
| if (configPath == null) { | ||
| return loadConfig<T>(request) | ||
| } else { | ||
| return readConfig<T>(path.resolve(request.projectDir, configPath), request) | ||
| } | ||
| } | ||
|
|
||
| export async function loadParentConfig<T>(request: ReadConfigRequest, spec: string): Promise<ReadConfigResult<T>> { | ||
| let isFileSpec: boolean | undefined | ||
| if (spec.startsWith("file:")) { | ||
| spec = spec.substring("file:".length) | ||
| isFileSpec = true | ||
| } | ||
|
|
||
| let parentConfig = await orNullIfFileNotExist(readConfig<T>(path.resolve(request.projectDir, spec), request)) | ||
| if (parentConfig == null && isFileSpec !== true) { | ||
| let resolved: string | null = null | ||
| try { | ||
| resolved = require.resolve(spec) | ||
| } catch (e) { | ||
| // ignore | ||
| } | ||
|
|
||
| if (resolved != null) { | ||
| parentConfig = await readConfig<T>(resolved, request) | ||
| } | ||
| } | ||
|
|
||
| if (parentConfig == null) { | ||
| throw new Error(`Cannot find parent config file: ${spec}`) | ||
| } | ||
|
|
||
| return parentConfig | ||
| } | ||
|
|
||
| export async function loadEnv(envFile: string) { | ||
| const data = await orNullIfFileNotExist(fs.readFile(envFile, "utf8")) | ||
| if (data == null) { | ||
| return null | ||
| } | ||
|
|
||
| const parsed = parseEnv<DotenvParseInput>(data) | ||
|
|
||
| log.info({ envFile }, "injecting environment") | ||
| Object.entries(parsed).forEach(([key, value]) => { | ||
| if (!Object.prototype.hasOwnProperty.call(process.env, key)) { | ||
| process.env[key] = value | ||
| } | ||
| }) | ||
| expand({ parsed }) | ||
| return parsed | ||
| } |
Oops, something went wrong.