merge to dev, use mustache as template engine (#9)

* add mustache * use template for push * remove lock file from ignore * update samples and apply templates * npm use --omit=dev * use package-lock.json for npm i * copy package.json * fix push op string missing issue * finish pipeline template and optimize push * add file change from commits * optimize push and pipeline * finish mr * finish tag_push * finish wiki * remove dept from lodash and string * v2.0.0, update readme --------- Co-authored-by: JerryZ <jerry@ezpro.com>

Author: goodideal

.eslintrc

@@ -1,3 +1,9 @@
 {
- "extends": "eslint-config-egg"
+ "plugins": ["prettier"],
+ "rules": {
+ "prettier/prettier": [
+ "error"
+ ]
+ },
+ "extends": ["plugin:prettier/recommended", "eslint-config-egg"]
 }

.github/workflows/nodejs.yml

@@ -0,0 +1,46 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+ push:
+ branches:
+ - main
+ - master
+ pull_request:
+ branches:
+ - main
+ - master
+ schedule:
+ - cron: '0 2 * * *'
+
+jobs:
+ build:
+ runs-on: ${{ matrix.os }}
+
+ strategy:
+ fail-fast: false
+ matrix:
+ node-version: [10]
+ os: [ubuntu-latest, windows-latest, macos-latest]
+
+ steps:
+ - name: Checkout Git Source
+ uses: actions/checkout@v2
+
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v3
+ with:
+ node-version: ${{ matrix.node-version }}
+
+ - name: Install Dependencies
+ run: npm i
+
+ - name: Continuous Integration
+ run: npm run ci
+
+ - name: Code Coverage
+ uses: codecov/codecov-action@v3
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -2,8 +2,6 @@ logs/
 npm-debug.log
 yarn-error.log
 node_modules/
-package-lock.json
-yarn.lock
 coverage/
 .idea/
 run/

.prettierrc

@@ -3,5 +3,6 @@
  "tabWidth": 2,
  "semi": true,
  "singleQuote": true,
- "arrowParens": "avoid"
+ "arrowParens": "avoid",
+ "bracketSpacing": true
 }

Dockerfile

@@ -1,6 +1,6 @@
 FROM library/node:lts-alpine
 
-# 设置时区
+# set timezone
 ENV TIME_ZONE=Asia/Shanghai
 
 RUN \
@@ -9,11 +9,10 @@ RUN \
 
 WORKDIR /app
 
-COPY package.json package-lock.json
+COPY package.json package.json
+COPY package-lock.json package-lock.json
 
-RUN \
- npm config set registry https://registry.npmmirror.com/ \
- && npm i --no-audit --no-fund --production
+RUN npm i --no-audit --no-fund --omit=dev
 
 EXPOSE 7001
 

README.md

@@ -1,6 +1,23 @@
 # Gitlab通知机器人
 
-将`Gitlab`的`push`、`tag push`、`merge request`和`pipeline`推送到企业微信的机器人。
+将`Gitlab`的`push`、`tag push`、`merge request`和`pipeline`推送到第三方IM平台的机器人，如企业微信、飞书等；
+
+`1.0.0`: 采用内置代码，且仅支持企业微信；
+
+`2.0.0`: 通过消息模板，可自行配置通知消息格式和字段，具体配置方式，参见[mustache官方文档](https://github.com/janl/mustache.js)
+
+todo:
+
+- [X] 使用mustache模板
+- [X] 增加note通知
+- [ ] 增加消息模板配置文件
+- [ ] 支持飞书机器人
+- [ ] 支持按天统计数据
+
+
+---
+
+### 功能展示
 
 具体见下图：
 
@@ -45,7 +62,7 @@ Gitlab pipeline 流水线
 
 则环境变量设为：
 ```
-WEBHOOK_URL_QYWX=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ABCDEFG
+WEBHOOK_URL_PROJ=https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=ABCDEFG
 ```
 
 一个应用可以添加多个推送组。

app/controller/home.js

@@ -1,16 +1,15 @@
 'use strict';
 
 const Controller = require('egg').Controller;
-const S = require('string');
-
 class HomeController extends Controller {
  async index() {
  const { ctx } = this;
  const { path = '' } = ctx.params;
-
  const webhookUrl =
  process.env['WEBHOOK_URL' + (path ? '_' + path.toUpperCase() : '')];
 
+ this.logger.debug('webhookUrl', webhookUrl);
+
  this.logger.info('request body: ', ctx.request.body);
  const message = await ctx.service.webhook.translateMsg(ctx.request.body);
 

app/router.js

@@ -1,8 +1,7 @@
 'use strict';
 
-const S = require('string');
 const contextPath = process.env.CONTEXT_PATH || '/';
-const contextPathEndWithSlash = S(contextPath).endsWith('/')
+const contextPathEndWithSlash = contextPath.endsWith('/')
  ? contextPath
  : contextPath + '/';