pre-commit-config

Author: fengkx

.prettierrc

@@ -7,5 +7,4 @@
   "trailingComma": "none",
   "bracketSpacing": true,
   "arrowParens": "always",
-  "parser": "babylon"
 }

README.md

@@ -1,12 +1,15 @@
 # NodeRSSBot
+
 Another telegram RSSBot in Node.js
 
 A RSSBot in telegram similar to [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/). But this time in Node.js.
 
 # Support version
+
 RSS is parsered using [rss-parser](https://www.npmjs.com/package/rss-parser)
 
 # Usage
+
 The same as [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/)
 
 ```
@@ -19,75 +22,85 @@ The same as [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/)
 /viewall   - view all subscriptions and number of subscribers need to enable in settings
 ```
 
-You can add channel id to subscribe a feed for a channel in private chat after add the bot as administrator    
+You can add channel id to subscribe a feed for a channel in private chat after add the bot as administrator  
 for example `/sub <channel id > <feed url>` (channel id is startwith @)
-       
-You can send a opml file directly to import feed    
-viewall can only be uesed in private chat     
+
+You can send a opml file directly to import feed  
+viewall can only be uesed in private chat
 
 # Depolyment
+
 ## Docker
+
 ### Use autobuild docker image
+
 After install docker
+
 1. Run`docker pull fengkx/node_rssbot`
-1. Run `docker run --name rssbot -d -v <directory to store database file>:/app/data/ -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN>  fengkx/node_rssbot`
+1. Run `docker run --name rssbot -d -v <directory to store database file>:/app/data/ -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN> fengkx/node_rssbot`
 
-for exmaple `docker run --name rssbot -d -v /var/data:/app/data/ -e RSSBOT_TOKEN=123456:abcdef123456-U  fengkx/rssbot`
+for exmaple `docker run --name rssbot -d -v /var/data:/app/data/ -e RSSBOT_TOKEN=123456:abcdef123456-U fengkx/rssbot`
 
 ### Build docker locally
+
 1. Install Docker
 1. clone this repository `git clone https://github.com/fengkx/NodeRSSBot.git`
 1. Run `docker build .` then you will get a image id
-1. Run`docker run --name rssbot -d -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN>  <YOUR_IMAGE_ID>`
+1. Run`docker run --name rssbot -d -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN> <YOUR_IMAGE_ID>`
 
-for example `docker run --name rssbot -d -e RSSBOT_TOKEN=123456:abcdef123456-U  fd54321bff2`
+for example `docker run --name rssbot -d -e RSSBOT_TOKEN=123456:abcdef123456-U fd54321bff2`
 
 ## PM2
+
 1. Node.js and npm installed
 1. clone this repository `git clone https://github.com/fengkx/NodeRSSBot.git`
 1. Set the `RSSBOT_TOKEN` environment variable or set it in config/index.js
 1. Install dependencies run `npm i` in the root directory of the repository
 1. Run `pm2 start index.js`
 
 # Setting
-**All setting can be set by either environment variable or in `config/index.js`**
 
+**All setting can be set by either environment variable or in `config/index.js`**
 
-| setting            | env              | default/require  | description                              |
-| ------------------ | ---------------- | ---------------- | ---------------------------------------- |
-| token              | RSSBOT_TOKEN     | **require**      | [telegram bot token](https://core.telegram.org/bots#3-how-do-i-create-a-bot) |
-| db_path            | RSSBOT_DB_PATH   | data/database.db | path to store database file              |
-| lang               | RSSBOT_LANG      | zh-cn            | language                                 |
-| item_num           | RSSBOT_ITEM_NUM  | 10               | send the laset number of item            |
-| fetch_gap          | RSSBOT_FETCH_GAP | 5m               | fetch gap                                |
-| notify_error_count | NOTIFY_ERR_COUNT | 5                | error count  when it will notfiy         |
-| view_all           | RSSBOT_VIEW_ALL  | false            | enable or not                            |
-| UA                 | RSSBOT_UA        | 'Mozilla/5.0  NodeRSSBot(https://github.com/fengkx/NodeRSSBot)' | user-agent of requrest|
+| setting            | env              | default/require                                                | description                                                                  |
+| ------------------ | ---------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| token              | RSSBOT_TOKEN     | **require**                                                    | [telegram bot token](https://core.telegram.org/bots#3-how-do-i-create-a-bot) |
+| db_path            | RSSBOT_DB_PATH   | data/database.db                                               | path to store database file                                                  |
+| lang               | RSSBOT_LANG      | zh-cn                                                          | language                                                                     |
+| item_num           | RSSBOT_ITEM_NUM  | 10                                                             | send the laset number of item                                                |
+| fetch_gap          | RSSBOT_FETCH_GAP | 5m                                                             | fetch gap                                                                    |
+| notify_error_count | NOTIFY_ERR_COUNT | 5                                                              | error count when it will notfiy                                              |
+| view_all           | RSSBOT_VIEW_ALL  | false                                                          | enable or not                                                                |
+| UA                 | RSSBOT_UA        | 'Mozilla/5.0 NodeRSSBot(https://github.com/fengkx/NodeRSSBot)' | user-agent of requrest                                                       |
 
-language can be setting in `zh-cn` or `en`     
+language can be setting in `zh-cn` or `en`
 
 fetch_gap can be setting in how many minutes or hours。m for minute， h for hour
-      
+
 for example 5m means every 5 minutes， 1h means every 1 hour
 
 # i18n
 
 translate the file in `i18n` in the another yaml and make a pull request (๑•̀ㅂ•́)و✧
 
----------------
+---
+
 # 中文文档
 
 # NodeRSSBot
+
 又是一个 telegram RSS Bot 不过这次用的是 Node.js
 
-模仿[https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/) 做的一个RSSBot，用[telegraf](https://www.npmjs.com/package/telegraf)    
-首先感谢 iovxw 的 RSSBot 一直用的很好       
-做这个东西只是为了，配置起来更方便一些不用安装Rust的工具链和编译
+模仿[https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/) 做的一个 RSSBot，用[telegraf](https://www.npmjs.com/package/telegraf)  
+首先感谢 iovxw 的 RSSBot 一直用的很好  
+做这个东西只是为了，配置起来更方便一些不用安装 Rust 的工具链和编译
 
 # 支持的版本
+
 RSS 解析用的是 [rss-parser](https://www.npmjs.com/package/rss-parser)，它支持的就支持
 
 # Usage
+
 基本与 [https://github.com/iovxw/rssbot/](https://github.com/iovxw/rssbot/)一致
 
 ```
@@ -99,30 +112,34 @@ RSS 解析用的是 [rss-parser](https://www.npmjs.com/package/rss-parser)，它
 /export    - 导出订阅到opml文件
 /viewall   - 查看所有订阅和订阅人数 需要在设置中打开
 ```
+
 把 bot 设为频道管理员并正确配置权限后，可通过私聊在`/sub`后加上频道 id 来在频道中订阅 feed
 例如 `/sub <频道 id > <feed url>` (频道 id 是@打头的)
 
-直接发送opml文件，可以导入RSS源              
+直接发送 opml 文件，可以导入 RSS 源  
 viewall 只能在私聊中使用
 
-
 # 部署
+
 ## Docker
 
 ### 使用自动构建的 docker image
+
 安装好了 docker 之后
+
 1. 运行`docker pull fengkx/node_rssbot`
-1. 运行 `docker run --name rssbot -d -v <directory to store database file>:/app/data/ -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN>  fengkx/node_rssbot`
+1. 运行 `docker run --name rssbot -d -v <directory to store database file>:/app/data/ -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN> fengkx/node_rssbot`
 
-例如 `docker run --name rssbot -d -v /var/data:/app/data/ -e RSSBOT_TOKEN=123456:abcdef123456-U  fengkx/rssbot`
+例如 `docker run --name rssbot -d -v /var/data:/app/data/ -e RSSBOT_TOKEN=123456:abcdef123456-U fengkx/rssbot`
 
 ### 本地构建
+
 1. 安装 Docker
 1. 克隆仓库 `git clone https://github.com/fengkx/NodeRSSBot.git`
 1. 构建 docker image `docker build .` then you will get a image id
-1. 运行 `docker run --name rssbot -d -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN>  <YOUR_IMAGE_ID>`
+1. 运行 `docker run --name rssbot -d -e RSSBOT_TOKEN=<YOUR_TGBOT_TOKEN> <YOUR_IMAGE_ID>`
 
-例如 `docker run --name rssbot -d -e RSSBOT_TOKEN=123456:abcdef123456-U  fd54321bff2`
+例如 `docker run --name rssbot -d -e RSSBOT_TOKEN=123456:abcdef123456-U fd54321bff2`
 
 ## PM2
 
@@ -133,29 +150,31 @@ viewall 只能在私聊中使用
 1. 推荐用 `pm2` 守护进程 `pm2 start index.js` 如果没有安装`pm2` 就先安装 `npm i -g pm2`
 
 # TODO
-- [x] export 命令
-- 代理 
-- unit test
+
+-   [x] export 命令
+-   代理
+-   unit test
 
 # 配置项
-**所有配置项都可以用环境变量或者直接在 `config/index.js`中修改**
 
+**所有配置项都可以用环境变量或者直接在 `config/index.js`中修改**
 
-| 设置项                | 环境变量             | 默认/必填            | 描述                                       |
-| ------------------ | ---------------- | ---------------- | ---------------------------------------- |
-| token              | RSSBOT_TOKEN     | **require**      | [telegram bot token](https://core.telegram.org/bots#3-how-do-i-create-a-bot) |
-| db_path            | RSSBOT_DB_PATH   | data/database.db | 数据库文件路径                                  |
-| lang               | RSSBOT_LANG      | zh-cn            | 语言                                       |
-| item_num           | RSSBOT_ITEM_NUM  | 10               | 发送最新几条信息                                 |
-| fetch_gap          | RSSBOT_FETCH_GAP | 5m               | 抓取间隔                                     |
-| notify_error_count | NOTIFY_ERR_COUNT | 5                | 发出通知的错误次数                                |
-| view_all           | RSSBOT_VIEW_ALL  | false            | 是否开启                                     |
-| UA                 | RSSBOT_UA        | 'Mozilla/5.0  NodeRSSBot(https://github.com/fengkx/NodeRSSBot)' | 请求的 user-agent |
+| 设置项             | 环境变量         | 默认/必填                                                      | 描述                                                                         |
+| ------------------ | ---------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| token              | RSSBOT_TOKEN     | **require**                                                    | [telegram bot token](https://core.telegram.org/bots#3-how-do-i-create-a-bot) |
+| db_path            | RSSBOT_DB_PATH   | data/database.db                                               | 数据库文件路径                                                               |
+| lang               | RSSBOT_LANG      | zh-cn                                                          | 语言                                                                         |
+| item_num           | RSSBOT_ITEM_NUM  | 10                                                             | 发送最新几条信息                                                             |
+| fetch_gap          | RSSBOT_FETCH_GAP | 5m                                                             | 抓取间隔                                                                     |
+| notify_error_count | NOTIFY_ERR_COUNT | 5                                                              | 发出通知的错误次数                                                           |
+| view_all           | RSSBOT_VIEW_ALL  | false                                                          | 是否开启                                                                     |
+| UA                 | RSSBOT_UA        | 'Mozilla/5.0 NodeRSSBot(https://github.com/fengkx/NodeRSSBot)' | 请求的 user-agent                                                            |
 
 语言可以设置为 `zh-cn` or `en`
-时间间隔可设置为每多少分钟或多少小时。m 表示分钟， h表示小时
+时间间隔可设置为每多少分钟或多少小时。m 表示分钟， h 表示小时
 
-例如 5m 表示每5分钟， 1h 表示每1小时
+例如 5m 表示每 5 分钟， 1h 表示每 1 小时
 
 # i18n
-在 `i18n`目录翻译yaml文件然后来个 ·pr· (๑•̀ㅂ•́)و✧
+
+在 `i18n`目录翻译 yaml 文件然后来个 ·pr· (๑•̀ㅂ•́)و✧

package-lock.json

@@ -7,19 +7,12 @@
     "start": "node index",
     "dev": "proxychains -q node $NODE_DEBUG_OPTION  index",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "format": "prettier \"**/*.js\" --write",
-    "pre-commit": "lint-staged"
+    "format": "eslint \"**/*.js\" --fix && prettier \"**/*.{js,json,md}\" --write",
+    "lint": "eslint \"**/*.js\" && prettier-check \"**/*.{js,json,md}\""
   },
   "pre-commit": [
-    "pre-commit"
+    "lint"
   ],
-  "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "prettier --write",
-      "git add"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/fengkx/NodeRSSBot.git"
@@ -49,6 +42,7 @@
   "devDependencies": {
     "lint-staged": "^8.1.0",
     "pre-commit": "^1.2.2",
-    "prettier": "^1.15.3"
+    "prettier": "^1.15.3",
+    "prettier-check": "^2.0.0"
   }
 }