open-index/open-npm huggingface dataset:
npm package: @spaceflow/ci-scripts
Description: Spaceflow CI 脚本插件，用于在分支锁定/解锁之间执行 JS 语句
Author: Lydanne
Latest version: 0.20.0

# @spaceflow/ci-scripts

[![npm version](https://img.shields.io/npm/v/@spaceflow/ci-scripts?color=blue)](https://www.npmjs.com/package/@spaceflow/ci-scripts)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow CI 脚本扩展，在分支锁定/解锁保护下执行 JavaScript 语句。适用于 CI 环境中需要原子性执行脚本的场景。

## 安装

```bash
pnpm spaceflow install @spaceflow/ci-scripts
```

## 使用

```bash
# 执行 JS 表达式
spaceflow ci-scripts -e "console.log('hello')"

# CI 模式
spaceflow ci-scripts --ci -e "await fetch('https://api.example.com/deploy')"

# 仅预览，不实际执行
spaceflow ci-scripts --dry-run -e "console.log('test')"
```

## 命令行参数

| 参数                  | 简写 | 说明                 |
| --------------------- | ---- | -------------------- |
| `--expression <code>` | `-e` | 要执行的 JS 表达式   |
| `--ci`                | `-c` | 在 CI 环境中运行     |
| `--dry-run`           | `-d` | 仅打印将要执行的操作 |

## 工作流程

1. **锁定分支** — 创建分支保护规则，防止其他推送干扰
2. **执行脚本** — 运行指定的 JavaScript 语句
3. **解锁分支** — 删除保护规则，恢复正常状态

## 环境变量

| 变量                | 说明                          |
| ------------------- | ----------------------------- |
| `GITHUB_TOKEN`      | GitHub API Token              |
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |
| `GITHUB_REF_NAME`   | 当前分支名称                  |

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/ci-shell
Description: Spaceflow CI Shell 插件，用于在分支锁定/解锁之间执行 Shell 命令
Author: Lydanne
Latest version: 0.20.0

# @spaceflow/ci-shell

[![npm version](https://img.shields.io/npm/v/@spaceflow/ci-shell?color=blue)](https://www.npmjs.com/package/@spaceflow/ci-shell)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow CI Shell 扩展，在分支锁定/解锁保护下执行 Shell 命令。适用于 CI 环境中需要原子性执行命令的场景。

## 安装

```bash
pnpm spaceflow install @spaceflow/ci-shell
```

## 使用

```bash
# 执行 Shell 命令
spaceflow ci-shell -e "npm run deploy"

# CI 模式
spaceflow ci-shell --ci -e "pnpm build && pnpm test"

# 仅预览，不实际执行
spaceflow ci-shell --dry-run -e "echo 'test'"
```

## 命令行参数

| 参数                 | 简写 | 说明                 |
| -------------------- | ---- | -------------------- |
| `--expression <cmd>` | `-e` | 要执行的 Shell 命令  |
| `--ci`               | `-c` | 在 CI 环境中运行     |
| `--dry-run`          | `-d` | 仅打印将要执行的操作 |

## 工作流程

1. **锁定分支** — 创建分支保护规则，防止其他推送干扰
2. **执行命令** — 运行指定的 Shell 命令
3. **解锁分支** — 删除保护规则，恢复正常状态

## 环境变量

| 变量                | 说明                          |
| ------------------- | ----------------------------- |
| `GITHUB_TOKEN`      | GitHub API Token              |
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |
| `GITHUB_REF_NAME`   | 当前分支名称                  |

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/cli
Description: Spaceflow CLI 工具
Author: Lydanne
Latest version: 0.41.0

# @spaceflow/cli

[![npm version](https://img.shields.io/npm/v/@spaceflow/cli?color=blue)](https://www.npmjs.com/package/@spaceflow/cli)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow CLI 壳子入口，提供 `spaceflow` / `space` 命令。负责引导 `.spaceflow/` 工作目录并启动 `@spaceflow/core` 运行时。

## 安装

```bash
pnpm add -D @spaceflow/cli
```

## 使用

```bash
# 使用 spaceflow 或 space 命令
spaceflow <command> [options]
space <command> [options]
```

## 工作原理

CLI 本身不包含任何命令实现，职责仅限于：

1. 读取 `.spaceflow/package.json` 确定依赖
2. 生成 `.spaceflow/bin/index.js` 入口文件
3. 通过 `execSync` 启动子进程执行 `@spaceflow/core` 的 `exec()` 函数

所有命令（内置 13 个 + 外部扩展）均由 `@spaceflow/core` 提供。

## 内置命令

| 命令         | 说明                 |
| ------------ | -------------------- |
| `install`    | 安装扩展             |
| `uninstall`  | 卸载扩展             |
| `build`      | 构建扩展             |
| `dev`        | 开发模式运行         |
| `create`     | 创建新扩展           |
| `update`     | 更新扩展             |
| `list`       | 列出已安装扩展       |
| `clear`      | 清理缓存             |
| `runx` / `x` | 执行扩展命令         |
| `schema`     | 生成配置 JSON Schema |
| `commit`     | AI 智能提交          |
| `setup`      | 初始化项目配置       |
| `mcp`        | 启动 MCP Server      |

## 扩展开发

```bash
# 创建命令型扩展
spaceflow create command my-extension

# 创建 MCP 服务扩展
spaceflow create mcp my-mcp
```

### 扩展结构

```typescript
import { defineExtension } from "@spaceflow/core";

export default defineExtension({
  name: "my-extension",
  commands: [
    {
      name: "my-command",
      description: "My command description",
      run: async (args, options, ctx) => {
        ctx.output.info("Hello from my command!");
      },
    },
  ],
});
```

## 编辑器集成

通过配置文件中的 `support` 字段，`spaceflow install` 会自动将扩展关联到对应编辑器目录：

| 编辑器      | 配置目录     |
| ----------- | ------------ |
| Claude Code | `.claude/`   |
| Windsurf    | `.windsurf/` |
| Cursor      | `.cursor/`   |
| OpenCode    | `.opencode/` |

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/period-summary
Description: Spaceflow 周期统计命令，根据时间范围统计 PR 贡献情况，按人员汇总并排序
Author: Lydanne
Latest version: 0.20.0

# @spaceflow/period-summary

[![npm version](https://img.shields.io/npm/v/@spaceflow/period-summary?color=blue)](https://www.npmjs.com/package/@spaceflow/period-summary)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow 周期统计扩展，根据时间范围统计 PR 贡献情况，按人员汇总并排序。支持输出到控制台、GitHub Issue 或 Markdown 文件。

## 安装

```bash
pnpm spaceflow install @spaceflow/period-summary
```

## 功能特性

- **时间范围统计** — 支持自定义日期范围或预设时间段
- **多维度统计** — PR 数量、代码行数、变更文件数、问题数量
- **综合评分** — 根据代码量和问题数量权衡计算分数
- **按人员排序** — 按综合分数降序排列贡献者
- **多种输出方式** — 控制台、GitHub Issue、Markdown 文件

## 使用

```bash
# 使用时间预设 - 统计本周
spaceflow period-summary -p this-week

# 使用时间预设 - 统计上月
spaceflow period-summary -p last-month

# 自定义日期范围
spaceflow period-summary -s 2026-01-01 -u 2026-01-18

# 输出到 GitHub Issue
spaceflow period-summary -p last-week -o issue -c
```

## 命令行参数

| 参数                | 简写 | 说明                                                                |
| ------------------- | ---- | ------------------------------------------------------------------- |
| `--period <preset>` | `-p` | 时间预设（`this-week` / `last-week` / `this-month` / `last-month`） |
| `--since <date>`    | `-s` | 起始日期（`YYYY-MM-DD` 格式）                                       |
| `--until <date>`    | `-u` | 截止日期（`YYYY-MM-DD` 格式）                                       |
| `--output <format>` | `-o` | 输出方式（`console` / `issue` / `markdown`）                        |
| `--ci`              | `-c` | 在 CI 环境中运行                                                    |
| `--dry-run`         | `-d` | 仅打印将要执行的操作                                                |

## 环境变量

| 变量                | 说明                          |
| ------------------- | ----------------------------- |
| `GITHUB_TOKEN`      | GitHub API Token              |
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/review-summary
Description: Spaceflow 审查统计命令，根据时间范围统计 PR 贡献情况，按人员汇总并排序
Author: Lydanne
Latest version: 0.52.0

# @spaceflow/review-summary

[![npm version](https://img.shields.io/npm/v/@spaceflow/review-summary?color=blue)](https://www.npmjs.com/package/@spaceflow/review-summary)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow 审查统计扩展，根据时间范围统计 PR 贡献情况，按人员汇总并排序。支持输出到控制台、GitHub Issue 或 Markdown 文件。

## 安装

```bash
pnpm spaceflow install @spaceflow/review-summary
```

## 功能特性

- **时间范围统计** — 支持自定义日期范围或预设时间段
- **多维度统计** — PR 数量、代码行数、变更文件数、问题数量
- **综合评分** — 根据代码量和问题数量权衡计算分数
- **按人员排序** — 按综合分数降序排列贡献者
- **多种输出方式** — 控制台、GitHub Issue、Markdown 文件

## 使用

```bash
# 使用时间预设 - 统计本周
spaceflow review-summary -p this-week

# 使用时间预设 - 统计上月
spaceflow review-summary -p last-month

# 自定义日期范围
spaceflow review-summary -s 2026-01-01 -u 2026-01-18

# 输出到 GitHub Issue
spaceflow review-summary -p last-week -o issue -c
```

## 命令行参数

| 参数                | 简写 | 说明                                                                |
| ------------------- | ---- | ------------------------------------------------------------------- |
| `--period <preset>` | `-p` | 时间预设（`this-week` / `last-week` / `this-month` / `last-month`） |
| `--since <date>`    | `-s` | 起始日期（`YYYY-MM-DD` 格式）                                       |
| `--until <date>`    | `-u` | 截止日期（`YYYY-MM-DD` 格式）                                       |
| `--output <format>` | `-o` | 输出方式（`console` / `issue` / `markdown`）                        |
| `--ci`              | `-c` | 在 CI 环境中运行                                                    |
| `--dry-run`         | `-d` | 仅打印将要执行的操作                                                |

## 环境变量

| 变量                | 说明                          |
| ------------------- | ----------------------------- |
| `GITHUB_TOKEN`      | GitHub API Token              |
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/scripts
Description: Spaceflow 脚本插件，用于在分支锁定/解锁之间执行 JS 语句
Author: Lydanne
Latest version: 0.34.0

# @spaceflow/scripts

[![npm version](https://img.shields.io/npm/v/@spaceflow/scripts?color=blue)](https://www.npmjs.com/package/@spaceflow/scripts)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow 脚本扩展，在分支锁定/解锁保护下执行 JavaScript 语句。适用于 CI 环境中需要原子性执行脚本的场景。

## 安装

```bash
pnpm spaceflow install @spaceflow/scripts
```

## 使用

```bash
# 执行 JS 表达式
spaceflow scripts -e "console.log('hello')"

# CI 模式
spaceflow scripts --ci -e "await fetch('https://api.example.com/deploy')"

# 仅预览，不实际执行
spaceflow scripts --dry-run -e "console.log('test')"
```

## 命令行参数

| 参数                  | 简写 | 说明                 |
| --------------------- | ---- | -------------------- |
| `--expression <code>` | `-e` | 要执行的 JS 表达式   |
| `--ci`                | `-c` | 在 CI 环境中运行     |
| `--dry-run`           | `-d` | 仅打印将要执行的操作 |

## 工作流程

1. **锁定分支** — 创建分支保护规则，防止其他推送干扰
2. **执行脚本** — 运行指定的 JavaScript 语句
3. **解锁分支** — 删除保护规则，恢复正常状态

## 环境变量

| 变量                | 说明                          |
| ------------------- | ----------------------------- |
| `GITHUB_TOKEN`      | GitHub API Token              |
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |
| `GITHUB_REF_NAME`   | 当前分支名称                  |

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/shared
Description: Spaceflow 公共工具库
Author: Lydanne
Latest version: 0.8.0

# @spaceflow/shared

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> 轻量公共工具库，`@spaceflow/cli` 和 `@spaceflow/core` 共同依赖。

## 定位

`@spaceflow/shared` 提供 CLI 壳子和 core 运行时都需要的基础工具函数，避免 CLI 直接依赖 core 的重量级模块。

## 模块

| 模块              | 说明                                                             |
| ----------------- | ---------------------------------------------------------------- |
| `config`          | 配置文件读写（`readConfigSync`、`writeConfigSync`、`deepMerge`） |
| `spaceflow-dir`   | `.spaceflow/` 工作目录管理                                       |
| `package-manager` | 包管理器检测（pnpm / npm）                                       |
| `source-utils`    | 源类型判断（npm / git / local）                                  |
| `editor-config`   | 编辑器目录映射                                                   |
| `verbose`         | 日志级别定义与解析                                               |

## 主要导出

```typescript
// 配置
import {
  readConfigSync,
  writeConfigSync,
  deepMerge,
  getConfigPath,
  getDependencies,
  updateDependency,
  removeDependency,
  getSupportedEditors,
} from "@spaceflow/shared";

// .spaceflow/ 目录
import {
  ensureSpaceflowDir,
  ensureSpaceflowPackageJson,
  ensureDependencies,
  loadExtensionsFromDir,
  SPACEFLOW_DIR,
} from "@spaceflow/shared";

// 包管理器
import {
  getPackageManager,
  detectPackageManager,
  isPnpmWorkspace,
} from "@spaceflow/shared";

// 源类型
import {
  getSourceType,
  isGitUrl,
  isLocalPath,
  normalizeSource,
  extractNpmPackageName,
} from "@spaceflow/shared";

// 编辑器
import {
  EDITOR_DIR_MAPPING,
  DEFAULT_EDITOR,
  getEditorDirName,
} from "@spaceflow/shared";

// 日志级别
import { shouldLog, normalizeVerbose, parseVerbose } from "@spaceflow/shared";
```

## 依赖关系

```text
@spaceflow/cli ──→ @spaceflow/shared
@spaceflow/core ─→ @spaceflow/shared（重导出部分模块）
```

## 许可证

[MIT](../../LICENSE)
npm package: @spaceflow/shell
Description: Spaceflow Shell 插件，用于在分支锁定/解锁之间执行 Shell 命令
Author: Lydanne
Latest version: 0.34.0

# @spaceflow/shell

[![npm version](https://img.shields.io/npm/v/@spaceflow/shell?color=blue)](https://www.npmjs.com/package/@spaceflow/shell)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

> Spaceflow Shell 扩展，在分支锁定/解锁保护下执行 Shell 命令。适用于 CI 环境中需要原子性执行命令的场景。

## 安装

```bash
pnpm spaceflow install @spaceflow/shell
```

## 使用

```bash
# 执行 Shell 命令
spaceflow shell -e "npm run deploy"

# CI 模式
spaceflow shell --ci -e "pnpm build && pnpm test"

# 仅预览，不实际执行
spaceflow shell --dry-run -e "echo 'test'"
```

## 命令行参数

| 参数                 | 简写 | 说明                 |
| -------------------- | ---- | -------------------- |
| `--expression <cmd>` | `-e` | 要执行的 Shell 命令  |
| `--ci`               | `-c` | 在 CI 环境中运行     |
| `--dry-run`          | `-d` | 仅打印将要执行的操作 |

## 工作流程

1. **锁定分支** — 创建分支保护规则，防止其他推送干扰
2. **执行命令** — 运行指定的 Shell 命令
3. **解锁分支** — 删除保护规则，恢复正常状态

## 环境变量

| 变量                | 说明                          |
| ------------------- | ----------------------------- |
| `GITHUB_TOKEN`      | GitHub API Token              |
| `GITHUB_REPOSITORY` | 仓库名称（`owner/repo` 格式） |
| `GITHUB_REF_NAME`   | 当前分支名称                  |

## 许可证

[MIT](../../LICENSE)
npm package: @spacego/event-emitter
Description: 🚀 A basic publishing subscriber pattern event-emitter.
Author: dshuais
Latest version: 0.0.1-alpha

<!--
 * @Author: dushuai
 * @Date: 2025-05-06 23:49:29
 * @LastEditors: dushuai
 * @LastEditTime: 2025-05-06 23:55:52
 * @description: 心平气和
-->

# @spacego/event-emitter

`@spacego/event-emitter` 是一个完全基于 `typescript` 的发布订阅者模式库，功能丰富且完善。

## ✨ Features

- Easy to learn and use.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/event-emitter
# or
$ pnpm add @spacego/event-emitter `推荐`
# or
$ yarn add @spacego/event-emitter
```

## 🔨 Usage

```ts
// 1、单例直接使用（推荐）
import EventEmitter from '@spacego/event-emitter';
EventEmitter.on(xxxx) ...

// 2、重新封装实例
import { EventEmitterInstance } from '@spacego/event-emitter';
const emitter = new EventEmitterInstance();
emitter.on(xxxx) ...
```

## 🚀 API

...
npm package: @spacego/fe-components
Description: 🚀 A component library for fe to use.
Author: dshuais
Latest version: 1.0.6

<!--
 * @Author: dushuai
 * @Date: 2025-08-30 17:23:07
 * @LastEditors: dushuai
 * @LastEditTime: 2026-01-30 20:22:56
 * @description: 心平气和
-->
# @spacego/fe-components

`@spacego/fe-components` 是一个完全基于 `typescript` + `antd` 的UI组件库，提供了一些常用的组件和我的默认Layout模版等。

## ✨ Features

- Easy to learn and use.
- Contains common hooks and encapsulates common apis.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/fe-components
# or
$ pnpm add @spacego/fe-components `推荐`
# or
$ yarn add @spacego/fe-components
```

## 🔨 Usage

```ts
import { FeButton ... } from '@spacego/fe-components';
```

## 🚀 API

...
npm package: @spacego/hooks
Description: 🚀 Common hooks in React. 
Author: dshuais
Latest version: 1.0.1

# @spacego/turbo-utils

`@spacego/turbo-utils` 是一个完全基于 `typescript` 的工具库，提供了一些常用的工具函数等。

## ✨ Features

- Easy to learn and use.
- Contains common hooks and encapsulates common apis.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/turbo-utils
# or
$ pnpm add @spacego/turbo-utils `推荐`
# or
$ yarn add @spacego/turbo-utils
```

## 🔨 Usage

```ts
import { padQuery, pick, deepClone, uuid ... } from '@spacego/turbo-utils';
```

## 🚀 API

...
npm package: @spacego/taro-components
Description: 🚀 A component library for taro to use.
Author: dshuais
Latest version: 1.0.2

<!--
 * @Author: dushuai
 * @Date: 2025-05-08 21:35:13
 * @LastEditors: dushuai
 * @LastEditTime: 2025-05-11 15:23:55
 * @description: 心平气和
-->

# @spacego/taro-components

`@spacego/taro-components` 是一个完全基于 `typescript` + `taro` + `@nutui/nutui-react-taro` 封装的前端组件库。

## ✨ Features

- Easy to learn and use.
- Contains common hooks and encapsulates common apis.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/taro-components
# or
$ pnpm add @spacego/taro-components `推荐`
# or
$ yarn add @spacego/taro-components
```

## 🔨 Usage

```ts
import { FeForm, HeaderWarp, ScrollView ... } from '@spacego/taro-components';
```

## 🚀 API

...
npm package: @spacego/tools-taro
Description: 🚀 A library of common tools and hooks for react/taro.
Author: dshuais
Latest version: 1.0.3

<!--
 * @Author: dushuai
 * @Date: 2025-05-10 00:44:14
 * @LastEditors: dushuai
 * @LastEditTime: 2025-05-10 00:50:43
 * @description: 心平气和
-->

# @spacego/tools-taro

`@spacego/tools-taro` 是一个完全基于 `typescript` + `taro` 的工具库，提供了一些常用的工具函数等。

## ✨ Features

- Easy to learn and use.
- Contains common hooks and encapsulates common apis.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/tools-taro
# or
$ pnpm add @spacego/tools-taro `推荐`
# or
$ yarn add @spacego/tools-taro
```

## 🔨 Usage

```ts
import { navigateTo, requestPayment, $toast, ... } from '@spacego/tools-taro';
```

## 🚀 API

...
npm package: @spacego/turbo-utils
Description: 🚀 A universal tool library. It basically covers all the commonly used practical functions. 
Author: dshuais
Latest version: 1.0.4

# @spacego/turbo-utils

`@spacego/turbo-utils` 是一个完全基于 `typescript` 的工具库，提供了一些常用的工具函数等。

## ✨ Features

- Easy to learn and use.
- Contains common hooks and encapsulates common apis.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/turbo-utils
# or
$ pnpm add @spacego/turbo-utils `推荐`
# or
$ yarn add @spacego/turbo-utils
```

## 🔨 Usage

```ts
import { padQuery, pick, deepClone, uuid ... } from '@spacego/turbo-utils';
```

## 🚀 API

...
npm package: @spacego/zustand
Description: 🚀 Offer the best taste of zustand.
Author: dshuais
Latest version: 1.0.1

<!--
 * @Author: dushuai
 * @Date: 2025-05-08 21:35:13
 * @LastEditors: dushuai
 * @LastEditTime: 2025-05-08 21:41:00
 * @description: 心平气和
-->

# @spacego/zustand

`@spacego/zustand` 是一个完全基于 `typescript` + `zustand` 封装的最佳食用，提供了最佳食用的 hook 等。

## ✨ Features

- Easy to learn and use.
- Contains common hooks and encapsulates common apis.
- Written in TypeScript with predictable static types.
- High performance.

## 📦 Install

```bash
$ npm install --save @spacego/zustand
# or
$ pnpm add @spacego/zustand `推荐`
# or
$ yarn add @spacego/zustand
```

## 🔨 Usage

```ts
import { useSelector, ... } from '@spacego/zustand';
```

## 🚀 API

...
npm package: @spacegrimeswap/eslint-config-spacegrime-v1
Description: Eslint config for SpacegrimeSwap
Author: RabbitDoge
Latest version: 1.0.1

# eslint-config-spacegrime

Spacegrime Eslint config with:

- Airbnb config
- Typescript
- Prettier

## Usage

```
npx install-peerdeps --dev @spacegrimeswap/eslint-config-spacegrime
```

Add `"extends": "@spacegrimeswap/eslint-config-spacegrime"` to your eslint config file.
npm package: @spacegrimeswap/sdk
Description: 🛠 An SDK for building applications on top of Spacegrime.
Latest version: 1.0.7

# Spacegrimeswap SDK

Forked from the [Uniswap SDK](https://github.com/Uniswap/uniswap-v2-sdk/commit/a88048e9c4198a5bdaea00883ca00c8c8e582605).

You can refer to the Uniswap SDK documentation [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/).

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/spacegrimeswap/spacegrimeswap-sdk.git
```

Move into the spacegrimeswap-sdk working directory

```sh
cd spacegrimeswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @spacegrimeswap/uikit
Description: Set of UI components for spacegrime projects
Latest version: 0.41.15

# 🥞 Spacegrime UIkit

[![Version](https://img.shields.io/npm/v/@spacegrimeswap-libs/uikit)](https://www.npmjs.com/package/@spacegrimeswap-libs/uikit) [![Size](https://img.shields.io/bundlephobia/min/@spacegrimeswap-libs/uikit)](https://www.npmjs.com/package/@spacegrimeswap-libs/uikit)

Spacegrime UIkit is a set of React components and hooks used to build pages on Spacegrime's apps. It also contains a theme file for dark and light mode.

## Install

`yarn add @spacegrimeswap-libs/uikit`

## Setup

### Theme

Before using Spacegrime UIkit, you need to provide the theme file to styled-component.

```
import { ThemeProvider } from 'styled-components'
import { light, dark } from '@spacegrimeswap-libs/uikit'
...
<ThemeProvider theme={isDark}>...</ThemeProvider>
```

### Reset

A reset CSS is available as a global styled component.

```
import { ResetCSS } from '@spacegrimeswap-libs/uikit'
...
<ResetCSS />
```

### Types

This project is built with Typescript and export all the relevant types.

## How to use the UIkit

If you want to use components from the UIkit, check the [Storybook documentation](https://spacegrimeswap.github.io/spacegrime-uikit/)
npm package: @spacegrimeswapv2/sdk
Description: 🛠 An SDK for building applications on top of Spacegrime.
Latest version: 1.0.0

# Pancakeswap SDK

Forked from the [Uniswap SDK](https://github.com/Uniswap/uniswap-v2-sdk/commit/a88048e9c4198a5bdaea00883ca00c8c8e582605).

You can refer to the Uniswap SDK documentation [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/).

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/pancakeswap/pancakeswap-sdk.git
```

Move into the pancakeswap-sdk working directory

```sh
cd pancakeswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```
npm package: @spacegrimeswapv2/sdk-test
Description: 🛠 An SDK for building applications on top of Pancakeswap.
Latest version: 2.4.0

# Pancakeswap SDK

Forked from the [Uniswap SDK](https://github.com/Uniswap/uniswap-v2-sdk/commit/a88048e9c4198a5bdaea00883ca00c8c8e582605).

You can refer to the Uniswap SDK documentation [uniswap.org](https://uniswap.org/docs/v2/SDK/getting-started/).

## Running tests

To run the tests, follow these steps. You must have at least node v10 and [yarn](https://yarnpkg.com/) installed.

First clone the repository:

```sh
git clone https://github.com/pancakeswap/pancake-swap-sdk.git
```

Move into the pancakeswap-sdk working directory

```sh
cd pancakeswap-sdk/
```

Install dependencies

```sh
yarn install
```

Run tests

```sh
yarn test
```

You should see output like the following:

```sh
yarn run v1.22.4
$ tsdx test
 PASS  test/constants.test.ts
 PASS  test/pair.test.ts
 PASS  test/fraction.test.ts
 PASS  test/miscellaneous.test.ts
 PASS  test/entities.test.ts
 PASS  test/trade.test.ts

Test Suites: 1 skipped, 6 passed, 6 of 7 total
Tests:       3 skipped, 82 passed, 85 total
Snapshots:   0 total
Time:        5.091s
Ran all test suites.
✨  Done in 6.61s.
```