diff --git a/.editorconfig b/.editorconfig index f04c87852..779f99a12 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,6 +10,3 @@ insert_final_newline = true [*.md] trim_trailing_whitespace = false - -[*.properties] -insert_final_newline = false diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 67be8726d..042f1f27a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,4 +12,5 @@ labels: bug ## Useful information to include: - Minecraft version - CC: Restitched version + - Logs: These will be located in the `logs/` directory of your Minecraft instance. Please upload them as a gist or directly into this editor. - Detailed reproduction steps: sometimes I can spot a bug pretty easily, but often it's much more obscure. The more information I have to help reproduce it, the quicker it'll get fixed. diff --git a/.github/ISSUE_TEMPLATE/peripheral_shoutout.md b/.github/ISSUE_TEMPLATE/peripheral_shoutout.md index e2aa86bb7..2d2c9c139 100644 --- a/.github/ISSUE_TEMPLATE/peripheral_shoutout.md +++ b/.github/ISSUE_TEMPLATE/peripheral_shoutout.md @@ -9,4 +9,4 @@ labels: peripheralShoutout - Link to the mod - Mod Name - Basic description of the mod - - Link to CC:R Peripheral Documentation for the mod \ No newline at end of file + - Link to CC:R Peripheral Documentation for the mod diff --git a/.github/matchers/checkstyle.json b/.github/matchers/checkstyle.json new file mode 100644 index 000000000..ca6e30e63 --- /dev/null +++ b/.github/matchers/checkstyle.json @@ -0,0 +1,17 @@ +{ + "problemMatcher": [ + { + "owner": "checkstyle", + "pattern": [ + { + "regexp": "^([a-z]+) ([\\w./-]+):(\\d+):(\\d+): (.*)$", + "severity": 1, + "file": 2, + "line": 3, + "column": 4, + "message": 5 + } + ] + } + ] +} diff --git a/.github/matchers/illuaminate.json b/.github/matchers/illuaminate.json new file mode 100644 index 000000000..f59036028 --- /dev/null +++ b/.github/matchers/illuaminate.json @@ -0,0 +1,18 @@ +{ + "problemMatcher": [ + { + "owner": "illuaminate", + "severity": "warning", + "pattern": [ + { + "regexp": "^([\\w./-]+):\\[(\\d+):(\\d+)\\-(?:\\d+):(?:\\d+)\\]: (.*) \\[([a-z:-]+)\\]$", + "file": 1, + "line": 2, + "column": 3, + "message": 4, + "code": 5 + } + ] + } + ] +} diff --git a/.github/matchers/junit.json b/.github/matchers/junit.json new file mode 100644 index 000000000..1655a5f66 --- /dev/null +++ b/.github/matchers/junit.json @@ -0,0 +1,15 @@ +{ + "problemMatcher": [ + { + "owner": "junit", + "pattern": [ + { + "regexp": "^## ([\\w./-]+):(\\d+): (.*)$", + "file": 1, + "line": 2, + "message": 3 + } + ] + } + ] +} diff --git a/.github/workflows/main-ci.yml b/.github/workflows/main-ci.yml index 133c74a4c..c1103486c 100644 --- a/.github/workflows/main-ci.yml +++ b/.github/workflows/main-ci.yml @@ -3,33 +3,58 @@ name: Build on: [push, pull_request] jobs: - build: - name: Build - runs-on: ubuntu-latest + build: + name: Build + runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - name: Checkout submodules - run: git submodule update --init --recursive + steps: + - uses: actions/checkout@v2 + - name: Checkout submodules + run: git submodule update --init --recursive - - name: Set up Java 8 - uses: actions/setup-java@v1 - with: - java-version: 8 - - name: Cache gradle dependencies - uses: actions/cache@v2 - with: - path: ~/.gradle/caches - key: ${{ runner.os }}-gradle-${{ hashFiles('gradle.properties') }} - restore-keys: | - ${{ runner.os }}-gradle- + - name: Set up Java 8 + uses: actions/setup-java@v1 + with: + java-version: 8 - - name: Build with Gradle - run: ./gradlew build --no-daemon || ./gradlew build --no-daemon + - name: Cache gradle dependencies + uses: actions/cache@v2 + with: + path: ~/.gradle/caches + key: ${{ runner.os }}-gradle-${{ hashFiles('gradle.properties') }} + restore-keys: | + ${{ runner.os }}-gradle- - - name: Upload Jar - uses: actions/upload-artifact@v1 - with: - name: cc-restiched - path: build/libs + - name: Disable Gradle daemon + run: | + mkdir -p ~/.gradle + echo "org.gradle.daemon=false" >> ~/.gradle/gradle.properties + + - name: Build with Gradle + run: | + ./gradlew assemble || ./gradlew assemble + ./gradlew build + + - name: Upload Jar + uses: actions/upload-artifact@v2 + with: + name: cc-restitched + path: build/libs + + - name: Parse test reports + run: ./tools/parse-reports.py + if: ${{ failure() }} + + - name: Cache pre-commit + uses: actions/cache@v2 + with: + path: ~/.cache/pre-commit + key: ${{ runner.os }}-pre-commit-${{ hashFiles('config/pre-commit/config.yml') }} + restore-keys: | + ${{ runner.os }}-pre-commit- + + - name: Run linters + run: | + pip install pre-commit + pre-commit run --config config/pre-commit/config.yml --show-diff-on-failure --all --color=always diff --git a/.gitignore b/.gitignore index 015269e79..4efc71fe5 100644 --- a/.gitignore +++ b/.gitignore @@ -20,4 +20,4 @@ .idea .gradle *.DS_Store -.project \ No newline at end of file +.project diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile index a42c8bdb1..7a0de01ca 100644 --- a/.gitpod.Dockerfile +++ b/.gitpod.Dockerfile @@ -16,4 +16,4 @@ RUN sudo apt-get -q update && \ sudo apt install -yq openjdk-8-jdk openjdk-16-jdk # This is so that you can use java 8 until such a time as you switch to java 16 -RUN sudo update-java-alternatives --set java-1.8.0-openjdk-amd64 \ No newline at end of file +RUN sudo update-java-alternatives --set java-1.8.0-openjdk-amd64 diff --git a/.gitpod.yml b/.gitpod.yml index 0e926b2a1..d773abea4 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -15,4 +15,4 @@ vscode: tasks: - - init: ./gradlew \ No newline at end of file + - init: ./gradlew diff --git a/.vscode/settings.json b/.vscode/settings.json index f1a1f60c9..1ffa4a6e4 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -9,7 +9,7 @@ // Custom Hidden Files "**/.bin": true, "**/.editorconfig": true, - }, - + }, + "java.configuration.updateBuildConfiguration": "automatic" -} \ No newline at end of file +} diff --git a/LICENSE b/LICENSE index 65a70f5ae..cf30d77a6 100644 --- a/LICENSE +++ b/LICENSE @@ -19,14 +19,14 @@ Mod: The mod code designated by the present license, in source form, binary form, as obtained standalone, as part of a wider distribution or resulting from the compilation of the original or modified sources. -Dependency: Code required for the mod to work properly. This includes +Dependency: Code required for the mod to work properly. This includes dependencies required to compile the code as well as any file or modification that is explicitly or implicitly required for the mod to be working. 1. Scope -------- -The present license is granted to any user of the mod. As a prerequisite, +The present license is granted to any user of the mod. As a prerequisite, a user must own a legally acquired copy of Minecraft 2. Liability @@ -41,13 +41,13 @@ or misuse of this mod fall on the user. 3. Play rights -------------- -The user is allowed to install this mod on a Minecraft client or server and to play +The user is allowed to install this mod on a Minecraft client or server and to play without restriction. 4. Modification rights ---------------------- -The user has the right to decompile the source code, look at either the +The user has the right to decompile the source code, look at either the decompiled version or the original source code, and to modify it. 5. Distribution of original or modified copy rights @@ -61,10 +61,10 @@ include: - patch to its source or binary files - any copy of a portion of its binary source files -The user is allowed to redistribute this mod partially, in totality, or +The user is allowed to redistribute this mod partially, in totality, or included in a distribution. -When distributing binary files, the user must provide means to obtain its +When distributing binary files, the user must provide means to obtain its entire set of sources or modified sources at no cost. All distributions of this mod must remain licensed under the CCPL. @@ -92,7 +92,7 @@ must be made available at no cost and remain licensed under the CCPL. --------------- If you choose to contribute code or assets to be included in this mod, you -agree that, if added to to the main repository at +agree that, if added to to the main repository at https://github.com/dan200/ComputerCraft, your contributions will be covered by this license, and that Daniel Ratcliffe will retain the right to re-license the mod, including your contributions, in part or in whole, under other licenses. diff --git a/README.md b/README.md index d13e01b6a..0041dfb86 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Any contribution is welcome, be that using the mod, reporting bugs or contributi > Comments, optional but useful if you had to do something differently than in CC:T outside of [Fabric](https://fabricmc.net/)/[Forge](https://mcforge.readthedocs.io/en/1.16.x/) differences > > \`\`\` - > + > >commitID > > commit title @@ -38,29 +38,29 @@ Any contribution is welcome, be that using the mod, reporting bugs or contributi > commit desc > > \`\`\` -2) Follow the [Fabric](https://fabricmc.net/) programming guidelines as close as possible. This means you have to use [`loom`](https://fabricmc.net/wiki/tutorial:mappings) mappings, +2) Follow the [Fabric](https://fabricmc.net/) programming guidelines as close as possible. This means you have to use [`loom`](https://fabricmc.net/wiki/tutorial:mappings) mappings, 3) You cannot intentionally implement bugs and security vulnerabilities 4) Unless the commit is a ["patchwork"](https://github.com/Merith-TK/cc-restitched/blob/fabric/patchwork.md) compliant commit, (IE: taken from CC:T), the lua code is off limits ## Bleeding Edge Builds Bleeding edge builds can be found [here](https://github.com/Merith-TK/cc-restitched/actions) at Github Actions. ## Community -If you need help getting started with CC: Tweaked, want to show off your latest project, or just want to chat about ComputerCraft, here is the [Forum](https://forums.computercraft.cc/) and the [Discord](https://discord.gg/H2UyJXe) +If you need help getting started with CC: Tweaked, want to show off your latest project, or just want to chat about ComputerCraft, here is the [Forum](https://forums.computercraft.cc/) and the [Discord](https://discord.gg/H2UyJXe) ## Known Issues Main Known issue * Mods that add blocks that can be used as peripherals for CC:T On forge, don't work with CC:R. * This is because of the differences between forge and fabric, and that mod devs, to my knowledge have not agreed upon a standard method in which to implement cross compatibility between mods, -* [Fixed (d10f297c): please report if bug persists]
~~Storage Peripherals throw a java "StackOverflowError" when using `pushItems()`,~~ - * ~~Work around, you are probably using `pushItems(chest, 1)` or similar. please use `pushItems(chest, 1, nil, 1)`.~~ +* [Fixed (d10f297c): please report if bug persists]
~~Storage Peripherals throw a java "StackOverflowError" when using `pushItems()`,~~ + * ~~Work around, you are probably using `pushItems(chest, 1)` or similar. please use `pushItems(chest, 1, nil, 1)`.~~ * Computers will not run built in commands, saying "File not found" * This is a know bug, dont know what causes it, but just restart the computer (`ctrl+r` for one second) and it will work again * Occurs when server runs `/reload` or a datapack is updated - + ## Perpherals Unfortunately, unlike the original CC:Tweaked project, CC:Restitched, does not have any actual peripheral mods, currently the only one we have is an example for mod devs to get started with making/adding the peripheral API to their mods! If your a mod dev made a mod with CC:R peripheral support, OR if your a player who found a mod with CC:R support, please open an [issue here](https://github.com/Merith-TK/cc-restitched/issues/new?assignees=&labels=peripheralShoutout&template=peripheral_shoutout.md) to let us know so we can add it to the list! * ![icon](https://raw.githubusercontent.com/Toad-Dev/cc-peripheral-test/master/src/main/resources/assets/cc_test/textures/block/test_peripheral.png) [CC Peripheral Test](https://github.com/Toad-Dev/cc-peripheral-test) - * This is an example mod for how to make peripherals that work as a block, or as a turtle upgrade! \ No newline at end of file + * This is an example mod for how to make peripherals that work as a block, or as a turtle upgrade! diff --git a/build.gradle b/build.gradle index 9d847ea70..686c19c8a 100644 --- a/build.gradle +++ b/build.gradle @@ -1,6 +1,8 @@ plugins { - id 'fabric-loom' version '0.6-SNAPSHOT' + id 'fabric-loom' version '0.7-SNAPSHOT' id 'maven-publish' + id "checkstyle" + id "com.github.hierynomus.license" version "0.15.0" } sourceCompatibility = JavaVersion.VERSION_1_8 @@ -22,10 +24,12 @@ repositories { } configurations { - compile.extendsFrom shade + implementation.extendsFrom shade } dependencies { + checkstyle "com.puppycrawl.tools:checkstyle:8.25" + minecraft "com.mojang:minecraft:${mc_version}" mappings "net.fabricmc:yarn:${mc_version}+build.${mappings_version}:v2" modImplementation "net.fabricmc:fabric-loader:${fabric_loader_version}" @@ -37,7 +41,7 @@ dependencies { modImplementation "io.github.prospector:modmenu:${modmenu_version}" modImplementation "me.shedaniel.cloth.api:cloth-utils-v1:${cloth_api_version}" - compile 'com.electronwill.night-config:toml:3.6.3' + implementation 'com.electronwill.night-config:toml:3.6.3' implementation 'com.google.code.findbugs:jsr305:3.0.2' shade 'org.squiddev:Cobalt:0.5.2-SNAPSHOT' @@ -85,6 +89,49 @@ jar { from configurations.shade.collect { it.isDirectory() ? it : zipTree(it) } } + +import com.hierynomus.gradle.license.tasks.LicenseCheck +import com.hierynomus.gradle.license.tasks.LicenseFormat + +license { + mapping("java", "SLASHSTAR_STYLE") + strictCheck true + + ext.year = Calendar.getInstance().get(Calendar.YEAR) +} + +[licenseMain, licenseFormatMain].forEach { + it.configure { + include("**/*.java") + exclude("dan200/computercraft/api/**") + header file('config/license/main.txt') + } +} + +[licenseTest, licenseFormatTest].forEach { + it.configure { + include("**/*.java") + header file('config/license/main.txt') + } +} + +gradle.projectsEvaluated { + tasks.withType(LicenseFormat) { + outputs.upToDateWhen { false } + } +} + + +task licenseAPI(type: LicenseCheck); +task licenseFormatAPI(type: LicenseFormat); +[licenseAPI, licenseFormatAPI].forEach { + it.configure { + source = sourceSets.main.java + include("dan200/computercraft/api/**") + header file('config/license/api.txt') + } +} + // configure the maven publication publishing { publications { diff --git a/codeInspectionSettings.xml b/codeInspectionSettings.xml index 2862d72b4..57b8ed0d7 100644 --- a/codeInspectionSettings.xml +++ b/codeInspectionSettings.xml @@ -2488,4 +2488,4 @@ - \ No newline at end of file + diff --git a/codeStyleSettings.xml b/codeStyleSettings.xml index b4c9573fd..9a1e0f1d4 100644 --- a/codeStyleSettings.xml +++ b/codeStyleSettings.xml @@ -58,4 +58,4 @@