# codeplay-common 中文文档

规范地址：https://npmcn.com/package/codeplay-common/

版本：4\.11\.10
npm 元数据更新时间：2026-11-03T08:15:55.133Z
中文译文更新时间：2026-11-03T08:41:25.065Z
软件包许可：MIT

本文由上游 README 机器翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/codeplay-common
原文对照：https://npmcn.com/package/codeplay-common/?lang=original
项目主页：https://github.com/merbin2012/codeplay-common#readme
源码仓库：https://github.com/merbin2012/codeplay-common

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：626 kB，38 个文件
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2025-02-19T09:46:30.273Z
- 最新版本发布：2026-11-03T08:15:54.949Z
- 已发布版本数：374（近 12 个月 222 个）

## 中文简介

通用构建脚本和文件

## 安装

```sh
npm install codeplay-common
```

也可以使用：`pnpm add codeplay-common`、`yarn add codeplay-common`、`bun add codeplay-common`

## README

# codeplay-common

一切自动化在电容器应用程序，易于维护许多应用程序在电容器。使用通用文件代码，它将减少40%的工作。

轻松添加溅屏和设置动画 Admob id自动从capacitor.config.json文件 根据我们的需求为不同的存储创建三个构建文件 基于商店安装各种IAP插件 进入离子工程

## Android权限元数据（4.11.4）

包保留运行时 `CapacitorPlugin` 和 `Permission` 优化的Android构建所需的annotation成员。这适用于每个Android用户，即使应用程序目前不使用依赖于权限的插件。它不声明或授予权限、显示提示或启用最小化。

安装将规则应用于现有的Android项目并安装一个 `apply from` 行 `android/app/build.gradle`． 包含的Gradle脚本在每次配置Gradle时都会重新运行修复，包括直接的Android Studio/Gradle和Capacitor `run --no-sync` 构建。所有修复逻辑都保留在共享修复文件夹中。Android同步，构建准备和发布准备在平台再生后恢复丢失的规则。生成的Gradle钩子在平台再生后被恢复。保留现有的自定义ProGuard规则，并且重复运行不会添加重复项。没有Android平台的应用程序将被跳过，直到该平台存在。

所有的修复实现都在 `buildCodeplay/fix-optimize-builld/`，包括restore命令及其与Gradle的集成；没有app-specific `Scripts` 文件是必需的。运行 `npm run android:r8-rules` 手动恢复规则。保留现有的自定义npm命令；已知的老人 `restore-android-r8-rules.cjs` 命令自动迁移。

安装此包更新后，重新构建并测试每个应用程序的优化版本。更新构建工具不能改变已经分发给用户的apk或应用商店版本。

## 应用程序助手文件夹

应用程序帮助器脚本保存在 `scripts-common/`． 安装迁移旧的 `scripts/` 文件夹和包命令路径自动，保留每个现有的文件。在移动任何文件之前，冲突的目标文件会停止迁移。插件的内部npm生命周期文件夹仍然存在 `scripts/`。

## 共享的无版本构建文件（4.10.0）

插件将主构建模板保存在files/buildCodeplay中，并在安装/更新期间将它们复制到每个应用的buildCodeplay文件夹中。在应用程序文件夹中测试更改，然后更新这些主模板以分发到其他应用程序。

应用包脚本运行本地文件：node buildCodeplay/codeplayBeforeBuild.js、node buildCodeplay/ packageidbasemodificet .js、node buildCodeplay/add-splash-screen.js和node buildCodeplay/ setsplashanimim .js。文件名没有版本后缀。的版本。Json插件清单仍然与这些脚本一起被复制。

安装将遗留版本的文件名和临时node\_modules运行器命令迁移到这些本地路径。它只删除被取代的版本化构建脚本，保留应用程序拥有的发布配置和splash XML覆盖，并保留截图数据和自定义助手。根finalrelease脚本也被复制为本地实现。

安装此更新后， `npm run build` 检查应用程序的 `buildCodeplay/` 文件夹，用于准备生成之前的版本后缀文件。如果存在，则运行 `npm uninstall codeplay-common` 紧随其后的是 `npm install codeplay-common`，然后在继续之前运行更新后的构建前脚本。失败的命令或剩余的版本文件将停止构建。必须手动迁移无法识别的遗留文件；它们不会被自动删除。

构建前包括自动IAP启动和Home pro键迁移。IAP和AdMob zip直接从 [https://htmlcodeplay.com/code-play-plugin/](https://htmlcodeplay.com/code-play-plugin/) 使用现有的更新流。这个npm包中没有绑定任何插件zip。特定于应用程序的配置和设计保留在应用程序中。

## AdMob文件夹包

下一个构建前自动将AdMob迁移到至少：

`src/js/Ads/admob-nextgen-4.1/admob-emi-nextgen.js`

`src/js/Ads/admob-nextgen-4.1/app-open-state.js`

现有的 `@admob` 进口继续发挥作用。直接导入控制器或 将轻量级状态模块重写到所选文件夹，包括相对 路径, `@/` 路径和静态动态导入。App-owned `src/js/Ads/admob-ad-configuration-nextgen.json` 留在包装外； 安装不会替换它的值。控制器的分析导入为 与最新安装的IAP文件夹保持一致 `firebase-analytics.js`。

预构建脚本在迁移AdMob之前下载IAP，因此存在相应的导入。Postinstall不会在IAP之前独立更新AdMob。 zip可以直接包含文件，也可以包含一个匹配的版本文件夹。一个完整的 在导入切换前需要控制器和状态模块。不可用的或 无效的远程ZIP使已安装的包仍在使用，并给出警告。未解决的 导入目标在移除旧包之前停止迁移。

对于未来的AdMob版本，请上传 `admob-nextgen-X.Y.zip` 来 `https://htmlcodeplay.com/code-play-plugin/` 并设置 `"admob-nextgen": "X.Y"` 在服务器的 `versions.json`． 对文件夹进行版本化，并保留模块文件名 稳定。前面的 `admob-emi-nextgen` 版本接受清单密钥 4.0及更高版本的版本。应用程序自动选择一个较新的ZIP期间 他们的下一个正常预构建；不需要更改每个应用的导入。 对于没有文件夹发布条目的旧清单，迁移检查必需的 `admob-nextgen-4.1.zip` 直接从同一台服务器。如果脱机，则使用现有的兼容程序 保存安装；缺少必需的包将停止构建。

## 平台构建和共享验证

安装或更新 `codeplay-common` 更新消费项目的 `package.json` 要使用复制的未版本预构建脚本，并添加以下命令：

-   `npm run build`：默认为Android，包括macOS。
-   `npm run build:ios`:集 `CODEPLAY_BUILD_PLATFORM=ios` 并运行相同的构建管道。
-   `npm run build-capacitor-android`：运行共享检查并将web构建复制到Android。

预构建脚本直接迁移 `saveToGalleryAndSaveAnyFile` 进口 `@saveGallery` 并将Vite别名设置为匹配的Android或iOS助手。 在更改源导入或别名之前，它会列出构建目标、受影响的文件、 以及精确的替换。按Enter或输入 `y` 继续;其他答案都消掉了。 在没有提示的情况下继续正确导入和别名目标。失踪的救援人员 版本和查询/哈希导入会因为一个可操作的错误而停止。

源代码验证重用目录目录，并结合了图库和编辑器 检入一个内容通道。生成或下载时，清单将刷新 文件改变源树。

构建也保持 `agent-temp/` 忽略并删除现有的 `buildCodeplay/` 忽略条目。 如果 `onesignal-cordova-plugin` 声明或安装时，预构建脚本警告和 运行 `npm uninstall onesignal-cordova-plugin`． 如果移除失败或激活，它会停止 包进口仍然存在。旧的onessignal补丁和helper下载被禁用。

## 截屏的数据

共享截图助手安装到 `scripts-common/screenshot/` 更新为 包。特定于应用程序的数据没有捆绑在包中。 在升级期间，清理只删除两个遗留的帮助程序 `frame-samples.js` 和 `background-decorations.js` 从 `scripts-screenshot/screenshot/`,保留 文件夹、JSON数据和其他应用文件。

`take-screen-image.js` 创建 `scripts-screenshot/screenshot/` 和空 `screenshot-copy.json` 和 `screenshot-info.json` 文件时需要。现有的文件 在初始化、包安装和清理期间保留。捕获 更新截图信息；AI文本生成工作流填充截图 副本。 `--delete` 删除匹配的记录，并且屏幕截图运行调和记录 对照捕获的图像(除了演练和 `--refresh-info`）.

## 代理的指示

期间更新代理指令 `npm run build`，而不是在NPM安装期间。 构建脚本读取 `agents` 版本 `https://htmlcodeplay.com/code-play-plugin/versions.json` 下载匹配的 `agents-<version>.zip` 存档时，项目没有代理说明或 服务器版本较新。

ZIP根目录必须包含 `AGENTS.md` 和 `AGENTS/`． 这些被直接复制到 项目根目录。安装后的版本存放在 `AGENTS/.codeplay-version`。 具有匹配名称的现有文件将被替换；仅用于项目的文件 名字里面 `AGENTS/` 是保存了下来。

例如，发布 `agents-1.1.zip` 并将此条目添加到服务器的条目中 `versions.json`：

```json
"agents": "1.1"
```

捐赠以获得包括许多常用函数在内的完整代码 [https://ko-fi.com/codeplay](https://ko-fi.com/codeplay)

4.6.1版本 为Framework7主页添加了自动IAP启动集成。 更新最小共享版本到IAP 4.2和AdMob nextgen 2.5。

4.2.8 基线概要代码修改

4.2.3版本 添加了构建警告确认当android。ORIENTATION不是“auto”或android。RESIZEABLE\_ACTIVITY不为真。

版本4.2.2 增加了“bannerDisabledPages”属性及其默认值 修改admob配置默认值priority

4.2.1版本 更新AdMob nextgen文件验证，以匹配AdMob -emi-nextgen文件名。

版本4.2.0 更新了Firebase相关的自动更改

4.1.9版本 添加AdMob nextgen 1.7验证/默认支持“overlappingHeight”，“bannerTypeAndroidLandscape”和“bannertypeiolandscape”。

4.1.8版本 增加了“consentDebug: false”

4.1.7版本 Admob配置自动添加。

4.1.6版本 修改了“setup-baseline-profile.js”，修正了重复验证错误

4.1.5版本 虽然istest为真，但它没有从我们的新配置admob文件中验证，现在它已经解决了

4.1.4版本 硬编码版本已删除admob-emi-nextgen

4.1.3版本 “consentDebug”： false如果没有，则自动添加

4.1.2版本 加速

以下4.4.1版本 自动admob集成更新

版本4.0.9 packageJson。scripts\["ionic:serve"\] = "cross-env NODE\_ENV=development vite"；这一行在“sync-files.js”中更新

版本4.0.8 安全区域插件被检查和自动删除 在capacitor.config.json文件中自动添加以下内容 " SystemBars ": { “insetsHandling”:“css” } 移除patchFile（）方法

版本4.0.6 IAP相关的一些自动变量创建和验证 从vite.config.json文件中获取 “import.meta.env。VITE\_APP\_UNIQUE\_ID”:JSON.stringify (APP\_UNIQUE\_ID), “import.meta.env。VITE\_ANDROID\_ANALYTICS\_ENABLED”:JSON.stringify (ANDROID\_ANALYTICS\_ENABLED), “import.meta.env。VITE\_IOS\_ANALYTICS\_ENABLED”:JSON.stringify (IOS\_ANALYTICS\_ENABLED), “import.meta.env。VITE\_IAP\_DESIGN”:JSON.stringify (IAP\_DESIGN),

版你 在“files\\buildCodeplay\\packageidBaseModification-1.4.js”中添加了SCHEDULE\_EXACT\_ALARM权限，用于应用程序唯一id 2（简历生成器应用程序）

版本4.0.4 patchFile ();方法被禁用，由于“@capacitor/android:8.4.2”此更新。我认为这与安全区域问题有关，在这个最新版本中修复，文件在“SystemBars.java”

版本4.0.3 旧的admob检查通过插件位置执行，但不是通过capacitor.config.json进行验证

版本:4.0.2 检查并安装/下载最新版本后，现在取消重新检查

版本:4.0.1 添加基本配置文件脚本

“版本”:“”, 版本：4.0.0（旧版本3.2.19） 1)在这里我们完全去掉了admob-emi，使用“电容器-admob-nextgen” 2)删除“modify-plugin-xml.js” 3）

修复保留了测试中验证的发布权限检查失败背后的元数据。它不能保证每个本地对话框或插件：所需的manifest声明，Android权限策略，设备设置和插件特定的keep规则仍然适用。

## 常见问题

### codeplay-common 是什么？

通用构建脚本和文件

### 如何安装 codeplay-common？

在项目目录运行 npm install codeplay-common，或使用 pnpm add / yarn add / bun add。

### codeplay-common 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/codeplay-common 是否存在。

### codeplay-common 可以商用吗？

codeplay-common 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### codeplay-common 还在维护吗？

最新版本 4\.11\.10 发布于 2026/11/03（今天）；至今共发布 374 个版本，其中过去 12 个月发布了 222 个；首次发布于 2025/02/19。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

