Init project #1
Merged
Init project #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Also: * Remove unnecessary test suite. We're going to use `test` only. * Ensure task dependencies (just in case).
Also: * Add `prototap` tag to the Gradle plugin.
Also: * Suppress and document detekt warnings.
Also: * Document `Extension`. * Improve documentation of name constants. * Avoid star imports.
armiol
requested changes
May 1, 2024
There was a problem hiding this comment.
@alexander-yevsyukov LGTM in general. Please see some comments.
| import java.nio.file.Paths | ||
| import kotlin.io.path.pathString | ||
|
|
||
| public object Paths { |
| public fun outputFile(buildDir: String, shortFileName: String): String = | ||
| outputRoot(buildDir).resolve(shortFileName).pathString | ||
| } | ||
|
|
| .withSharedTestKitDirectory() | ||
| .replace("@PROTOTAP_PLUGIN_ID@", GRADLE_PLUGIN_ID) | ||
| .replace("@PROTOTAP_VERSION@", version) | ||
| //.withLoggingLevel(LogLevel.INFO) |
There was a problem hiding this comment.
I would move this line under //.enableRunnerDebug(), because it also makes sense when investigating some issue, such as a test failure.
| val bytes = Base64.getDecoder().decode(this) | ||
| return String(bytes, UTF_8) | ||
| } | ||
|
|
| import kotlin.text.Charsets.UTF_8 | ||
|
|
||
| /** | ||
| * Stores the received `CodeGeneratorRequest` to the file passed as the parameter. |
There was a problem hiding this comment.
I can see we do System.out.write(emptyResponse.toByteArray()), and I don't understand how it is connected to "... file passed as the parameter."
Something doesn't feel right here. Please review.
Also: * Use encoded writing for `CodeGeneratorResponse`. This is how older McJava codegen does this. It's also what [protoc docs](https://protobuf.dev/reference/cpp/api-docs/google.protobuf.compiler.plugin.pb/) tell about it.
armiol
approved these changes
May 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR initiates the project, providing first pre-1.0.0 draft for the implementation. The project uses the same development approach as the rest of Spine SDK sub-projects based on
configsubmodule. Hence, the number of files in this PR.Basic architecture
The ProtoTap consists of the following modules:
api— constants and functions common to all modules.gradle-plugin— the Protobuf plugin which taps Protobuf Gradle plugin.protoc-plugin— the plugin toprotocresponsible for tappingCodeGeneratorRequest.Please see
README.mdfor details on the usage of the Gradle plugin.Version and publishing
The version selected for this PR is
0.8.0meaning we expect that some changes may come from the usage experience before we put the1.0.0stamp on the thing. Though, we don't expect too many of them.The version we put is not a snapshot, so the Gradle plugin is going to be submitted to Gradle Plugin portal, and since it is a new plugin, we expect the approval process.
Unlike ProtoData, ProtoTap uses newer (
1.2.1) version of the com.gradle.plugin-publish plugin with shorter DSL. The procedure of the approval may also differ.