@haatlabs-core/config-core

中文文档
0.18.5发布于 2026/11/14Apache-2.0TypeScriptESM + CJS零依赖近 30 天下载 5748

The environment variables every app reads, as zod shapes an app composes with its own.

原始使用文档

@haatlabs-core/config-core

The environment variables every app reads, as parts an app composes with its own. A plain shape is exported, not a finished schema: in zod 4 an object schema with refinements cannot be extended.

const EnvSchema = z
  .object({
    ...coreEnvShape({ apiPort: 4100, workerHealthPort: 4101 }),
    ...shopifyEnvShape({ defaultScopes: 'read_products' }),
    ...ownShape,
  })
  .superRefine((env, ctx) => {
    coreEnvChecks(env, ctx);
    shopifyEnvChecks(env, ctx, { required: true });
    ownChecks(env, ctx);
  });
export const loadConfig = (env = process.env) =>
  loadConfigWith(EnvSchema, (e) => ({ ...mapCoreConfig(e), shopify: requireShopify(mapShopify(e)), ... }), env);
  • Core (coreEnvShape, coreEnvChecks, mapCoreConfig): environment, log level, the API's port and addresses, CORS, proxies, both databases, Redis, sessions, the fixed sign-in code, tracing, metrics, the worker and mail. A fixed code is refused in production unless ALLOW_FIXED_SIGN_IN_CODE=true.
  • Shopify (shopifyEnvShape, shopifyEnvChecks, mapShopify, mapTokenEncryption): required, or optional with both keys or neither.
  • S3 and payments blocks, for the apps that have them.
  • loadConfigWith: a bad environment is a ConfigError naming each variable, never its value. refuseInProduction, buildTestEnv(appName).

zod is a peer: the app's own copy is used.

CACHE_REDIS_URL (optional): the cache's own Redis, config.cache.redisUrl; never the queues'. Unset: no cache. One that names the server (host and port) of REDIS_URL or QUEUE_REDIS_URL is refused at start: the cache evicts, and would evict theirs.

Install

pnpm add @haatlabs-core/config-core

It leaves one package to your app, so the app holds one copy: zod.

版本与发布记录

@haatlabs-core/config-core 共发布 27 个版本,首次发布于 2026/10/23;过去 12 个月发布了 27 个版本。

版本发布日期距今
0.18.5latest2026/11/143 天前
0.18.42026/11/133 天前
0.18.32026/11/134 天前
0.18.22026/11/134 天前
0.18.12026/11/134 天前
0.18.02026/11/134 天前

关于 @haatlabs-core/config-core 的常见问题

@haatlabs-core/config-core 是什么?

The environment variables every app reads, as zod shapes an app composes with its own.

如何安装 @haatlabs-core/config-core?

在项目目录运行 npm install @haatlabs-core/config-core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^4.6.5)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@haatlabs-core/config-core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@haatlabs-core/config-core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@haatlabs-core/config-core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=24。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@haatlabs-core/config-core 可以商用吗?

@haatlabs-core/config-core 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@haatlabs-core/config-core 的下载量有多少?

根据 npm 官方下载统计,@haatlabs-core/config-core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,748 次,日均约 192 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@haatlabs-core/config-core 还在维护吗?

最新版本 0.18.5 发布于 2026/11/14(3 天前);至今共发布 27 个版本,其中过去 12 个月发布了 27 个;首次发布于 2026/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。