first

.dockerignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
+
+.git*
+Dockerfile
+.dockerignore

.eslintignore

+webpack.config.js
+dist/*
+build/*
\ No newline at end of file

.eslintrc.js

+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir : __dirname, 
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

.gitignore

+# compiled output
+/dist
+/node_modules
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# OS
+.DS_Store
+
+# Tests
+/coverage
+/.nyc_output
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+/data
+/output
+/config.yaml
\ No newline at end of file

.gitlab-ci.yml

+stages:
+  - install
+  - build
+  - deploy
+
+variables:
+  GIT_DEPTH: "1"
+
+npm_ci:
+  stage: install
+  tags:
+    - linux
+  script:
+    - npm ci
+  artifacts:
+    paths:
+      - node_modules
+
+.build_base:
+  stage: build
+  tags:
+    - linux
+  dependencies:
+    - npm_ci
+
+build:
+  extends: .build_base
+  script: npm run build
+  artifacts:
+    paths:
+      - dist/
+
+test:
+  extends: .build_base
+  script: npm run test
+
+upload_to_minio:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - aws s3 --endpoint=https://minio.mycard.moe:9000 sync --delete dist/full/ s3://nanahira/koishi-plugin/msgdb
+  only:
+    - master
+
+deploy_npm:
+  stage: deploy
+  dependencies:
+    - build
+  tags:
+    - linux
+  script:
+    - apt update;apt -y install coreutils
+    - echo $NPMRC | base64 --decode > ~/.npmrc
+    - npm publish . --access public && curl -X PUT "https://registry-direct.npmmirror.com/$(cat package.json | jq '.name' | sed 's/\"//g')/sync?sync_upstream=true" || true
+  only:
+    - master

.npmignore

+/install-npm.sh
+.git*
+/data
+/output
+/config.yaml
+.idea
+.dockerignore
+Dockerfile
+/src
+/dist/full
+/coverage
+/tests
+/dist/tests
+/dev
+/dist/dev
+/webpack.config.js
+/.eslint*
+.*ignore
+.prettierrc*

.prettierrc

+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}
\ No newline at end of file

LICENSE

+The MIT License (MIT)
+
+Copyright (c) 2021 Nanahira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

-# Koishi Plugin Msgdb
+# koishi-plugin-msgdb
 
-保存消息到数据库。
\ No newline at end of file
+保存消息到数据库。
+
+## 安装
+
+### npm
+
+```bash
+npm install koishi-plugin-msgdb
+```
+
+### 直接安装
+
+在 https://cdn02.moecube.com:444/nanahira/koishi-plugin/msgdb/index.js 下载即可。
+
+## 配置
+
+无。

dev/extras.tsx

+import { Context } from 'koishi';
+
+export default class ExtrasInDev {
+  constructor(ctx: Context) {}
+}

dev/index.tsx

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+import ConsolePlugin from '@koishijs/plugin-console';
+import * as SandboxPlugin from '@koishijs/plugin-sandbox';
+import DatabasePlugin from '@koishijs/plugin-database-mysql';
+import * as Help from '@koishijs/plugin-help';
+import ExtrasInDev from './extras';
+import DataviewPlugin from '@koishijs/plugin-dataview';
+
+const app = new App({
+  port: 14514,
+  host: 'localhost',
+  prefix: '.',
+});
+
+app.plugin(Help);
+
+// Console and sandbox
+app.plugin(SandboxPlugin);
+app.plugin(ConsolePlugin, {
+  open: false,
+});
+
+// Some services
+app.plugin(DatabasePlugin, {
+  host: '127.0.0.1',
+  user: 'root',
+  password: 'koishi',
+  database: 'koishi',
+});
+app.plugin(DataviewPlugin);
+
+// Some extras
+app.plugin(ExtrasInDev);
+
+// Target plugin
+app.plugin(TargetPlugin, {});
+
+app.start();

install-npm.sh

+#!/bin/bash
+npm install --save \
+	koishi-thirdeye
+
+npm install --save-peer \
+	koishi
+
+	npm i --save-exact --save-dev eslint@8.22.0
+
+npm install --save-dev \
+	@types/node \
+	typescript \
+	'@typescript-eslint/eslint-plugin@^5.0.0' \
+	'@typescript-eslint/parser@^5.0.0 '\
+	'eslint-config-prettier@^8.3.0' \
+	'eslint-plugin-prettier@^4.0.0' \
+	prettier \
+	raw-loader \
+	ts-loader \
+	webpack \
+	webpack-cli \
+	ws \
+	ts-node \
+	@koishijs/plugin-help \
+	@koishijs/plugin-console \
+	@koishijs/plugin-sandbox \
+	@koishijs/plugin-database-memory \
+	jest \
+	ts-jest \
+	@types/jest

package.json

+{
+  "name": "koishi-plugin-msgdb",
+  "description": "保存消息到数据库。",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/src/index.d.ts",
+  "scripts": {
+    "lint": "eslint --fix .",
+    "build": "webpack && env PACK_ALL=1 webpack",
+    "start": "ts-node ./dev",
+    "test": "jest --passWithNoTests"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://code.mycard.moe/3rdeye/koishi-plugin-msgdb.git"
+  },
+  "author": "Nanahira <nanahira@momobako.com>",
+  "license": "MIT",
+  "keywords": [
+    "Koishi.js",
+    "qqbot",
+    "cqhttp",
+    "onebot"
+  ],
+  "bugs": {
+    "url": "https://code.mycard.moe/3rdeye/koishi-plugin-msgdb/issues"
+  },
+  "homepage": "https://code.mycard.moe/3rdeye/koishi-plugin-msgdb",
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "tests",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "dependencies": {
+    "koishi-thirdeye": "^11.1.27"
+  },
+  "peerDependencies": {
+    "koishi": "^4.12.1"
+  },
+  "devDependencies": {
+    "@koishijs/assets": "^1.0.2",
+    "@koishijs/plugin-console": "^5.5.5",
+    "@koishijs/plugin-database-memory": "^2.3.4",
+    "@koishijs/plugin-database-mysql": "^5.4.2",
+    "@koishijs/plugin-dataview": "^2.2.6",
+    "@koishijs/plugin-help": "^2.2.1",
+    "@koishijs/plugin-sandbox": "^2.7.1",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.3",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.5",
+    "raw-loader": "^4.0.2",
+    "ts-jest": "^29.0.5",
+    "ts-loader": "^9.4.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.0.2",
+    "webpack": "^5.76.2",
+    "webpack-cli": "^5.0.1",
+    "ws": "^8.13.0"
+  },
+  "koishi": {
+    "service": {
+      "required": [
+        "database"
+      ],
+      "optional": [
+        "assets"
+      ]
+    }
+  }
+}

src/index.tsx

+import {
+  DefineModel,
+  DefinePlugin,
+  Inject,
+  ModelField,
+  PrimaryGenerated,
+  Provide,
+  StarterPlugin,
+  UseEvent,
+  UseModel,
+} from 'koishi-thirdeye';
+import { Context, Session } from 'koishi';
+import {} from '@koishijs/assets';
+
+declare module 'koishi' {
+  interface Tables {
+    messageRecord: MessageRecord;
+  }
+
+  interface Context {
+    msgdb: MessageDatabasePlugin;
+  }
+}
+
+@DefineModel('messageRecord')
+class MessageRecord implements Partial<Omit<Session, 'id'>> {
+  @PrimaryGenerated()
+  @ModelField('integer(11)')
+  id: number;
+
+  @ModelField('string')
+  platform: string;
+
+  @ModelField('string')
+  selfId: string;
+
+  @ModelField('string')
+  userId: string;
+
+  @ModelField('string')
+  channelId: string;
+
+  @ModelField('string')
+  username: string;
+
+  @ModelField('string')
+  channelName: string;
+
+  @ModelField('boolean')
+  isPrivate: boolean;
+
+  @ModelField('string(10000)')
+  content: string;
+
+  @ModelField('string')
+  messageId: string;
+
+  @ModelField('timestamp')
+  date: Date;
+
+  fromSession(session: Session) {
+    this.platform = session.platform;
+    this.selfId = session.selfId;
+    this.userId = session.userId;
+    this.channelId = session.channelId;
+    this.username = session.username;
+    this.channelName = session.channelName;
+    this.isPrivate = session.subtype === 'private';
+    this.messageId = session.messageId;
+    this.content = session.content;
+    this.date = new Date();
+  }
+}
+
+@Provide('msgdb')
+@UseModel(MessageRecord)
+@DefinePlugin({ name: 'msgdb' })
+export default class MessageDatabasePlugin extends StarterPlugin() {
+  @Inject(true)
+  private database: Context['database'];
+
+  @Inject()
+  private assets: Context['assets'];
+
+  @UseEvent('message')
+  private async onMessage(session: Session) {
+    const record = new MessageRecord();
+    record.fromSession(session);
+    if (this.assets) {
+      record.content = await this.assets.transform(record.content);
+    }
+    await this.database.create('messageRecord', record);
+  }
+}

tests/sample.spec.ts

+import { App } from 'koishi';
+import TargetPlugin from '../src';
+
+describe('Test of plugin.', () => {
+  let app: App;
+
+  beforeEach(async () => {
+    app = new App();
+    // app.plugin(TargetPlugin);
+    await app.start();
+  });
+
+  it('should pass', () => {
+    expect(true).toBe(true);
+  });
+});

tsconfig.json

+{
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "commonjs",
+		"target": "es2021",
+		"esModuleInterop": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"declaration": true,
+		"sourceMap": true,
+		"skipLibCheck": true,
+		"jsx": "react-jsx",
+		"jsxImportSource": "@satorijs/element"
+	},
+	"compileOnSave": true,
+	"allowJs": true,
+	"include": [
+		"*.ts",
+		"src/**/*.ts",
+		"tests/**/*.ts",
+		"dev/**/*.ts",
+		"*.tsx",
+		"src/**/*.tsx",
+		"tests/**/*.tsx",
+		"dev/**/*.tsx"
+	]
+}

webpack.config.js

+const path = require('path');
+const packgeInfo = require('./package.json');
+
+function externalsFromDep() {
+  return Object.fromEntries(
+    [
+      ...Object.keys(packgeInfo.dependencies || {}),
+      ...Object.keys(packgeInfo.peerDependencies || {}),
+    ]
+      .filter((dep) => dep !== 'source-map-support')
+      .map((dep) => [dep, dep]),
+  );
+}
+
+const packAll = !!process.env.PACK_ALL;
+
+module.exports = {
+  entry: './src/index.tsx',
+  mode: 'production',
+  target: 'node',
+  devtool: 'source-map',
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+      { test: /\.mustache$/, use: 'raw-loader' },
+    ],
+  },
+  resolve: {
+    extensions: ['.tsx', '.ts', '.js'],
+  },
+  output: {
+    filename: 'index.js',
+    library: {
+      type: 'commonjs',
+    },
+    path: path.resolve(__dirname, packAll ? 'dist/full' : 'dist'),
+  },
+  externals: {
+    koishi: 'koishi',
+    '@satorijs/element': '@satorijs/element',
+    '@satorijs/element/jsx-runtime': '@satorijs/element',
+    ...(packAll ? {} : externalsFromDep()),
+  },
+};