Release 1.2.0

SaekiRaku · Jun 20, 2020 · df360c1 · df360c1
1 parent 518b872
commit df360c1
Show file tree

Hide file tree

Showing 34 changed files with 308 additions and 126 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 node_modules/
 dist/
 .cache/
-temp/
+temp/
+*.vsix
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,15 +4,17 @@ All notable changes to the "vscode-rainbow-fart" extension will be documented in
 
 Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [Unreleased]
+## [1.2.0] - 2020-06-20
 
 ### Added
 
 - Enable/Disable voice packages.
+- English document.
 
 ### Fixed
 
-- Duplicated key in the details modal.
+- Duplicated key in the voice package details modal.
+- Fixed width of voice package details modal
 - Issue: [#8](https://github.com/SaekiRaku/vscode-rainbow-fart/issues/8)
 
 ## [1.1.0] - 2020-06-14

diff --git a/README.md b/README.md
@@ -8,32 +8,30 @@
   <br>
 </h1>
 
-## 概述
+Languages: [简体中文](./README.zh.md) | English
 
-这是一个在你编程时持续夸你写的牛逼的扩展，可以根据代码关键字播放贴近代码意义的真人语音。由于当前插件内的语音均为中文，因此不方便发布到 VSCode 商店，所以以 VISX 的形式发布。请直接 [查看文档并下载安装](https://saekiraku.github.io/vscode-rainbow-fart/)。
+## Summary
 
-## English Description
+**VSCode Rainbow Fart** is an extension that keeps giving you compliment while you are coding, it will checks the keywords of code to play suitable sounds.
 
-This is a VSCode extension that keeps giving you compliment while you are coding, for example when you type `function` it will play sound that says you wrote a such good function. However the sounds is recorded in Chinese, so it's may not suitable for you. But you can still modify the source code, like add English version compliment sound file.
+> Rainbow Fart is a literal translation word from Chinese, it's mean give somebody exaggerated compliment that even seems a little fake. It's not involved any connection to specific group or people.
 
-Rainbow Fart is a literal translation word from Chinese, it's mean give somebody exaggerated compliment that even seems a little fake. It's not involved any connection to specific group or people.
+## Document
 
-## Q&A
+For more information, please read the [document](https://saekiraku.github.io/vscode-rainbow-fart/
+).
 
-Q：安装扩展时 VSCode 提示不兼容。  
-A：请修改 `package.json` 中 `engines.vscode` 和 `devDependencies.@types/vscode` 字段为你当前的 VSCode 版本号（如下），然后在进入当前目录的终端运行 `npm i && npm run build`。 此时在工作区目录下将产生新编译的扩展，安装即可。详情请看：[Issue #1](https://github.com/SaekiRaku/vscode-rainbow-fart/issues/1)
+## Quick Start
 
-```json
-{
-  "engines": {
-      "vscode": "^[当前版本号]",
-  },
-  "devDependencies": {
-      "@types/vscode": "^[当前版本号]",
-  }
-}
-```
+1. Install extension from [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=saekiraku.rainbow-fart)
+2. Press `Ctrl + Shift + P`（MacOS `Command + Shift + P`）to bring up `Command Panel`.
+3. Type `> Enable Rainbow Fart` into `Command Panel`
+4. An notification should be poped up at the corner, click the `Open` on that notification.
+5. Click `Authorization` on the opend page.
+6. Enjoy coding! try to type `function` in your VSCode.
 
-## 许可
+## License
 
-基于 MIT 开源，包括所有设计资源及音频资源。此外，由于仓库中的音频资源大部分由真人录音，并且根据 MIT 被授权人义务。在此明确：尤其的对于仓库中多媒体资源，您有（单独）标明资源原作者、链接、许可的义务。
+Open source based on **MIT**, including all design resources and audio resources.
+
+In addition, since most of the audio resources are recorded by real people, and under the obligations of the MIT licensee. Here it is clarify: Especially for multimedia resources in the repo, you have the obligation to (separately) indicate the original author, link, and permission of the resource.
diff --git a/README.zh.md b/README.zh.md
@@ -0,0 +1,35 @@
+<h1 align="center">
+  <br>
+    <img src="https://github.com/SaekiRaku/vscode-rainbow-fart/blob/master/assets/logo.png?raw=true" alt="logo" width="100">
+  <br>
+  <br>
+  🌈 RAINBOW FART
+  <br>
+  <br>
+</h1>
+
+Languages: 简体中文 | [English](./README.md)
+
+## 概述
+
+**VSCode Rainbow Fart** 是一个在你编程时持续夸你写的牛逼的扩展，可以根据代码关键字播放贴近代码意义的真人语音。
+
+## 文档
+
+详细信息请访问 [文档](https://saekiraku.github.io/vscode-rainbow-fart/
+).
+
+## 快速上手
+
+> Rainbow Fart 插件现以发布到 VSCode 商店，安装过 VSIX 版本的用户请卸载之前的版本，从商店安装。
+
+1. 从 [VSCode 扩展商店](https://marketplace.visualstudio.com/items?itemName=saekiraku.rainbow-fart) 下载并安装。
+2. 在 VSCode 的菜单栏中找到 `查看 - 命令面板`，或使用快捷键 `Ctrl + Shift + P`（MacOS `Command + Shift + P`）呼出 `命令面板`。
+3. 在 `命令面板` 中输入 `> Enable Rainbow Fart` 并回车。
+4. 此时应该会弹出一个消息通知，点击通知上的 `Open` 按钮。
+5. 在打开的页面上点击 `授权`。
+6. 享受编程吧！请尝试在 VSCode 中输入 `function` 关键字。
+
+## License
+
+基于 MIT 开源，包括所有设计资源及音频资源。由于仓库中的音频资源大部分由真人录音，并且根据 MIT 被授权人义务。在此明确：尤其的对于仓库中多媒体资源，您有（单独）标明资源作者（[@JustKowalski](https://github.com/JustKowalski) 提供。）、链接、许可的义务。
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.1.1
+1.2.0
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,12 +1,43 @@
 # Change Log
-All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+All notable changes to the "vscode-rainbow-fart" extension will be documented in this file.
 
-<!--
-## [Unreleased]
--->
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-## [1.0.0] - 2020-06-14
+## [1.2.0] - 2020-06-20
 
-Initial Release
+### Added
+
+- Enable/Disable voice packages.
+- English document.
+
+### Fixed
+
+- Duplicated key in the voice package details modal.
+- Fixed width of voice package details modal
+- Issue: [#8](https://github.com/SaekiRaku/vscode-rainbow-fart/issues/8)
+
+## [1.1.0] - 2020-06-14
+
+### Added
+
+- Support import voice packages
+- New built-in voices for Chinese
+- I18N supports for English
+- Add document
+
+### Changed
+
+- New user interface
+
+## [1.0.2] - 2020-06-01
+
+- Lower the required version of VSCode.
+
+## [1.0.1] - 2020-05-30
+
+- UI Optimization
+
+## [1.0.0] - 2020-05-29
+
+- Initial release
diff --git a/docs/assets/ui-homepage.png b/docs/assets/ui-homepage.png
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -0,0 +1,65 @@
+# Summary
+
+**VSCode Rainbow Fart** is an extension that keeps giving you compliment while you are coding, it will checks the keywords of code to play suitable sounds.
+
+<Note label="Demo Video">
+
+<video src="/en/assets/demo-video-en.mp4" controls width="100%"></video>
+
+</Note>
+
+<Note label="Tips">
+
+If you have any suggestions or comments in use, please feedback to [GitHub Issues](https://github.com/saekiraku/vscode-rainbow-fart/issues).
+
+</Note>
+
+## Usage
+
+1. Install extension from [VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=saekiraku.rainbow-fart)
+2. Press `Ctrl + Shift + P`（MacOS `Command + Shift + P`）to bring up `Command Panel`.
+3. Type `> Enable Rainbow Fart` into `Command Panel`
+4. An notification should be poped up at the corner, click the `Open` on that notification.
+5. Click `Authorization` on the opend page.
+6. Enjoy coding! try to type `function` in your VSCode.
+
+## Voice Packages
+
+For now, it has 2 built-in voice package which are Chinese and English edition. In order to avoid the extension being too large, no plan to add more built-in voice. You can find and install voice package of other languages, gender or tone style, etc at [here](https://github.com/topics/rainbow-fart).
+
+The built-in voice package of English edition is created by Speech Synthesis. Because I don't have any friends that use English as mother language, if you are interested in this project, it would be nice to have contribute with your voice, no matter about gender, tone color, personality, language, contry etc.
+
+P.S. The voice of Chinese edition is recorded by real people if you have interests, [take a look](/zh/)
+
+<center>
+    <a href="https://github.com/topics/rainbow-fart" class="download" target="__blank">Get More Voice Packages</a>
+</center>
+
+<style>
+.download {
+    background: #009688;
+    text-align: center;
+    color: #FFF;
+    font-weight: bolder;
+    display: inline-block;
+    padding: 0px 32px;
+    margin: 16px 0px;
+    line-height: 48px;
+    border-radius: 48px;
+}
+.download:hover {
+    text-decoration: none !important;
+    opacity: 0.75;
+}
+</style>
+
+## Awesome Rainbow Fart
+
+### Other Client
+
+* [Emacs Rainbow Fart](https://github.com/stardiviner/emacs-rainbow-fart)
+* [IntelliJ Rainbow Fart](https://github.com/izhangzhihao/intellij-rainbow-fart)
+
+## License
+
+Open source based on MIT, including all design resources and audio resources. In addition, since most of the audio resources are recorded by real people, and under the obligations of the MIT licensee. Here it is clarify: Especially for multimedia resources in the repo, you have the obligation to (separately) indicate the original author, link, and permission of the resource.
diff --git a/docs/en/assets/demo-video-en.mp4 b/docs/en/assets/demo-video-en.mp4
diff --git a/docs/en/voice-packages.md b/docs/en/voice-packages.md
@@ -0,0 +1,3 @@
+# TODO
+
+Not translated, welcome to send PR.
diff --git a/docs/global.js b/docs/global.js
@@ -1,2 +1,2 @@
-window.VERSION = "1.1.0";
+window.VERSION = "1.2.0";
 window.URL_PREFIX = location.pathname === "/" ? "" : location.pathname;
diff --git a/docs/zh/README.md b/docs/zh/README.md
@@ -16,11 +16,25 @@
 
 ## 安装与使用
 
+> Rainbow Fart 插件现以发布到 VSCode 商店，安装过 VSIX 版本的用户请卸载之前的版本，从商店安装。
+
+1. 从 [VSCode 扩展商店](https://marketplace.visualstudio.com/items?itemName=saekiraku.rainbow-fart) 下载并安装。
+2. 在 VSCode 的菜单栏中找到 `查看 - 命令面板`，或使用快捷键 `Ctrl + Shift + P`（MacOS `Command + Shift + P`）呼出 `命令面板`。
+3. 在 `命令面板` 中输入 `> Enable Rainbow Fart` 并回车。
+4. 此时应该会弹出一个消息通知，点击通知上的 `Open` 按钮。
+5. 在打开的页面上点击 `授权`。
+6. 享受编程吧！请尝试在 VSCode 中输入 `function` 关键字。
+
+## 语音包
+
+目前，总共有 2 款内置语音包，分别为中文和英文。为了避免扩展体积过大，不再计划增加更多的内置语音包。你可以在 [这里](https://github.com/topics/rainbow-fart) 找到其他语种、性别、嗓音等等的语音包。
+
+内置的中文语音包由 [@JustKowalski](https://github.com/JustKowalski) 提供。
+
+P.S. 内置的英文语音由语音合成技术创建，因为我希望由以英语为母语的人来录制语音，而我身边暂时没有这样的朋友，所以暂时使用语音合成。
+
 <center>
-    <a :href="URL_PREFIX + '/releases/rainbow-fart-' + VERSION + '.vsix'" class="download">下载插件 Version {{VERSION}}</a>
-    <br>
-    <a href="https://github.com/saekiraku/vscode-rainbow-fart/releases">查看历史版本</a>
-    <!-- <a href="https://github.com/saekiraku/vscode-rainbow-fart/releases">查找更多语音包</a> -->
+    <a href="https://github.com/topics/rainbow-fart" class="download" target="__blank">Get More Voice Packages</a>
 </center>
 
 <style>
@@ -41,27 +55,12 @@
 }
 </style>
 
-1. 下载插件
-2. 在 VSCode 的菜单栏中找到 `查看 - 命令面板`，或使用快捷键 `Ctrl + Shift + P`（MacOS `Command + Shift + P`）
-3. 在 `命令面板` 中输入 `> Extensions: Install from VSIX` 并回车
-4. 在弹出的 `文件选择窗口` 中找到下载的插件并打开
-5. 安装完成，再次呼出 `命令面板` 输入 `> Enable Rainbow Fart` 并回车以启动插件
-6. 点击右下角弹出通知的 `Open` 按钮（或访问 [http://127.0.0.1:7777/](http://127.0.0.1:7777/)）
-7. 遵循打开的网页的说明使用本插件
-
-## 特性
-
-* 界面适配暗黑模式，让你深夜加班也能愉快地写代码。
-* I18N 支持：简体中文、English。
-* 支持导入自定义语音包
-
-### 内置语音包（中文）特性
+## 更多炫酷彩虹屁
 
-* 采用真人语音，共计 34 个音频文件。
-* 目前支持 JavaScript（ES6 ） 语言的常用关键字
-* 提供针对时间的语音：如提醒吃午饭、下班关怀等等
-* 提供针对产品经理的语音：如 `fuck`, `shit`
+* 其他客户端
+  * [Emacs Rainbow Fart](https://github.com/stardiviner/emacs-rainbow-fart)
+  * [IntelliJ Rainbow Fart](https://github.com/izhangzhihao/intellij-rainbow-fart)
 
 ## 开源协议
 
-基于 MIT 开源，包括所有设计资源及音频资源。此外，由于仓库中的音频资源大部分由真人录音，并且根据 MIT 被授权人义务。在此明确：尤其的对于仓库中多媒体资源，您有（单独）标明资源原作者、链接、许可的义务。
+基于 MIT 开源，包括所有设计资源及音频资源。由于仓库中的音频资源大部分由真人录音，并且根据 MIT 被授权人义务。在此明确：尤其的对于仓库中多媒体资源，您有（单独）标明资源作者（[@JustKowalski](https://github.com/JustKowalski) 提供。）、链接、许可的义务。
diff --git a/docs/assets/showoff-1.mp4 → docs/zh/assets/demo-video-zh.mp4 b/docs/assets/showoff-1.mp4 → docs/zh/assets/demo-video-zh.mp4
diff --git a/docs/assets/ui-settings.png → docs/zh/assets/ui-settings.png b/docs/assets/ui-settings.png → docs/zh/assets/ui-settings.png
diff --git a/docs/zh/voice-packages.md b/docs/zh/voice-packages.md
@@ -59,7 +59,7 @@
 
 语音包元信息文件还有很多其他字段，可以展示很多额外的信息（如下）。
 
-<ImageZoom :src="URL_PREFIX + '/assets/ui-settings.png'" :border="true" width="300"/>
+<ImageZoom src="/zh/assets/ui-settings.png" :border="true" width="300"/>
 
 <Note>以下字段均为可选字段</Note>
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,7 +4,7 @@
   "name": "rainbow-fart",
   "displayName": "🌈 Rainbow Fart",
   "description": "This extension will keep giving you compliment while you are coding.",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "engines": {
     "vscode": "^1.33.0"
   },
@@ -52,6 +52,7 @@
     "get-port": "^5.1.1",
     "glob": "^7.1.6",
     "jszip": "^3.4.0",
+    "lodash": "^4.17.15",
     "multer": "^1.4.2",
     "open": "^7.0.4",
     "vue-hot-reload-api": "^2.3.4",

diff --git a/playground.js b/playground.js
diff --git a/scripts/after-build.js b/scripts/after-build.js
@@ -2,8 +2,13 @@ import fs from "fs";
 import path from "path";
 import { sync as glob } from "glob";
 
-let files = glob("*.vsix", { cwd: path.resolve(__dirname, "../"), absolute: true });
-files.forEach((filepath) => {
-    let targetpath = path.resolve(__dirname, "../docs/releases", path.basename(filepath));
-    fs.renameSync(filepath, targetpath);
-})
+// let files = glob("*.vsix", { cwd: path.resolve(__dirname, "../"), absolute: true });
+// files.forEach((filepath) => {
+//     let targetpath = path.resolve(__dirname, "../docs/releases", path.basename(filepath));
+//     fs.renameSync(filepath, targetpath);
+// })
+
+fs.copyFileSync(
+    path.resolve(__dirname, "../CHANGELOG.md"),
+    path.resolve(__dirname, "../docs/CHANGELOG.md")
+)