# generator-bs-plugin

> Scaffold for Blessing Skin plugin.

Latest version **0.4.1** (published 2018-06-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install generator-bs-plugin
pnpm add generator-bs-plugin
yarn add generator-bs-plugin
bun add generator-bs-plugin
```

## 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.4.1 |
| Published | 2018-06-18 |
| First published | 2018-06-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pig Fang |
| Maintainers | gplane |
| Keywords | blessing-skin, yeoman-generator |

## Links

- npm: https://www.npmjs.com/package/generator-bs-plugin
- Repository: https://github.com/bs-community/generator-bs-plugin
- npm.io page: https://npm.io/package/generator-bs-plugin

## Dependencies (4)

- [php-parser](https://npm.io/package/php-parser.md) ^3.0.0-alpha2
- [php-unparser](https://npm.io/package/php-unparser.md) ^0.2.9
- [lodash.kebabcase](https://npm.io/package/lodash.kebabcase.md) ^4.1.1
- [yeoman-generator](https://npm.io/package/yeoman-generator.md) ^2.0.1

## Recent versions

- 0.4.1 (latest) — 2018-06-18
- 0.4.0 — 2018-06-18
- 0.3.0 — 2018-06-18
- 0.2.0 — 2018-06-18
- 0.1.0 — 2018-06-18

## README

# generator-bs-plugin

快速生成 Blessing Skin 插件的脚手架

![](screenshot.gif)

## 特性

- 开箱即用的现代化前端工作流程
- 带有可用的路由、控制器以及与 Blessing Skin 风格一致的页面
- 在命令行中通过简单的命令即可继续添加路由或控制器

## 安装

首先请确保您安装了 Node.js。

安装好 Node.js 之后，

如果您使用 Yarn：

```
$ yarn global add yo generator-bs-plugin
```

否则：

```
$ npm i -g yo generator-bs-plugin
```

## 使用

### 新建一个插件

执行：

```
$ yo bs-plugin
```

接下来根据您的需要回答问题即可。

### 编写代码

您可以在 `assets/src/index.js` 文件中编写 JavaScript 代码，支持 ES6+ 特性。

还可以在 `assets/src/index.css` 中编写 CSS 代码。

默认已生成好一个控制器和视图，您可以根据需要进行修改。

`bootstrap.php` 中已定义好一条默认的路由，您可以根据需要修改其路径，或修改中间件。

### 向已有插件添加控制器

执行：

```
$ yo bs-plugin:controller <控制器名称>
```

例如执行 `yo bs-plugin:controller NewController`，就会向 `src` 目录中添加 `NewController.php`。

**注意必须保证是向已有的插件添加控制器，因为要获取命名空间**

### 向已有插件添加路由

执行：

```
$ yo bs-plugin:route
```

接下来根据您的需要回答问题即可。

**注意**

- 只能向现有的插件添加新的路由
- `src/routes.php` 必须存在且大致符合以下格式

```php
use App\Services\Hook;

Hook::addRoute(function ($router) {

});
```

### 向已有插件添加菜单项

执行：

```
$ yo bs-plugin:menu
```

接下来根据您的需要回答问题即可。

**注意只能向现有的插件添加新的菜单项**

## License

MIT © [Pig Fang](https://gplane.win/)

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