Merge pull request #18 from linwumingshi/feature/websocket-markdown

shalousun · web-flow · commit 28ee06370fa8 · 2024-03-19T09:26:54.000+08:00
feat: ✨ add websocket-markdown support;update license validi…
diff --git a/src/main/java/com/ly/doc/gradle/chain/CommonArtifactFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/CommonArtifactFilterChain.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/chain/ContainsFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/ContainsFilterChain.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/chain/FilterChain.java b/src/main/java/com/ly/doc/gradle/chain/FilterChain.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/chain/GroupIdFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/GroupIdFilterChain.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/chain/SpringBootArtifactFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/SpringBootArtifactFilterChain.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/chain/StartsWithFilterChain.java b/src/main/java/com/ly/doc/gradle/chain/StartsWithFilterChain.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/constant/GlobalConstants.java b/src/main/java/com/ly/doc/gradle/constant/GlobalConstants.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -104,8 +104,12 @@ public interface GlobalConstants {
     /**
      * Generate Swagger document
      */
-    String Swagger_TASK = "swagger";
+    String SWAGGER_TASK = "swagger";
 
+    /**
+     * Generate WebSocket markdown document
+     */
+    String WEBSOCKET_MARKDOWN = "webSocketMarkdown";
 
     /**
      * Plugin extension name
diff --git a/src/main/java/com/ly/doc/gradle/constant/TaskConstants.java b/src/main/java/com/ly/doc/gradle/constant/TaskConstants.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -35,10 +35,10 @@ public class TaskConstants {
     /**
      * Map of Gradle Task
      */
-    public static Map<String, Class> taskMap = new HashMap<>();
+    public static Map<String, Class<?>> taskMap = new HashMap<>();
 
     static {
-        //create html
+        // create html
         taskMap.put(GlobalConstants.REST_HTML_TASK, RestHtmlTask.class);
         // create adoc
         taskMap.put(GlobalConstants.REST_ADOC_TASK, RestAdocTask.class);
@@ -50,19 +50,21 @@ public class TaskConstants {
         taskMap.put(GlobalConstants.POSTMAN_TASK, PostmanTask.class);
         // create open api
         taskMap.put(GlobalConstants.OPEN_API_TASK, OpenApiTask.class);
-        //create rpc html
+        // create rpc html
         taskMap.put(GlobalConstants.RPC_HTML_TASK, RpcHtmlTask.class);
         // create rpc adoc
         taskMap.put(GlobalConstants.RPC_ADOC_TASK, RpcAdocTask.class);
-        // create rpc markdown
+        // create rpc Markdown
         taskMap.put(GlobalConstants.RPC_MARKDOWN_TASK, RpcMarkdownTask.class);
         // create torna rest
-        taskMap.put(GlobalConstants.TORNA_REST_TASK,TornaRestTask.class);
+        taskMap.put(GlobalConstants.TORNA_REST_TASK, TornaRestTask.class);
         // create torna rpc
-        taskMap.put(GlobalConstants.TORNA_RPC_TASK,TornaRpcTask.class);
+        taskMap.put(GlobalConstants.TORNA_RPC_TASK, TornaRpcTask.class);
         // create word rest
         taskMap.put(GlobalConstants.WORD_TASK, WordTask.class);
         // create Swagger
-        taskMap.put(GlobalConstants.Swagger_TASK, SwaggerTask.class);
+        taskMap.put(GlobalConstants.SWAGGER_TASK, SwaggerTask.class);
+        // create websocket markdown
+        taskMap.put(GlobalConstants.WEBSOCKET_MARKDOWN, WebSocketMarkdownTask.class);
     }
 }
diff --git a/src/main/java/com/ly/doc/gradle/extension/SmartDocPluginExtension.java b/src/main/java/com/ly/doc/gradle/extension/SmartDocPluginExtension.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/model/CustomArtifact.java b/src/main/java/com/ly/doc/gradle/model/CustomArtifact.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/plugin/SmartDocPlugin.java b/src/main/java/com/ly/doc/gradle/plugin/SmartDocPlugin.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/DocBaseTask.java b/src/main/java/com/ly/doc/gradle/task/DocBaseTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/JMeterTask.java b/src/main/java/com/ly/doc/gradle/task/JMeterTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/OpenApiTask.java b/src/main/java/com/ly/doc/gradle/task/OpenApiTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/PostmanTask.java b/src/main/java/com/ly/doc/gradle/task/PostmanTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/RestAdocTask.java b/src/main/java/com/ly/doc/gradle/task/RestAdocTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/RestHtmlTask.java b/src/main/java/com/ly/doc/gradle/task/RestHtmlTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/RestMarkdownTask.java b/src/main/java/com/ly/doc/gradle/task/RestMarkdownTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/RpcAdocTask.java b/src/main/java/com/ly/doc/gradle/task/RpcAdocTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/RpcHtmlTask.java b/src/main/java/com/ly/doc/gradle/task/RpcHtmlTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/RpcMarkdownTask.java b/src/main/java/com/ly/doc/gradle/task/RpcMarkdownTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/SwaggerTask.java b/src/main/java/com/ly/doc/gradle/task/SwaggerTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/TornaRestTask.java b/src/main/java/com/ly/doc/gradle/task/TornaRestTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/TornaRpcTask.java b/src/main/java/com/ly/doc/gradle/task/TornaRpcTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/task/WebSocketMarkdownTask.java b/src/main/java/com/ly/doc/gradle/task/WebSocketMarkdownTask.java
@@ -0,0 +1,44 @@
+/*
+ * smart-doc
+ *
+ * Copyright (C) 2018-2024 smart-doc
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package com.ly.doc.gradle.task;
+
+import com.ly.doc.builder.websocket.WebSocketMarkdownBuilder;
+import com.ly.doc.model.ApiConfig;
+import com.thoughtworks.qdox.JavaProjectBuilder;
+import org.gradle.api.logging.Logger;
+
+/**
+ * Support for WebSocket markdown
+ *
+ * @author linwumingshi
+ */
+public class WebSocketMarkdownTask extends DocBaseTask {
+    @Override
+    public void executeAction(ApiConfig apiConfig, JavaProjectBuilder javaProjectBuilder, Logger logger) {
+        try {
+            WebSocketMarkdownBuilder.buildApiDoc(apiConfig, javaProjectBuilder);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+}
diff --git a/src/main/java/com/ly/doc/gradle/task/WordTask.java b/src/main/java/com/ly/doc/gradle/task/WordTask.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/util/ArtifactFilterUtil.java b/src/main/java/com/ly/doc/gradle/util/ArtifactFilterUtil.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/util/ClassLoaderUtil.java b/src/main/java/com/ly/doc/gradle/util/ClassLoaderUtil.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
diff --git a/src/main/java/com/ly/doc/gradle/util/GradleUtil.java b/src/main/java/com/ly/doc/gradle/util/GradleUtil.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -26,16 +26,17 @@
 import com.google.gson.FieldAttributes;
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
+import com.ly.doc.model.*;
 import com.power.common.util.FileUtil;
 import com.power.common.util.StringUtil;
-import com.ly.doc.model.*;
 import org.gradle.api.Project;
 import org.gradle.api.logging.Logger;
 
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
-import java.util.*;
+import java.util.List;
+import java.util.Objects;
 
 /**
  * @author yu 2020/2/16.
@@ -61,6 +62,7 @@ public boolean shouldSkipClass(Class<?> aClass) {
      *
      * @param configFile config file
      * @param project    Project object
+     * @param increment  increment
      * @param log        gradle plugin log
      * @return com.power.doc.model.ApiConfig
      */
diff --git a/src/main/java/com/ly/doc/gradle/util/I18nMsgUtil.java b/src/main/java/com/ly/doc/gradle/util/I18nMsgUtil.java
@@ -1,7 +1,7 @@
 /*
  * smart-doc
  *
- * Copyright (C) 2018-2023 smart-doc
+ * Copyright (C) 2018-2024 smart-doc
  *
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
@@ -35,6 +35,9 @@ public interface I18nMsgUtil {
 
     /**
      * Abbreviations, instead of full writing: 👇
+     *
+     * @param key key
+     * @return value
      */
     @SuppressWarnings("JavadocDeclaration")
     static String get(String key) {
diff --git a/src/main/java/com/ly/doc/gradle/util/SourceSetUtil.java b/src/main/java/com/ly/doc/gradle/util/SourceSetUtil.java

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/*`
`2`	`2`	`* smart-doc`
`3`	`3`	`*`
`4`		`- * Copyright (C) 2018-2023 smart-doc`
	`4`	`+ * Copyright (C) 2018-2024 smart-doc`
`5`	`5`	`*`
`6`	`6`	`* Licensed to the Apache Software Foundation (ASF) under one`
`7`	`7`	`* or more contributor license agreements. See the NOTICE file`