Merge pull request #4 from simple-robot/dev

Release v0.0.2

.changelog/v0.0.2.md

@@ -0,0 +1,8 @@
+> 对应核心版本: [**v3.3.0**](https://github.com/simple-robot/simpler-robot/releases/tag/v3.3.0)
+    
+> [!warning]
+> 目前版本尚处于 **早期** 阶段，代表仍然可能存在大量已知问题或未知问题，
+以及未完善的内容和落后于官方更新的内容。**
+
+我们欢迎并期望着您的的[反馈](https://github.com/simple-robot/simbot-component-miyoushe/issues)或[协助](https://github.com/simple-robot/simbot-component-miyoushe/pulls)，
+感谢您的贡献与支持！

.github/workflows/deploy-dev-documentation.yml

@@ -0,0 +1,107 @@
+name: Deploy documentation
+
+on:
+  # If specified, the workflow will be triggered automatically once you push to the `main` branch.
+  # Replace `main` with your branch’s name
+  push:
+    branches:
+      - dev
+    paths:
+      - 'Writerside/**'
+  # Specify to run a workflow manually from the Actions tab on GitHub
+  workflow_dispatch:
+
+# Gives the workflow permissions to clone the repo and create a page deployment
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  # Name of module and id separated by a slash
+  INSTANCE: Writerside/villa
+  # Replace HI with the ID of the instance in capital letters
+  ARTIFACT: webHelpVILLA2-all.zip
+  # Writerside docker image version
+  DOCKER_VERSION: 232.10275
+  # Add the variable below to upload Algolia indexes
+  # Replace HI with the ID of the instance in capital letters
+#  ALGOLIA_ARTIFACT: algolia-indexes-HI.zip
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+      # Add the step below to upload Algolia indexes
+#      - name: Upload algolia-indexes
+#        uses: actions/upload-artifact@v3
+#        with:
+#          name: algolia-indexes
+#          path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+#          retention-days: 7
+
+  # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
+  test:
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v1
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Requires the build job results
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+        with:
+          name: documentation-dev

CHANGELOG.md

@@ -0,0 +1,10 @@
+# v0.0.2
+
+> Release & Pull Notes: [v0.0.2](https://github.com/simple-robot/simpler-robot/releases/tag/v0.0.2) 
+
+
+
+> Release & Pull Notes: [v0.0.1](https://github.com/simple-robot/simpler-robot/releases/tag/v0.0.1) 
+
+- api: 部分API实现与部分测试 ([`fbcc331`](https://github.com/simple-robot/simpler-robot/commit/fbcc331))
+

Writerside/v.list

@@ -2,7 +2,7 @@
 <!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
 <vars>
     <var name="product" value="Writerside"/>
-    <var instance="villa" name="version" value="0.0.1"/>
+    <var instance="villa" name="version" value="0.0.2"/>
     <var instance="villa" name="kt-version" value="1.9.21"/>
     <var name="copyright-year" value="2023-2024"/>
 </vars>

Writerside/writerside.cfg

@@ -5,4 +5,5 @@
     <topics dir="topics" web-path="topics"/>
     <images dir="images" web-path="simbot-component-miyoushe-villa"/>
     <instance src="villa.tree" version="v%version%" web-path="/villa/" />
+
 </ihp>

buildSrc/src/main/kotlin/P.kt

@@ -46,7 +46,7 @@ object P : ProjectDetail() {
     override val homepage: String
         get() = HOMEPAGE
 
-    private val baseVersion = v(0, 0, 1)
+    private val baseVersion = v(0, 0, 2)
 
 //    private val alphaSuffix = v("alpha", 1)
     // baseVersion - alphaSuffix

buildSrc/src/main/kotlin/changelog/GenerateChangelog.kt

@@ -46,7 +46,7 @@ fun Project.generateChangelog(tag: String) {
             > 对应核心版本: [**v$coreVersion**](https://github.com/simple-robot/simpler-robot/releases/tag/v$coreVersion)
                 
             > [!warning]
-            > 目前版本尚处于 **早期** 阶段，代表仍然可能存在大量[已知问题](https://github.com/simple-robot/simbot-component-miyoushe/issues)或未知问题，
+            > 目前版本尚处于 **早期** 阶段，代表仍然可能存在大量已知问题或未知问题，
             以及未完善的内容和落后于官方更新的内容。**
             
             我们欢迎并期望着您的的[反馈](https://github.com/simple-robot/simbot-component-miyoushe/issues)或[协助](https://github.com/simple-robot/simbot-component-miyoushe/pulls)，

buildSrc/src/main/kotlin/simbot-miyoushe-changelog-generator.gradle.kts

@@ -25,27 +25,27 @@ tasks.create("createChangelog") {
     }
 }
 
-tasks.create("updateWebsiteVersionJson") {
-    group = "documentation"
-    doFirst {
-        val version = P.version.toString()
-
-        val websiteVersionJsonDir = rootProject.file("website/static")
-        if (!websiteVersionJsonDir.exists()) {
-            websiteVersionJsonDir.mkdirs()
-        }
-        val websiteVersionJsonFile = File(websiteVersionJsonDir, "version.json")
-        if (!websiteVersionJsonFile.exists()) {
-            websiteVersionJsonFile.createNewFile()
-        }
-
-        websiteVersionJsonFile.writeText(
-            """
-            {"version": "$version"}
-        """.trimIndent()
-        )
-    }
-}
+//tasks.create("updateWebsiteVersionJson") {
+//    group = "documentation"
+//    doFirst {
+//        val version = P.version.toString()
+//
+//        val websiteVersionJsonDir = rootProject.file("website/static")
+//        if (!websiteVersionJsonDir.exists()) {
+//            websiteVersionJsonDir.mkdirs()
+//        }
+//        val websiteVersionJsonFile = File(websiteVersionJsonDir, "version.json")
+//        if (!websiteVersionJsonFile.exists()) {
+//            websiteVersionJsonFile.createNewFile()
+//        }
+//
+//        websiteVersionJsonFile.writeText(
+//            """
+//            {"version": "$version"}
+//        """.trimIndent()
+//        )
+//    }
+//}
 
 //fun repoRow(moduleName: String, group: String, id: String, version: String): String {
 //    return "| $moduleName | [$moduleName: v$version](https://repo1.maven.org/maven2/${group.replace(".", "/")}/${id.replace(".", "/")}/$version) | [$moduleName: v$version](https://search.maven.org/artifact/$group/$id/$version/jar)  |"

simbot-component-miyoushe-villa-core/src/main/kotlin/love/forte/simbot/component/miyoushe/VillaComponent.kt

@@ -42,6 +42,8 @@ public class VillaComponent : Component {
     override val id: String
         get() = ID_VALUE
 
+    override fun toString(): String = "VillaComponent(id=$ID_VALUE)"
+
     public companion object Factory : ComponentFactory<VillaComponent, MiyousheVillaComponentConfiguration> {
         /**
          * 组件的ID标识常量。

simbot-component-miyoushe-villa-core/src/main/kotlin/love/forte/simbot/component/miyoushe/event/VillaAddQuickEmoticonEvent.kt

@@ -118,6 +118,8 @@ public abstract class VillaAddQuickEmoticonEvent : VillaEvent<AddQuickEmoticon>(
     override val key: Event.Key<VillaAddQuickEmoticonEvent>
         get() = Key
 
+    override fun toString(): String = "VillaAddQuickEmoticonEvent(sourceEvent=$sourceEvent)"
+
     public companion object Key : BaseEventKey<VillaAddQuickEmoticonEvent>(
         "villa.add_quick_emoticon", VillaEvent, ChannelEvent
     ) {

simbot-component-miyoushe-villa-core/src/main/kotlin/love/forte/simbot/component/miyoushe/event/VillaAuditCallbackEvent.kt

@@ -119,6 +119,8 @@ public abstract class VillaAuditCallbackEvent : VillaEvent<AuditCallback>(), Gui
     override val key: Event.Key<VillaAuditCallbackEvent>
         get() = Key
 
+    override fun toString(): String = "VillaAuditCallbackEvent(sourceEvent=$sourceEvent)"
+
     public companion object Key : BaseEventKey<VillaAuditCallbackEvent>(
         "villa.audit.callback", VillaEvent, GuildEvent
     ) {

simbot-component-miyoushe-villa-core/src/main/kotlin/love/forte/simbot/component/miyoushe/event/VillaBotEvent.kt

@@ -81,6 +81,8 @@ public abstract class VillaCreateRobotEvent : VillaBotEvent<CreateRobot>() {
     override val key: Event.Key<out VillaCreateRobotEvent>
         get() = Key
 
+    override fun toString(): String = "VillaCreateRobotEvent(sourceEvent=$sourceEvent)"
+
     public companion object Key : BaseEventKey<VillaCreateRobotEvent>(
         "villa.bot.create", VillaBotEvent
     ) {
@@ -101,6 +103,8 @@ public abstract class VillaDeleteRobotEvent : VillaBotEvent<DeleteRobot>() {
     override val key: Event.Key<out VillaDeleteRobotEvent>
         get() = Key
 
+    override fun toString(): String = "VillaDeleteRobotEvent(sourceEvent=$sourceEvent)"
+
     public companion object Key : BaseEventKey<VillaDeleteRobotEvent>(
         "villa.bot.delete", VillaBotEvent
     ) {

simbot-component-miyoushe-villa-core/src/main/kotlin/love/forte/simbot/component/miyoushe/event/VillaClickMsgComponentEvent.kt

@@ -77,6 +77,8 @@ public abstract class VillaClickMsgComponentEvent : VillaEvent<ClickMsgComponent
     override val key: Event.Key<VillaClickMsgComponentEvent>
         get() = Key
 
+    override fun toString(): String = "VillaClickMsgComponentEvent(sourceEvent=$sourceEvent)"
+
     public companion object Key : BaseEventKey<VillaClickMsgComponentEvent>(
         "villa.click_msg_component", VillaEvent
     ) {

simbot-component-miyoushe-villa-core/src/main/kotlin/love/forte/simbot/component/miyoushe/event/VillaEvent.kt

@@ -47,6 +47,8 @@ public abstract class VillaEvent<E : EventExtendData> : Event {
     override val timestamp: Timestamp
         get() = Timestamp.byMillisecond(sourceEvent.sendAt)
 
+    override fun toString(): String = "VillaEvent(sourceEvent=$sourceEvent)"
+
     abstract override val key: Event.Key<out VillaEvent<*>>
 
     public companion object Key : BaseEventKey<VillaEvent<*>>(