Skip to content

Commit

Permalink
🎉 chore: project init
Browse files Browse the repository at this point in the history
  • Loading branch information
arvinxx committed Oct 20, 2023
1 parent d4b8d32 commit 7db2a71
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 26 deletions.
2 changes: 1 addition & 1 deletion .dumirc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { homepage } from './package.json';

export default defineConfig({
themeConfig: {
name: '@arvinxu/npm-template',
name: '@ant-design/pro-chat',
github: homepage,
},
html2sketch: {},
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: '报告Bug 🐛'
about: 报告 @arvinxu/npm-template 的 bug
about: 报告 @ant-design/pro-chat 的 bug
title: '🐛[BUG]'
labels: '🐛 BUG'
assignees: ''
Expand Down Expand Up @@ -35,7 +35,7 @@ assignees: ''

### © 版本信息

- @arvinxu/npm-template 版本: [e.g. 1.0.0]
- @ant-design/pro-chat 版本: [e.g. 1.0.0]
- 浏览器环境
- 开发环境 [e.g. mac OS]

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: '功能需求 ✨'
about: 对 @arvinxu/npm-template 的需求或建议
about: 对 @ant-design/pro-chat 的需求或建议
title: '👑 [需求]'
labels: '👑 Feature'
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: '疑问或需要帮助 ❓'
about: 对 @arvinxu/npm-template 使用的疑问或需要帮助
about: 对 @ant-design/pro-chat 使用的疑问或需要帮助
title: '🧐[问题]'
labels: '🧐 Question'
assignees: ''
Expand Down
33 changes: 20 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

[//]: # '<img width="160" src="https://avatars.githubusercontent.com/u/17870709?v=4">'

<h1>@arvinxu/npm-template</h1>
<h1>@ant-design/pro-chat</h1>

一个开发 npm 项目的模板

Expand All @@ -25,7 +25,7 @@
<!-- gitpod url -->

[gitpod-badge]: https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod
[gitpod-url]: https://gitpod.io/#https://github.com/ant-design/@arvinxu/npm-template
[gitpod-url]: https://gitpod.io/#https://github.com/ant-design/@ant-design/pro-chat

<!-- umi url -->

Expand All @@ -34,10 +34,10 @@

<!-- npm url -->

[npm-image]: http://img.shields.io/npm/v/@arvinxu/npm-template.svg?style=flat-square&color=deepgreen&label=latest
[npm-url]: http://npmjs.org/package/@arvinxu/npm-template
[npm-size]: https://img.shields.io/bundlephobia/minzip/@arvinxu/npm-template?color=deepgreen&label=gizpped%20size&style=flat-square
[npm-size-url]: https://packagephobia.com/result?p=@arvinxu/npm-template
[npm-image]: http://img.shields.io/npm/v/@ant-design/pro-chat.svg?style=flat-square&color=deepgreen&label=latest
[npm-url]: http://npmjs.org/package/@ant-design/pro-chat
[npm-size]: https://img.shields.io/bundlephobia/minzip/@ant-design/pro-chat?color=deepgreen&label=gizpped%20size&style=flat-square
[npm-size-url]: https://packagephobia.com/result?p=@ant-design/pro-chat

<!-- coverage -->

Expand All @@ -50,8 +50,8 @@
[release-ci]: https://github.com/arvinxx/npm-template/workflows/Release%20CI/badge.svg
[test-ci-url]: https://github.com/arvinxx/npm-template/actions?query=workflow%3ATest%20CI
[release-ci-url]: https://github.com/arvinxx/npm-template/actions?query=workflow%3ARelease%20CI
[download-image]: https://img.shields.io/npm/dm/@arvinxu/npm-template.svg?style=flat-square
[download-url]: https://npmjs.org/package/@arvinxu/npm-template
[download-image]: https://img.shields.io/npm/dm/@ant-design/pro-chat.svg?style=flat-square
[download-url]: https://npmjs.org/package/@ant-design/pro-chat

</div>

Expand All @@ -71,20 +71,27 @@
推荐使用 `pnpm` 安装

```bash
pnpm i @arvinxu/npm-template -S
pnpm i @ant-design/pro-chat -S
```


### 使用

基于该仓库模板可以快速创建一个 npm 包的工程化脚手架。

## 迭代记录
### 适配 NextJS

为适配 nextjs 的 SSR 模式, 需要将本包添加到 `next.config.js``transpilePackages` 配置中:

2023.06.12 - 完善文档与 README 框架
```js
// next.config.js
const nextConfig = {
// ...other config
transpilePackages: ['@ant-design/pro-chat'],
};
```

2022.12.17 - 基于蚂蚁研发技术栈配置完成最新的 npm 研发脚手架

详情:[CHANGELOG](./CHANGELOG.md)

## 🤝 Contributing

Expand Down
2 changes: 1 addition & 1 deletion docs/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ title: 使用介绍

## Step2. 初始化项目信息

使用编辑器全局替换 `@arvinxu/npm-template` 为你的包名(例如 `antd-style`),执行 `pnpm i` 安装依赖。
使用编辑器全局替换 `@ant-design/pro-chat` 为你的包名(例如 `antd-style`),执行 `pnpm i` 安装依赖。

## Step3. 开始开发
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
hero:
title: @arvinxu/npm-template
title: @ant-design/pro-chat
description: a npm develop template
actions:
- text: 快速上手
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@arvinxu/npm-template",
"version": "1.11.1",
"description": "a npm develop template",
"name": "@ant-design/pro-chat",
"version": "0.0.0",
"description": "a solution for ai chat",
"keywords": [
"npm",
"template"
Expand Down
2 changes: 1 addition & 1 deletion tests/index.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { hello } from '@arvinxu/npm-template';
import { hello } from '@ant-design/pro-chat';

test('hello', () => {
expect(hello()).toBe('world');
Expand Down
4 changes: 2 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"paths": {
"@@/*": [".dumi/tmp/*"],
"@/*": ["src"],
"@arvinxu/npm-template": ["src"],
"@arvinxu/npm-template/*": ["src/*", "*"]
"@ant-design/pro-chat": ["src"],
"@ant-design/pro-chat/*": ["src/*", "*"]
}
}
}

0 comments on commit 7db2a71

Please sign in to comment.