Add license header

2 years ago · f0fe0c20fc
parent 975070ca5e
commit f0fe0c20fc
7 changed files with 217 additions and 23 deletions
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@ -4,7 +4,15 @@
    <option name="autoReloadType" value="SELECTIVE" />
  </component>
  <component name="ChangeListManager">
-    <list default="true" id="1adcdbad-26db-47ae-b8e5-83088ba9f2ff" name="Changes" comment="Add example image to README" />
+    <list default="true" id="1adcdbad-26db-47ae-b8e5-83088ba9f2ff" name="Changes" comment="Port to MineDown-adventure, run on the Adventure platform">
+      <change afterPath="$PROJECT_DIR$/HEADER" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/build.gradle" beforeDir="false" afterPath="$PROJECT_DIR$/build.gradle" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/net/william278/paginedown/ListOptions.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/net/william278/paginedown/ListOptions.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/net/william278/paginedown/PaginatedList.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/net/william278/paginedown/PaginatedList.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/main/java/net/william278/paginedown/PaginationException.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/main/java/net/william278/paginedown/PaginationException.java" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/src/test/java/net/william278/paginedown/PaginatedListTests.java" beforeDir="false" afterPath="$PROJECT_DIR$/src/test/java/net/william278/paginedown/PaginatedListTests.java" afterDir="false" />
+    </list>
    <option name="SHOW_DIALOG" value="false" />
    <option name="HIGHLIGHT_CONFLICTS" value="true" />
    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
@ -23,13 +31,36 @@
        </task>
        <projects_view>
          <tree_state>
-            <expand />
+            <expand>
+              <path>
+                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
+                <item name="PagineDown" type="f1a62948:ProjectNode" />
+              </path>
+              <path>
+                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
+                <item name="PagineDown" type="f1a62948:ProjectNode" />
+                <item name="Tasks" type="e4a08cd1:TasksNode" />
+              </path>
+              <path>
+                <item name="" type="6a2764b6:ExternalProjectsStructure$RootNode" />
+                <item name="PagineDown" type="f1a62948:ProjectNode" />
+                <item name="Tasks" type="e4a08cd1:TasksNode" />
+                <item name="other" type="c8890929:TasksNode$1" />
+              </path>
+            </expand>
            <select />
          </tree_state>
        </projects_view>
      </state>
    </system>
  </component>
+  <component name="FileTemplateManagerImpl">
+    <option name="RECENT_TEMPLATES">
+      <list>
+        <option value="Class" />
+      </list>
+    </option>
+  </component>
  <component name="Git.Settings">
    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
  </component>
@ -42,15 +73,27 @@
    <option name="hideEmptyMiddlePackages" value="true" />
    <option name="showLibraryContents" value="true" />
  </component>
-  <component name="PropertiesComponent">{
-  &quot;keyToString&quot;: {
-    &quot;RunOnceActivity.OpenProjectViewOnStart&quot;: &quot;true&quot;,
-    &quot;RunOnceActivity.ShowReadmeOnStart&quot;: &quot;true&quot;,
-    &quot;WebServerToolWindowFactoryState&quot;: &quot;false&quot;,
-    &quot;nodejs_package_manager_path&quot;: &quot;npm&quot;
+  <component name="PropertiesComponent"><![CDATA[{
+  "keyToString": {
+    "RunOnceActivity.OpenProjectViewOnStart": "true",
+    "RunOnceActivity.ShowReadmeOnStart": "true",
+    "WebServerToolWindowFactoryState": "false",
+    "ignore.virus.scanning.warn.message": "true",
+    "last_opened_file_path": "C:/Users/William/IdeaProjects/PagineDown",
+    "node.js.detected.package.eslint": "true",
+    "node.js.detected.package.tslint": "true",
+    "node.js.selected.package.eslint": "(autodetect)",
+    "node.js.selected.package.tslint": "(autodetect)",
+    "nodejs_package_manager_path": "npm",
+    "vue.rearranger.settings.migration": "true"
  }
-}</component>
-  <component name="RunManager" selected="Gradle.PaginatedListTests">
+}]]></component>
+  <component name="RecentsManager">
+    <key name="CopyFile.RECENT_KEYS">
+      <recent name="C:\Users\William\IdeaProjects\PagineDown" />
+    </key>
+  </component>
+  <component name="RunManager" selected="Gradle.PagineDown [updateLicenses]">
    <configuration name="PaginatedListTests" type="GradleRunConfiguration" factoryName="Gradle" temporary="true">
      <ExternalSystemSettings>
        <option name="executionName" />
@ -72,6 +115,29 @@
      <ExternalSystemDebugServerProcess>false</ExternalSystemDebugServerProcess>
      <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
      <DebugAllEnabled>false</DebugAllEnabled>
+      <ForceTestExec>false</ForceTestExec>
+      <method v="2" />
+    </configuration>
+    <configuration name="PagineDown [updateLicenses]" type="GradleRunConfiguration" factoryName="Gradle" temporary="true">
+      <ExternalSystemSettings>
+        <option name="executionName" />
+        <option name="externalProjectPath" value="$PROJECT_DIR$" />
+        <option name="externalSystemIdString" value="GRADLE" />
+        <option name="scriptParameters" />
+        <option name="taskDescriptions">
+          <list />
+        </option>
+        <option name="taskNames">
+          <list>
+            <option value="updateLicenses" />
+          </list>
+        </option>
+        <option name="vmOptions" />
+      </ExternalSystemSettings>
+      <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+      <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+      <DebugAllEnabled>false</DebugAllEnabled>
+      <ForceTestExec>false</ForceTestExec>
      <method v="2" />
    </configuration>
    <configuration name="PagineDown build" type="GradleRunConfiguration" factoryName="Gradle">
@ -86,8 +152,7 @@
        <option name="taskNames">
          <list>
            <option value="clean" />
-            <option value="build" />
-            <option value="publish" />
+            <option value="publishToMavenLocal" />
          </list>
        </option>
        <option name="vmOptions" />
@ -95,14 +160,17 @@
      <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
      <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
      <DebugAllEnabled>false</DebugAllEnabled>
+      <ForceTestExec>false</ForceTestExec>
      <method v="2" />
    </configuration>
    <list>
      <item itemvalue="Gradle.PagineDown build" />
+      <item itemvalue="Gradle.PagineDown [updateLicenses]" />
      <item itemvalue="Gradle.PaginatedListTests" />
    </list>
    <recent_temporary>
      <list>
+        <item itemvalue="Gradle.PagineDown [updateLicenses]" />
        <item itemvalue="Gradle.PaginatedListTests" />
      </list>
    </recent_temporary>
@ -120,6 +188,12 @@
      <workItem from="1660746781694" duration="1569000" />
      <workItem from="1660750313226" duration="296000" />
      <workItem from="1660751456096" duration="283000" />
+      <workItem from="1660775721412" duration="11000" />
+      <workItem from="1660813489817" duration="6000" />
+      <workItem from="1663673518837" duration="364000" />
+      <workItem from="1663674390006" duration="614000" />
+      <workItem from="1663691764514" duration="215000" />
+      <workItem from="1682892261503" duration="407000" />
    </task>
    <task id="LOCAL-00001" summary="Make gradlew executable">
      <created>1660688283740</created>
@ -170,7 +244,21 @@
      <option name="project" value="LOCAL" />
      <updated>1660751644066</updated>
    </task>
-    <option name="localTasksCounter" value="8" />
+    <task id="LOCAL-00008" summary="Update image">
+      <created>1660775726807</created>
+      <option name="number" value="00008" />
+      <option name="presentableId" value="LOCAL-00008" />
+      <option name="project" value="LOCAL" />
+      <updated>1660775726807</updated>
+    </task>
+    <task id="LOCAL-00009" summary="Port to MineDown-adventure, run on the Adventure platform">
+      <created>1663673808922</created>
+      <option name="number" value="00009" />
+      <option name="presentableId" value="LOCAL-00009" />
+      <option name="project" value="LOCAL" />
+      <updated>1663673808922</updated>
+    </task>
+    <option name="localTasksCounter" value="10" />
    <servers />
  </component>
  <component name="TypeScriptGeneratedFilesManager">
@ -196,6 +284,8 @@
    <MESSAGE value="v1.0.2 - Fix issues with jumper buttons, add tests for them" />
    <MESSAGE value="v1.0.3 - Add options to customize no. of page jumper buttons" />
    <MESSAGE value="Add example image to README" />
-    <option name="LAST_COMMIT_MESSAGE" value="Add example image to README" />
+    <MESSAGE value="Update image" />
+    <MESSAGE value="Port to MineDown-adventure, run on the Adventure platform" />
+    <option name="LAST_COMMIT_MESSAGE" value="Port to MineDown-adventure, run on the Adventure platform" />
  </component>
 </project>
--- a/16
+++ b/16
@ -0,0 +1,16 @@
+This file is part of PagineDown, licensed under the Apache License 2.0.
+
+ Copyright (c) William278 <will27528@gmail.com>
+ Copyright (c) contributors
+
+ Licensed 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.
--- a/build.gradle
+++ b/build.gradle
@ -1,10 +1,12 @@
 plugins {
-    id 'java'
+    id 'org.cadixdev.licenser' version '0.6.1'
    id 'maven-publish'
+    id 'java'
 }

 group 'net.william278'
 version '1.1'
+defaultTasks 'licenseFormat', 'build'

 repositories {
    mavenCentral()
@ -13,23 +15,28 @@ repositories {

 dependencies {
    compileOnly 'de.themoep:minedown-adventure:1.7.1-SNAPSHOT'
-    compileOnly 'org.jetbrains:annotations:23.0.0'
+    compileOnly 'org.jetbrains:annotations:24.0.1'

    testImplementation 'de.themoep:minedown-adventure:1.7.1-SNAPSHOT'
-    testImplementation 'net.kyori:adventure-platform-bukkit:4.1.2'
-    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.0'
-    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.0'
+    testImplementation 'net.kyori:adventure-platform-bukkit:4.3.0'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.9.3'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.9.3'
 }

 compileJava.options.encoding = 'UTF-8'

-tasks.withType(JavaCompile) {
+tasks.withType(JavaCompile).configureEach {
    options.encoding = 'UTF-8'
 }

-java {
-    withSourcesJar()
-    withJavadocJar()
+logger.lifecycle("Building PagineDown ${version} by William278")
+version rootProject.version
+archivesBaseName = "${rootProject.name}"
+
+license {
+    header = rootProject.file('HEADER')
+    include '**/*.java'
+    newLine = true
 }

 javadoc {
@ -37,6 +44,11 @@ javadoc {
    options.addStringOption('Xdoclint:none', '-quiet')
 }

+java {
+    withSourcesJar()
+    withJavadocJar()
+}
+
 publishing {
    publications {
        shadow(MavenPublication) { publication ->
--- a/src/main/java/net/william278/paginedown/ListOptions.java
+++ b/src/main/java/net/william278/paginedown/ListOptions.java
@ -1,3 +1,22 @@
+/*
+ * This file is part of PagineDown, licensed under the Apache License 2.0.
+ *
+ *  Copyright (c) William278 <will27528@gmail.com>
+ *  Copyright (c) contributors
+ *
+ *  Licensed 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 net.william278.paginedown;

 import org.jetbrains.annotations.NotNull;
--- a/src/main/java/net/william278/paginedown/PaginatedList.java
+++ b/src/main/java/net/william278/paginedown/PaginatedList.java
@ -1,3 +1,22 @@
+/*
+ * This file is part of PagineDown, licensed under the Apache License 2.0.
+ *
+ *  Copyright (c) William278 <will27528@gmail.com>
+ *  Copyright (c) contributors
+ *
+ *  Licensed 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 net.william278.paginedown;


--- a/src/main/java/net/william278/paginedown/PaginationException.java
+++ b/src/main/java/net/william278/paginedown/PaginationException.java
@ -1,3 +1,22 @@
+/*
+ * This file is part of PagineDown, licensed under the Apache License 2.0.
+ *
+ *  Copyright (c) William278 <will27528@gmail.com>
+ *  Copyright (c) contributors
+ *
+ *  Licensed 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 net.william278.paginedown;

 public class PaginationException extends RuntimeException {
--- a/src/test/java/net/william278/paginedown/PaginatedListTests.java
+++ b/src/test/java/net/william278/paginedown/PaginatedListTests.java
@ -1,3 +1,22 @@
+/*
+ * This file is part of PagineDown, licensed under the Apache License 2.0.
+ *
+ *  Copyright (c) William278 <will27528@gmail.com>
+ *  Copyright (c) contributors
+ *
+ *  Licensed 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 net.william278.paginedown;

 import org.junit.jupiter.api.Assertions;