# core-x

**Repository Path**: chufan443/core-x

## Basic Information

- **Project Name**: core-x
- **Description**: 工程化核心库开源，x代表一切可能性
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-06
- **Last Updated**: 2026-09-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @142vip/core-x

`X`代表一切都有可能，`core-x` 仓库是基于自身技术栈在进行工程化实践中封装的工具包、通用模块。

## 在线浏览

- Github： <https://142vip.github.io/core-x>
- Netlify： <https://pkg-x.netlify.app>
- Vercel： <https://pkg-x.vercel.app>

## 我的开源

### 示例项目

- [`egg-demo`](https://github.com/142vip/core-x/tree/main/apps/egg-demo)
- [`nest-demo`](https://github.com/142vip/core-x/tree/main/apps/nest-demo)
- [`vitepress-demo`](https://github.com/142vip/core-x/tree/main/apps/vitepress-demo)
- [`vuepress-demo`](https://github.com/142vip/core-x/tree/main/apps/vuepress-demo)

### 开源模块

- [`@142vip/agent-skills`](https://www.npmjs.com/package/@142vip/agent-skills)
- [`@142vip/axios`](https://www.npmjs.com/package/@142vip/axios)
- [`@142vip/changelog`](https://www.npmjs.com/package/@142vip/changelog)
- [`@142vip/commit-linter`](https://www.npmjs.com/package/@142vip/commit-linter)
- [`@142vip/copyright`](https://www.npmjs.com/package/@142vip/copyright)
- [`@142vip/data-source`](https://www.npmjs.com/package/@142vip/data-source)
- [`@142vip/egg`](https://www.npmjs.com/package/@142vip/egg)
- [`@142vip/egg-axios`](https://www.npmjs.com/package/@142vip/egg-axios)
- [`@142vip/egg-grpc-client`](https://www.npmjs.com/package/@142vip/egg-grpc-client)
- [`@142vip/egg-grpc-server`](https://www.npmjs.com/package/@142vip/egg-grpc-server)
- [`@142vip/egg-mysql`](https://www.npmjs.com/package/@142vip/egg-mysql)
- [`@142vip/egg-redis`](https://www.npmjs.com/package/@142vip/egg-redis)
- [`@142vip/egg-sequelize`](https://www.npmjs.com/package/@142vip/egg-sequelize)
- [`@142vip/egg-swagger`](https://www.npmjs.com/package/@142vip/egg-swagger)
- [`@142vip/egg-validate`](https://www.npmjs.com/package/@142vip/egg-validate)
- [`@142vip/eslint-config`](https://www.npmjs.com/package/@142vip/eslint-config)
- [`@142vip/fairy-cli`](https://www.npmjs.com/package/@142vip/fairy-cli)
- [`@142vip/grpc`](https://www.npmjs.com/package/@142vip/grpc)
- [`@142vip/nest`](https://www.npmjs.com/package/@142vip/nest)
- [`@142vip/nest-logger`](https://www.npmjs.com/package/@142vip/nest-logger)
- [`@142vip/nest-redis`](https://www.npmjs.com/package/@142vip/nest-redis)
- [`@142vip/nest-starter`](https://www.npmjs.com/package/@142vip/nest-starter)
- [`@142vip/nest-typeorm`](https://www.npmjs.com/package/@142vip/nest-typeorm)
- [`@142vip/oauth2.0`](https://www.npmjs.com/package/@142vip/oauth2.0)
- [`@142vip/open-source`](https://www.npmjs.com/package/@142vip/open-source)
- [`@142vip/redis`](https://www.npmjs.com/package/@142vip/redis)
- [`@142vip/release-version`](https://www.npmjs.com/package/@142vip/release-version)
- [`@142vip/typeorm`](https://www.npmjs.com/package/@142vip/typeorm)
- [`@142vip/utils`](https://www.npmjs.com/package/@142vip/utils)
- [`@142vip/vitepress`](https://www.npmjs.com/package/@142vip/vitepress)
- [`@142vip/vuepress`](https://www.npmjs.com/package/@142vip/vuepress)

## 使用

```shell
# 安装依赖（首选 ./scripts/ci，与 CI 一致；有问题再用 pnpm install）
./scripts/ci
# 若 ci 失败：pnpm install

# 文档站开发（根目录）
pnpm dev                    # 根站 :8080

# 单包 / demo（推荐进入对应目录）
cd packages/vitepress && pnpm build
cd apps/vitepress-demo && pnpm dev      # :3080

# 全量编译（根目录）
pnpm build:packages         # 所有 @142vip/* 包
pnpm build:apps             # 所有 *-demo
pnpm build:docs             # 文档站 + TypeDoc API
pnpm build                  # 全量

# 代码质量（根目录，提交前必跑）
pnpm lint
pnpm lint:fix

# 测试
pnpm test
cd packages/utils && pnpm test

# 清理缓存
pnpm clean:cache
```

## 仓库架构

pnpm 9 + Turbo monorepo：`packages/` 含 31 个可发布 `@142vip/*` npm 包，`apps/` 含 4 个 `*-demo` 示例。

```mermaid
flowchart TB
  ROOT["core-x · pnpm9 + turbo"]

  PKGS["packages/ · 31 × @142vip/*"]
  APPS["apps/ · 4 × *-demo"]
  VP[".vitepress/ · 根文档站 :8080"]
  DOCS["docs/ · index · apis · wiki"]
  SCR["scripts/ · ci · 发布 · commit"]
  GHA[".github/ · CI + CD"]

  ROOT --> PKGS
  ROOT --> APPS
  ROOT --> VP
  ROOT --> DOCS
  ROOT --> SCR
  ROOT --> GHA
  APPS --> PKGS
  VP --> PKGS
  DOCS --> VP
  SCR --> GHA
```

## 技术分层

```mermaid
flowchart LR
  DEMO["apps/*-demo ×4"] --> PKG["@142vip/* ×31"]
  PKG --> UTIL["utils · open-source"]
  PKG --> CLI["fairy-cli · release-version · eslint-config"]
  PKG --> FW["Nest · Egg · VitePress · VuePress"]
```

## 模块发布

npm 包默认 **ESM** 交付，**同时提供 CJS** 以兼容 `require`（unbuild 双格式）；Nest 系为 CommonJS；Egg 子插件多为源码直发。

```mermaid
flowchart LR
  SRC["src/"] --> UB["unbuild · 18 包"]
  SRC --> TSC["tsc · Nest 5 包"]
  SRC --> EGG["Egg 插件 8 包 · 无 build 脚本"]
  UB --> DIST["dist .mjs + .cjs"]
  TSC --> DIST2["dist .js CJS"]
  EGG --> NPM["npm @142vip/*"]
  DIST --> EXP["exports"]
  DIST2 --> EXP
  EXP --> NPM
```

## 开发与发布流程

```mermaid
sequenceDiagram
  participant Dev as 开发者
  participant Hook as git hooks
  participant CI as GitHub CI
  participant CD as GitHub CD
  participant NPM as npm

  Dev->>Dev: cd build · lint:fix · 文档同步
  Dev->>Hook: git commit
  Hook->>Hook: lint:fix · check:commit
  Dev->>CI: PR → next
  CI->>CI: scripts/ci · lint · build:docs
  CI->>CD: merge next
  CD->>NPM: release @142vip/*
  CD->>CD: GitHub Pages
```

## 本地开发流程

```mermaid
flowchart TD
  A["./scripts/ci<br/>失败则 pnpm install"] --> B["改 packages / apps"]
  B --> C["cd 模块目录 && pnpm build"]
  C --> D["pnpm lint:fix · 0 error"]
  D --> E["同步文档 · README · sidebar"]
  E --> F{"预览?"}
  F -->|根站 :8080| G["pnpm dev"]
  F -->|demo :3080| H["cd apps/vitepress-demo && pnpm dev"]
  G --> I["pnpm build:docs"]
  H --> I
```

## 趋势

<a href="https://github.com/142vip/core-x" title="@142vip/core-x">
  <picture>
    <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=142vip%2Fcore-x%2C142vip%2F408csfamily%2C142vip%2Fjavascriptcollection&type=Date&sealed_token=iaO-GLnvLpYHibmRk7lxdWHU5MRcN8yp072DbAkSuka6yVP87RCc245bDe_8qXluQuI-105rgdN5qw_G7omm8P05FDOB4ir6De_EdwCOyZUuxWCQE-LfbA" />
  </picture>
</a>

## 贡献者

**感谢所有向仓库贡献代码的开发者**

<a href="https://github.com/142vip/core-x/graphs/contributors">
  <img src="https://contrib.rocks/image?repo=142vip/core-x" alt="@142vip/core-x" title="@142vip/core-x" />
</a>

## 联系作者

若系列文章对你有所帮助，欢迎订阅公众号或微信”骚扰“，获取更多内容。**商务合作请备注来意**

<div align="center" style="text-align: center;margin: 10px" id="we-media-container">
    <div align="center" >
            <img src="https://cdn.statically.io/gh/142vip/cdn_service@main/media/main-code.png"
                width="auto"
                style="margin:5px;border-radius: 5px"
                title="关注微信公众号或添加好友联系储凡" alt="关注微信公众号或添加好友联系储凡"/>
    </div>
</div>

交流/加群/互看朋友圈、**聊天/提问/建议/提需求** 可以在公众号直接**私信**，有时间即会回复，偶尔的延迟和疏漏还请小伙伴们谅解，蟹蟹。

<!-- #endregion we-media -->

## 证书

[MIT](https://opensource.org/license/MIT)

Copyright (c) 2019-present, @142vip 储凡

**仅供学习参考，商业使用请保留作者版权信息，作者不保证也不承担任何软件的使用风险。**