Skip to content

Commit c881cad

Browse files
committed
Document how to load subset of modules for local dev
1 parent e2cdf2b commit c881cad

File tree

3 files changed

+44
-28
lines changed

3 files changed

+44
-28
lines changed

Diff for: CONTRIBUTING.md

+7
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,13 @@ Each extension should reside in `src/<lang>/<mysourcename>`. Use `all` as `<lang
176176
177177
The `<lang>` used in the folder inside `src` should be the major `language` part. For example, if you will be creating a `pt-BR` source, use `<lang>` here as `pt` only. Inside the source class, use the full locale string instead.
178178
179+
### Loading a subset of Gradle modules
180+
181+
By default, all individual and generated multisrc extensions are loaded for local development.
182+
This may be inconvenient if you only need to work on one extension at a time.
183+
184+
To adjust which modules are loaded, make adjustments to the `settings.gradle.kts` file as needed.
185+
179186
#### Extension file structure
180187
181188
The simplest extension structure looks like this:

Diff for: gradle.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
# Specifies the JVM arguments used for the daemon process.
1111
# The setting is particularly useful for tweaking memory settings.
12-
org.gradle.jvmargs=-Xmx5120m
12+
org.gradle.jvmargs=-Xmx6144m
1313

1414
# When configured, Gradle will run in incubating parallel mode.
1515
# This option should only be used with decoupled projects. More details, visit

Diff for: settings.gradle.kts

+36-27
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
include(":core")
22

3-
// all the directories under /lib instead of manually adding each to a list
3+
// Load all modules under /lib
44
File(rootDir, "lib").eachDir {
55
val libName = it.name
66
include(":lib-$libName")
@@ -13,34 +13,14 @@ if (System.getenv("CI") == null || System.getenv("CI_MODULE_GEN") == "true") {
1313
include(":multisrc")
1414
project(":multisrc").projectDir = File("multisrc")
1515

16-
// Loads all extensions
17-
File(rootDir, "src").eachDir { dir ->
18-
dir.eachDir { subdir ->
19-
val name = ":extensions:individual:${dir.name}:${subdir.name}"
20-
include(name)
21-
project(name).projectDir = File("src/${dir.name}/${subdir.name}")
22-
}
23-
}
24-
// Loads all generated extensions from multisrc
25-
File(rootDir, "generated-src").eachDir { dir ->
26-
dir.eachDir { subdir ->
27-
val name = ":extensions:multisrc:${dir.name}:${subdir.name}"
28-
include(name)
29-
project(name).projectDir = File("generated-src/${dir.name}/${subdir.name}")
30-
}
31-
}
32-
3316
/**
34-
* If you're developing locally and only want to work with a single module,
35-
* comment out the parts above and uncomment below.
17+
* Add or remove modules to load as needed for local development here.
18+
* To generate multisrc extensions first, run the `:multisrc:generateExtensions` task first.
3619
*/
37-
// val lang = "all"
38-
// val name = "mangadex"
39-
// val projectName = ":extensions:individual:$lang:$name"
40-
// val projectName = ":extensions:multisrc:$lang:$name"
41-
// include(projectName)
42-
// project(projectName).projectDir = File("src/${lang}/${name}")
43-
// project(projectName).projectDir = File("generated-src/${lang}/${name}")
20+
loadAllIndividualExtensions()
21+
loadAllGeneratedMultisrcExtensions()
22+
// loadIndividualExtension("all", "mangadex")
23+
// loadGeneratedMultisrcExtension("en", "guya")
4424
} else {
4525
// Running in CI (GitHub Actions)
4626

@@ -70,6 +50,35 @@ if (System.getenv("CI") == null || System.getenv("CI_MODULE_GEN") == "true") {
7050
}
7151
}
7252

53+
fun loadAllIndividualExtensions() {
54+
File(rootDir, "src").eachDir { dir ->
55+
dir.eachDir { subdir ->
56+
val name = ":extensions:individual:${dir.name}:${subdir.name}"
57+
include(name)
58+
project(name).projectDir = File("src/${dir.name}/${subdir.name}")
59+
}
60+
}
61+
}
62+
fun loadAllGeneratedMultisrcExtensions() {
63+
File(rootDir, "generated-src").eachDir { dir ->
64+
dir.eachDir { subdir ->
65+
val name = ":extensions:multisrc:${dir.name}:${subdir.name}"
66+
include(name)
67+
project(name).projectDir = File("generated-src/${dir.name}/${subdir.name}")
68+
}
69+
}
70+
}
71+
fun loadIndividualExtension(lang: String, name: String) {
72+
val projectName = ":extensions:individual:$lang:$name"
73+
include(projectName)
74+
project(projectName).projectDir = File("src/${lang}/${name}")
75+
}
76+
fun loadGeneratedMultisrcExtension(lang: String, name: String) {
77+
val projectName = ":extensions:multisrc:$lang:$name"
78+
include(projectName)
79+
project(projectName).projectDir = File("generated-src/${lang}/${name}")
80+
}
81+
7382
fun File.getChunk(chunk: Int, chunkSize: Int): List<File>? {
7483
return listFiles()
7584
// Lang folder

0 commit comments

Comments
 (0)