Skip to content

Commit

Permalink
Fix lint and add contribuing readme with details on linting
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeNeedham committed May 10, 2024
1 parent 73ccb95 commit 0bae286
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
13 changes: 13 additions & 0 deletions plugin-build/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This is the source for the Module Graph Gradle plugin.

# Formatting
The code style of this project is enforced with Ktlint. Run it with:
`./gradlew :plugin-build:modulegraph:ktlintTestSourceSetCheck`

# Test
This project has extensive unit tests. Run them locally with:
`./gradlew :plugin:modulegraph:test`

# Sample project
Check out the sample project to test out the plugin. Create graphs with:
`./gradlew createModuleGraph`
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ internal fun aModuleGraph() = mapOf(
),
Module(
path = ":sample:container:gama",
)
to listOf(
Module(
path = ":sample:zeta",
configName = "implementation",
) to
listOf(
Module(
path = ":sample:zeta",
configName = "implementation",
),
),
),
)

internal val expectedMermaidGraphCode = """
Expand Down

0 comments on commit 0bae286

Please sign in to comment.