# easy-issue

> 一个可以根据指定的markdown文件生成GitHub issue的小工具

Latest version **0.0.2** (published 2021-11-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install easy-issue
pnpm add easy-issue
yarn add easy-issue
bun add easy-issue
```

Provides the command `issue`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2021-11-14 |
| First published | 2021-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 427.7 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Baiyusoup |
| Maintainers | baiyusoup |
| Keywords | markdown, issue |

## Links

- npm: https://www.npmjs.com/package/easy-issue
- Repository: https://github.com/Baiyusoup/easy-issue
- Homepage: https://github.com/Baiyusoup/easy-issue#readme.md
- Issues: https://github.com/Baiyusoup/easy-issue/issues
- npm.io page: https://npm.io/package/easy-issue

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^0.24.0
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [picocolors](https://npm.io/package/picocolors.md) ^1.0.0
- [gray-matter](https://npm.io/package/gray-matter.md) ^4.0.3

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.0.2 (latest) — 2021-11-14

## README

# easy-issue

一个根据本地 markdown 文件（需要指定）生成 github issue，并推送到个人仓库（需要指定）的小工具。

## 头都要笑飞的背景

之前我打算用 GitHub issue 当博客（希望这种想法不要被打），当进入`New issue`时，我看到那个界面有些“不好看”，然后就想着在本地用 markdown 写博客，然后通过脚本将文件内容自动生成指定仓库的 issue。

说干就干！

等我写完这个小工具之后，再次进入`New issue`时，突然看到那个界面不是之前看到的那样，那个编辑器界面还挺好看的。

然后就想到那晚应该是网络不好，那个编辑器界面没刷新出来。

## 使用

安装

```shell
npm i easy-issues -D
```

安装完成之后，执行：

```shell
npx issue init
```

这个命令执行后，`easy-issue`会将`issue`命令添加到 package.json 的 scripts 里面，然后在根目录下创建`issue.config.js`和`editor.md`文件。当然，你也可以不需要执行这个命令，直接在根目录下创建`issue.config.js`和`editor.md`文件。

你在`editor.md`里面写完你的内容之后，在终端执行

```shell
npm run issue
```

或者

```
npx issue
```

`easy-issue`就会解析`editor.md`，生成 GitHub issue，然后上传到指定仓库。

## issue.config.js

```js
module.exports = {
  owner: '用户名',
  repo: '指定仓库',
  accessToken: 'personal access token',
  editor: 'issue内容的markdown文件名（可选，默认是根目录下的editor.md）',
};
```

## editor 文件

格式必须如下：

```text
---
title: 'issue名称'
labels:
  - label1
  - ...
---
你的issue内容
```

需要注意的是`labels`所指定的 issue label 必须是存在仓库里面。

---
_Source: https://npm.io/package/easy-issue · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._