Merge branch 'dev/feature' into feature/sound-seed

SkriptLang · Jul 1, 2024 · 0ce985e · 0ce985e
2 parents cc0c22b + 28fbc6c
commit 0ce985e
Show file tree

Hide file tree

Showing 142 changed files with 3,984 additions and 1,337 deletions.
diff --git a/.github/workflows/archive-docs.yml b/.github/workflows/archive-docs.yml
@@ -0,0 +1,45 @@
+name: Archive documentation
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  archive-docs:
+      if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
+      needs: release-docs
+      runs-on: ubuntu-latest
+      steps:
+          - name: Configure workflow
+            id: configuration
+            run: |
+              echo "BRANCH_NAME=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
+              echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/archives/${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+              echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT
+              echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT
+          - name: Checkout Skript
+            uses: actions/checkout@v4
+            with:
+                submodules: recursive
+                path: skript
+          - name: Setup documentation environment
+            uses: ./skript/.github/workflows/docs/setup-docs
+            with:
+                docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
+                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
+          - name: Generate documentation
+            uses: ./skript/.github/workflows/docs/generate-docs
+            with:
+                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
+                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
+                skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }}
+                is_release: true
+                generate_javadocs: true
+          - name: Push archive documentation
+            uses: ./skript/.github/workflows/docs/push-docs
+            with:
+                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
+                git_name: Archive Docs Bot
+                git_email: [email protected]
+                git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} archive docs"
diff --git a/.github/workflows/docs/generate-docs/action.yml b/.github/workflows/docs/generate-docs/action.yml
@@ -69,15 +69,15 @@ runs:
                   
         cd $SKRIPT_REPO_DIR
         if [[ "${IS_RELEASE}" == "true" ]]; then
-          ./gradlew genReleaseDocs releaseJavadoc
+          ./gradlew genReleaseDocs javadoc
         elif [[ "${GENERATE_JAVADOCS}" == "true" ]]; then
           ./gradlew genNightlyDocs javadoc
         else
           ./gradlew genNightlyDocs
         fi
 
         if [ -d "${DOCS_OUTPUT_DIR}" ]; then
-          if [[ "${GENERATE_JAVADOCS}" == "true" ]]; then
+          if [[ "${GENERATE_JAVADOCS}" == "true" ]] || [[ "${IS_RELEASE}" == "true" ]] ; then
               mkdir -p "${SKRIPT_DOCS_OUTPUT_DIR}/javadocs" && cp -a "./build/docs/javadoc/." "$_"
           fi
   

diff --git a/.github/workflows/java-8-builds.yml → .github/workflows/java-11-builds.yml b/.github/workflows/java-8-builds.yml → .github/workflows/java-11-builds.yml
@@ -1,4 +1,4 @@
-name: Java 8 CI (MC 1.13-1.16)
+name: Java 11 CI (MC 1.13-1.16)
 
 on:
     push:
@@ -26,7 +26,7 @@ jobs:
             - name: Grant execute permission for gradlew
               run: chmod +x gradlew
             - name: Build Skript and run test scripts
-              run: ./gradlew clean skriptTestJava8
+              run: ./gradlew clean skriptTestJava11
             - name: Upload Nightly Build
               uses: actions/upload-artifact@v4
               if: success()

diff --git a/.github/workflows/junit-8-builds.yml → .github/workflows/junit-11-builds.yml b/.github/workflows/junit-8-builds.yml → .github/workflows/junit-11-builds.yml
@@ -26,4 +26,4 @@ jobs:
             - name: Grant execute permission for gradlew
               run: chmod +x gradlew
             - name: Build Skript and run JUnit
-              run: ./gradlew clean JUnitJava8
+              run: ./gradlew clean JUnitJava11
diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml
@@ -3,6 +3,7 @@ name: Release documentation
 on:
   release:
     types: [published]
+  workflow_dispatch:
 
 jobs:
   release-docs:
@@ -33,6 +34,7 @@ jobs:
               docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
               skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }}
               is_release: true
+              generate_javadocs: true
               cleanup_pattern: "!(nightly|archives|templates)"
         - name: Push release documentation
           uses: ./skript/.github/workflows/docs/push-docs
@@ -41,40 +43,3 @@ jobs:
               git_name: Release Docs Bot
               git_email: [email protected]
               git_commit_message: "Update release docs to ${{ steps.configuration.outputs.BRANCH_NAME }}"
-
-  archive-docs:
-      if: "! contains(toJSON(github.event.commits.*.message), '[ci skip]')"
-      needs: release-docs
-      runs-on: ubuntu-latest
-      steps:
-          - name: Configure workflow
-            id: configuration
-            run: |
-              echo "BRANCH_NAME=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT
-              echo "DOCS_OUTPUT_DIR=${GITHUB_WORKSPACE}/skript-docs/docs/archives/${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
-              echo "DOCS_REPO_DIR=${GITHUB_WORKSPACE}/skript-docs" >> $GITHUB_OUTPUT
-              echo "SKRIPT_REPO_DIR=${GITHUB_WORKSPACE}/skript" >> $GITHUB_OUTPUT
-          - name: Checkout Skript
-            uses: actions/checkout@v4
-            with:
-                submodules: recursive
-                path: skript
-          - name: Setup documentation environment
-            uses: ./skript/.github/workflows/docs/setup-docs
-            with:
-                docs_deploy_key: ${{ secrets.DOCS_DEPLOY_KEY }}
-                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
-          - name: Generate documentation
-            uses: ./skript/.github/workflows/docs/generate-docs
-            with:
-                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
-                docs_output_dir: ${{ steps.configuration.outputs.DOCS_OUTPUT_DIR }}
-                skript_repo_dir: ${{ steps.configuration.outputs.SKRIPT_REPO_DIR }}
-                is_release: true
-          - name: Push archive documentation
-            uses: ./skript/.github/workflows/docs/push-docs
-            with:
-                docs_repo_dir: ${{ steps.configuration.outputs.DOCS_REPO_DIR }}
-                git_name: Archive Docs Bot
-                git_email: [email protected]
-                git_commit_message: "Update ${{ steps.configuration.outputs.BRANCH_NAME }} archive docs"
diff --git a/README.md b/README.md
@@ -16,11 +16,11 @@ Skript requires **Spigot** to work. You heard it right, **CraftBukkit** does *no
 **Paper**, which is a fork of Spigot, is recommended; it is required for some
 parts of Skript to be available.
 
-Skript supports only the **latest** patch versions of Minecraft 1.9+.
+Skript supports only the **latest** patch versions of Minecraft 1.13+.
 For example, this means that 1.16.5 is supported, but 1.16.4 is *not*.
 Testing with all old patch versions is not feasible for us.
 
-Minecraft 1.8 and earlier are not, and will not be supported. New Minecraft
+Minecraft 1.12 and earlier are not, and will not be supported. New Minecraft
 versions will be supported as soon as possible.
 
 ## Download
@@ -77,15 +77,15 @@ Skript has some tests written in Skript. Running them requires a Minecraft
 server, but our build script will create one for you. Running the tests is easy:
 
 ```
-./gradlew (quickTest|skriptTest|skriptTestJava8|skriptTestJava17|skriptTestJava21)
+./gradlew (quickTest|skriptTest|skriptTestJava11|skriptTestJava17|skriptTestJava21)
 ```
 
 <code>quickTest</code> runs the test suite on newest supported server version.
 <code>skriptTestJava21</code> (1.20.6+) runs the tests on Java 21 supported versions.
 <code>skriptTestJava17</code> (1.17-1.20.4) runs the tests on Java 17 supported versions.
-<code>skriptTestJava8</code> (1.13-1.16) runs the tests on Java 8 supported versions.
+<code>skriptTestJava11</code> (1.13-1.16) runs the tests on Java 11 supported versions.
 <code>skriptTest</code> runs the tests on all versions.
-That is, it runs skriptTestJava8, skriptTestJava17, and skriptTestJava21.
+That is, it runs skriptTestJava11, skriptTestJava17, and skriptTestJava21.
 
 By running the tests, you agree to Mojang's End User License Agreement.
 
@@ -164,7 +164,7 @@ dependencies {
 }
 ```
 
-An example of the version tag would be ```dev37c```.
+An example of the version tag would be ```2.8.5```.
 
 > Note: If Gradle isn't able to resolve Skript's dependencies, just [disable the resolution of transitive dependencies](https://docs.gradle.org/current/userguide/resolution_rules.html#sec:disabling_resolution_transitive_dependencies) for Skript in your project.
 

diff --git a/build.gradle b/build.gradle
@@ -29,7 +29,7 @@ dependencies {
 	shadow group: 'org.bstats', name: 'bstats-bukkit', version: '3.0.2'
 	shadow group: 'net.kyori', name: 'adventure-text-serializer-bungeecord', version: '4.3.2'
 
-	implementation group: 'io.papermc.paper', name: 'paper-api', version: '1.20.6-R0.1-SNAPSHOT'
+	implementation group: 'io.papermc.paper', name: 'paper-api', version: '1.21-R0.1-SNAPSHOT'
 	implementation group: 'org.eclipse.jdt', name: 'org.eclipse.jdt.annotation', version: '2.2.700'
 	implementation group: 'com.google.code.findbugs', name: 'findbugs', version: '3.0.1'
 	implementation group: 'com.sk89q.worldguard', name: 'worldguard-legacy', version: '7.0.0-SNAPSHOT'
@@ -70,7 +70,7 @@ task build(overwrite: true, type: ShadowJar) {
 	from sourceSets.main.output
 }
 
-// Excludes the tests for the build task. Should be using junit, junitJava17, junitJava8, skriptTest, quickTest.
+// Excludes the tests for the build task. Should be using junit, junitJava17, junitJava11, skriptTest, quickTest.
 // We do not want tests to run for building. That's time consuming and annoying. Especially in development.
 test {
 	exclude '**/*'
@@ -140,15 +140,6 @@ publishing {
 	}
 }
 
-task releaseJavadoc(type: Javadoc) {
-	title = project.name + ' ' + project.property('version')
-	source = sourceSets.main.allJava
-	classpath = configurations.compileClasspath
-	options.encoding = 'UTF-8'
-	// currently our javadoc has a lot of errors, so we need to suppress the linter
-	options.addStringOption('Xdoclint:none', '-quiet')
-}
-
 // Task to check that test scripts are named correctly
 tasks.register('testNaming') {
 	doLast {
@@ -188,7 +179,7 @@ void createTestTask(String name, String desc, String environments, int javaVersi
 	if (junit) {
 		artifact += 'Skript-JUnit.jar'
 	} else if (releaseDocs) {
-		artifact += 'Skript-github.jar'
+		artifact += 'Skript-' + version + '.jar'
 	} else {
 		artifact += 'Skript-nightly.jar'
 	}
@@ -233,7 +224,7 @@ void createTestTask(String name, String desc, String environments, int javaVersi
 			if (!gradle.taskGraph.hasTask(":tasks") && !gradle.startParameter.dryRun && modifiers.contains(Modifiers.PROFILE)) {
 				if (!project.hasProperty('profiler'))
 					throw new MissingPropertyException('Add parameter -Pprofiler=<path to profiler>', 'profiler', String.class)
-	
+
 				args += '-agentpath:' + project.property('profiler') + '=port=8849,nowait'
 			}
 		}
@@ -242,11 +233,11 @@ void createTestTask(String name, String desc, String environments, int javaVersi
 
 def java21 = 21
 def java17 = 17
-def java8 = 8
+def java11 = 11
 
-def latestEnv = 'java21/paper-1.20.6.json'
+def latestEnv = 'java21/paper-1.21.0.json'
 def latestJava = java21
-def oldestJava = java8
+def oldestJava = java11
 
 def latestJUnitEnv = 'java17/paper-1.20.4.json'
 def latestJUnitJava = java17
@@ -269,25 +260,25 @@ int envJava = project.property('testEnvJavaVersion') == null ? latestJava : Inte
 createTestTask('quickTest', 'Runs tests on one environment being the latest supported Java and Minecraft.', environments + latestEnv, latestJava, 0)
 createTestTask('skriptTestJava21', 'Runs tests on all Java 21 environments.', environments + 'java21', java21, 0)
 createTestTask('skriptTestJava17', 'Runs tests on all Java 17 environments.', environments + 'java17', java17, 0)
-createTestTask('skriptTestJava8', 'Runs tests on all Java 8 environments.', environments + 'java8', java8, 0)
+createTestTask('skriptTestJava11', 'Runs tests on all Java 11 environments.', environments + 'java11', java11, 0)
 createTestTask('skriptTestDev', 'Runs testing server and uses \'system.in\' for command input, stop server to finish.', environments + env, envJava, 0, Modifiers.DEV_MODE, Modifiers.DEBUG)
 createTestTask('skriptProfile', 'Starts the testing server with JProfiler support.', environments + latestEnv, latestJava, -1, Modifiers.PROFILE)
 createTestTask('genNightlyDocs', 'Generates the Skript documentation website html files.', environments + env, envJava, 0, Modifiers.GEN_NIGHTLY_DOCS)
 createTestTask('genReleaseDocs', 'Generates the Skript documentation website html files for a release.', environments + env, envJava, 0, Modifiers.GEN_RELEASE_DOCS)
 tasks.register('skriptTest') {
 	description = 'Runs tests on all environments.'
-	dependsOn skriptTestJava8, skriptTestJava17, skriptTestJava21
+	dependsOn skriptTestJava11, skriptTestJava17, skriptTestJava21
 }
 
 createTestTask('JUnitQuick', 'Runs JUnit tests on one environment being the latest supported Java and Minecraft.', environments + latestJUnitEnv, latestJUnitJava, 0, Modifiers.JUNIT)
 // Disabled as EasyMock 5.2.0 is required for Java 21 support
 // However, we are currently using 5.0.1 (see https://github.com/SkriptLang/Skript/pull/6204#discussion_r1405302009)
 //createTestTask('JUnitJava21', 'Runs JUnit tests on all Java 21 environments.', environments + 'java21', java21, 0, Modifiers.JUNIT)
 createTestTask('JUnitJava17', 'Runs JUnit tests on all Java 17 environments.', environments + 'java17', java17, 0, Modifiers.JUNIT)
-createTestTask('JUnitJava8', 'Runs JUnit tests on all Java 8 environments.', environments + 'java8', java8, 0, Modifiers.JUNIT)
+createTestTask('JUnitJava11', 'Runs JUnit tests on all Java 11 environments.', environments + 'java11', java11, 0, Modifiers.JUNIT)
 tasks.register('JUnit') {
 	description = 'Runs JUnit tests on all environments.'
-	dependsOn JUnitJava8, JUnitJava17//, JUnitJava21
+	dependsOn JUnitJava11, JUnitJava17//, JUnitJava21
 }
 
 // Build flavor configurations
@@ -367,7 +358,7 @@ task nightlyResources(type: ProcessResources) {
 			'today'           : '' + LocalTime.now(),
 			'release-flavor'  : 'skriptlang-nightly', // SkriptLang build, automatically done by CI
 			'release-channel' : 'prerelease', // No update checking, but these are VERY unstable
-			'release-updater' : 'ch.njol.skript.update.NoUpdateChecker', // No autoupdates for now
+			'release-updater' : 'ch.njol.skript.update.NoUpdateChecker', // No auto updates for now
 			'release-source'  : '',
 			'release-download': 'null'
 		]
@@ -389,8 +380,8 @@ task nightlyRelease(type: ShadowJar) {
 }
 
 javadoc {
-	dependsOn nightlyResources
-
+	mustRunAfter(tasks.withType(ProcessResources))
+	title = 'Skript ' + project.property('version')
 	source = sourceSets.main.allJava
 
 	exclude("ch/njol/skript/conditions/**")
@@ -403,10 +394,9 @@ javadoc {
 	exclude("ch/njol/skript/lang/function/ExprFunctionCall.java")
 	exclude("ch/njol/skript/hooks/**")
 	exclude("ch/njol/skript/test/**")
-	
+
 	classpath = configurations.compileClasspath + sourceSets.main.output
 	options.encoding = 'UTF-8'
 	// currently our javadoc has a lot of errors, so we need to suppress the linter
 	options.addStringOption('Xdoclint:none', '-quiet')
 }
-
diff --git a/code-conventions.md b/code-conventions.md
@@ -194,7 +194,7 @@ Your comments should look something like these:
 ## Language Features
 
 ### Compatibility
-[//]: # (To be updated after feature/2.9 for Java 17)
+[//]: # (To be updated for 2.10 for Java 17)
 * Contributions should maintain Java 11 source/binary compatibility, even though compiling Skript requires Java 21
   - Users must not need JRE newer than version 11
 * Versions up to and including Java 21 should work too

diff --git a/gradle.properties b/gradle.properties
@@ -5,7 +5,7 @@ org.gradle.parallel=true
 
 groupid=ch.njol
 name=skript
-version=2.8.6
+version=2.8.7
 jarName=Skript.jar
-testEnv=java21/paper-1.20.6
+testEnv=java21/paper-1.21.0
 testEnvJavaVersion=21
diff --git a/src/main/java/ch/njol/skript/Skript.java b/src/main/java/ch/njol/skript/Skript.java
@@ -752,13 +752,17 @@ protected void afterErrors() {
 											TestTracker.JUnitTestFailed(test, message);
 											Skript.exception(failure.getException(), "JUnit test '" + failure.getTestHeader() + " failed.");
 										});
+										if (SkriptJUnitTest.class.isAssignableFrom(clazz))
+											((SkriptJUnitTest) clazz.getConstructor().newInstance()).cleanup();
 										SkriptJUnitTest.clearJUnitTest();
 									}
 								} catch (IOException e) {
 									Skript.exception(e, "Failed to execute JUnit runtime tests.");
 								} catch (ClassNotFoundException e) {
 									// Should be the Skript test jar gradle task.
 									assert false : "Class 'ch.njol.skript.variables.FlatFileStorageTest' was not found.";
+								} catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException | NoSuchMethodException | SecurityException e) {
+									Skript.exception(e, "Failed to initalize test JUnit classes.");
 								}
 								if (ignored > 0)
 									Skript.warning("There were " + ignored + " ignored test cases! This can mean they are not properly setup in order in that class!");

diff --git a/src/main/java/ch/njol/skript/SkriptConfig.java b/src/main/java/ch/njol/skript/SkriptConfig.java
@@ -170,6 +170,12 @@ public static String formatDate(final long timestamp) {
 		}
 	});
 
+	/**
+	 * Determines whether `on &lt;event&gt;` will be triggered by cancelled events or not.
+	 */
+	public static final Option<Boolean> listenCancelledByDefault = new Option<>("listen to cancelled events by default", false)
+			.optional(true);
+
 
 	/**
 	 * Maximum number of digits to display after the period for floats and doubles