Skip to main content

对配置文件的严格要求

¥Strict requirements for configuration files

Strapi 5 对允许加载的配置文件名有严格的要求。

此页面是 重大变更数据库 的一部分，提供有关重大更改的信息以及从 Strapi v4 迁移到 Strapi 5 的其他说明。

¥This page is part of the breaking changes database and provides information about the breaking change and additional instructions to migrate from Strapi v4 to Strapi 5.

\🔌 此重大更改是否会影响插件？\否
\🤖 此重大更改是否由 codemod 自动处理？\否

¥Strapi 5 has strict requirements on the configuration filenames allowed to be loaded.

此页面是 重大变更数据库 的一部分，提供有关重大更改的信息以及从 Strapi v4 迁移到 Strapi 5 的其他说明。

¥This page is part of the breaking changes database and provides information about the breaking change and additional instructions to migrate from Strapi v4 to Strapi 5.

\🔌 此重大更改是否会影响插件？\否
\🤖 此重大更改是否由 codemod 自动处理？\否

重大更改描述​

¥Breaking change description

在 Strapi v4 中

¥In Strapi v4

Strapi 项目的 /config/ 文件夹中的每个 .js、.ts 和 .json 文件都会加载到 strapi.config 中。

¥Every .js, .ts, and .json file in the /config/ folder of a Strapi project is loaded into strapi.config.

例如，如果有一个名为 /config/my-custom-config.js 的文件，则该文件已加载并从 strapi.config.get('my-custom-config.someProperty') 访问。

¥For example if there is a file called /config/my-custom-config.js it is loaded and accessible from strapi.config.get('my-custom-config.someProperty').

在 Strapi 5 中

¥In Strapi 5

Strapi 5 对允许加载的文件名有严格的要求（有关详细信息，请参阅注释）。

¥Strapi 5 has strict requirements on the filenames allowed to be loaded (see notes for details).

迁移​

¥Migration

本节重新组合了有关引入的重大更改的有用说明和程序。

¥This section regroups useful notes and procedures about the introduced breaking change.

注意​

¥Notes

在 Strapi 5 中，配置文件的文件名应符合以下要求：

¥In Strapi 5 filenames for configuration files should comply to these requirements:

  • 不应有不区分大小写的重复文件名。如果 CUSTOM.js 和 custom.js 同时存在，则只会加载一个。

    ¥There should be no case-insensitive duplicate filenames. If both CUSTOM.js and custom.js exist, only one will be loaded.

  • 不应有没有扩展名的重复基本文件名。如果 custom.json 和 custom.js 同时存在，则只会加载一个。

    ¥There should be no duplicate base filenames without extension. If both custom.json and custom.js exist, only one will be loaded.

  • 以下文件名受到限制且未加载：

    ¥The following filenames are restricted and not loaded:

    • uuid

    • hosting

    • license

    • enforce

    • disable

    • enable

    • plugin

    • strapi

    • middleware

    • telemetry

    • launchedAt

    • serveAdminPanel

    • autoReload

    • environment

    • packageJsonStrapi

    • info

    • autoReload

  • 建议仅使用字母数字字符（a-zA-Z0-9）。

    ¥It is advised to use only alphanumeric characters (a-zA-Z0-9).

  • 所有内部 Strapi 配置（请参阅 configurations 中的文件列表）必须符合这些配置文件的已知结构（即，不应将任何自定义字段添加到现有文件中）。

    ¥All internal Strapi configurations (see the list of files in configurations) must conform to the known structure of those configuration files (i.e., no custom fields should be added to the existing files).

手动迁移​

¥Manual migration

在迁移之前重命名任何属于限制列表的自定义字段或内容类型，以防止数据丢失或其他意外问题。

¥Rename any of configuration files that are now invalid to a new name, and update the code to look in that path.

如果你在内部 Strapi 配置文件中添加了自定义字段，则应该创建一个新文件来存储自定义配置，并确保新文件名符合 Strapi 5 的要求。

¥If you added custom fields to the internal Strapi configuration files, you should instead create a new file to store the custom configuration, and ensure the new filename matches the requirements for Strapi 5.