Fix issue #99: rename the nodeModulesDir property to nodeProjectDir, a more explicit and less confusing name.

Author: bsautel

CHANGELOG.md

@@ -14,7 +14,7 @@ that shows how to use this plugin version with Kotlin)
 * Fix some remaining input/output declaration issues (issue
  [#34](https://github.com/node-gradle/gradle-node-plugin/issues/34))
 * Gradle 5.6.4+ support (instead of Gradle 5.0.0+ before)
-* Node.js 10+ support 
+* Node.js 10+ support (issue [#100](https://github.com/node-gradle/gradle-node-plugin/issues/100))
 
 This version breaks backward compatibility. It should not visible for most Groovy DSL users since the Groovy DSL
 handles transparently most of these changes.
@@ -28,6 +28,9 @@ Here is what changed:
 Gradle. This makes this plugin fully compatible with lazy configuration (tasks will be configured only if they need to 
 run and configuration properties are read only at runtime if needed and not at configuration time).
 * Thanks to the Kotlin rewrite, some properties now have a stronger typing.
+* `nodeModulesDir` option was renamed to `nodeProjectDir` (name more explicit and less confusing)
+ (issue [#99](https://github.com/node-gradle/gradle-node-plugin/issues/99)). The former name still works but is 
+ deprecated.
 * Change the syntax to configure `nodeModulesOutputFilter` on `npmInstall` and `yarn` tasks. It also affects Groovy DSL 
 users. Use now `nodeModulesOutputFilter { ... }` instead of `nodeModulesOutputFilter = { ... }`.
 

docs/usage.md

@@ -218,8 +218,8 @@ node {
   // Set the work directory for Yarn
   yarnWorkDir = file("${project.buildDir}/yarn")
 
-  // Set the work directory where node_modules should be located
-  nodeModulesDir = file("${project.projectDir}")
+  // Set the Node.js project directory (where package.json and node_modules are be located)
+  nodeProjectDir = file("${project.projectDir}")
 }
 ```
 

src/main/kotlin/com/github/gradle/node/NodeExtension.kt

@@ -10,7 +10,7 @@ open class NodeExtension(project: Project) {
     val workDir = project.objects.directoryProperty().convention(cacheDir.dir("nodejs"))
     val npmWorkDir = project.objects.directoryProperty().convention(cacheDir.dir("npm"))
     val yarnWorkDir = project.objects.directoryProperty().convention(cacheDir.dir("yarn"))
-    val nodeModulesDir = project.objects.directoryProperty().convention(project.layout.projectDirectory)
+    val nodeProjectDir = project.objects.directoryProperty().convention(project.layout.projectDirectory)
     val version = project.objects.property<String>().convention("12.16.2")
     val npmVersion = project.objects.property<String>().convention("")
     val yarnVersion = project.objects.property<String>().convention("")
@@ -21,6 +21,9 @@ open class NodeExtension(project: Project) {
     val yarnCommand = project.objects.property<String>().convention("yarn")
     val download = project.objects.property<Boolean>().convention(false)
 
+    @Deprecated("Deprecated in version 3.0, please use nodeProjectDir now")
+    val nodeModulesDir = nodeProjectDir
+
     init {
         distBaseUrl.set("https://nodejs.org/dist")
     }

src/main/kotlin/com/github/gradle/node/exec/ExecRunner.kt

@@ -34,7 +34,7 @@ internal class ExecRunner {
 
     private fun computeWorkingDir(project: Project, execConfiguration: ExecConfiguration): File? {
         val nodeExtension = NodeExtension[project]
-        val workingDir = execConfiguration.workingDir ?: nodeExtension.nodeModulesDir.get().asFile
+        val workingDir = execConfiguration.workingDir ?: nodeExtension.nodeProjectDir.get().asFile
         workingDir.mkdirs()
         return workingDir
     }

src/main/kotlin/com/github/gradle/node/npm/exec/NpmExecRunner.kt

@@ -71,12 +71,12 @@ internal class NpmExecRunner {
                 npmExecConfiguration.commandExecComputer(variantComputer, nodeExtension, npmBinDirProvider)
         val npmScriptFileProvider =
                 variantComputer.computeNpmScriptFile(nodeDirProvider, npmExecConfiguration.command)
-        return zip(nodeExtension.download, nodeExtension.nodeModulesDir, executableProvider, nodeExecProvider,
+        return zip(nodeExtension.download, nodeExtension.nodeProjectDir, executableProvider, nodeExecProvider,
                 npmScriptFileProvider).map {
-            val (download, nodeModulesDir, executable, nodeExec,
+            val (download, nodeProjectDir, executable, nodeExec,
                     npmScriptFile) = it
             if (download) {
-                val localCommandScript = nodeModulesDir.dir("node_modules/npm/bin")
+                val localCommandScript = nodeProjectDir.dir("node_modules/npm/bin")
                         .file("${npmExecConfiguration.command}-cli.js").asFile
                 if (localCommandScript.exists()) {
                     return@map ExecutableAndScript(nodeExec, localCommandScript.absolutePath)

src/main/kotlin/com/github/gradle/node/npm/task/NpmInstallTask.kt

@@ -61,7 +61,7 @@ open class NpmInstallTask : NpmTask() {
     }
 
     private fun projectFileIfExists(name: String): Provider<File> {
-        return nodeExtension.nodeModulesDir.map { it.file(name).asFile }
+        return nodeExtension.nodeProjectDir.map { it.file(name).asFile }
                 .flatMap { if (it.exists()) project.providers.provider { it } else project.providers.provider { null } }
     }
 
@@ -70,15 +70,15 @@ open class NpmInstallTask : NpmTask() {
     @Suppress("unused")
     protected fun getNodeModulesDirectory(): Provider<Directory> {
         val filter = nodeModulesOutputFilter.orNull
-        return if (filter == null) nodeExtension.nodeModulesDir.dir("node_modules")
+        return if (filter == null) nodeExtension.nodeProjectDir.dir("node_modules")
         else project.providers.provider { null }
     }
 
     @Optional
     @OutputFiles
     @Suppress("unused")
     protected fun getNodeModulesFiles(): Provider<FileTree> {
-        val nodeModulesDirectoryProvider = nodeExtension.nodeModulesDir.dir("node_modules")
+        val nodeModulesDirectoryProvider = nodeExtension.nodeProjectDir.dir("node_modules")
         return zip(nodeModulesDirectoryProvider, nodeModulesOutputFilter)
                 .flatMap { (nodeModulesDirectory, nodeModulesOutputFilter) ->
                     if (nodeModulesOutputFilter != null) {

src/main/kotlin/com/github/gradle/node/yarn/task/YarnInstallTask.kt

@@ -50,7 +50,7 @@ open class YarnInstallTask : YarnTask() {
     }
 
     private fun projectFileIfExists(name: String): Provider<File> {
-        return nodeExtension.nodeModulesDir.map { it.file(name).asFile }
+        return nodeExtension.nodeProjectDir.map { it.file(name).asFile }
                 .flatMap { if (it.exists()) project.providers.provider { it } else project.providers.provider { null } }
     }
 
@@ -59,15 +59,15 @@ open class YarnInstallTask : YarnTask() {
     @Suppress("unused")
     protected fun getNodeModulesDirectory(): Provider<Directory> {
         val filter = nodeModulesOutputFilter.orNull
-        return if (filter == null) nodeExtension.nodeModulesDir.dir("node_modules")
+        return if (filter == null) nodeExtension.nodeProjectDir.dir("node_modules")
         else project.providers.provider { null }
     }
 
     @Optional
     @OutputFiles
     @Suppress("unused")
     protected fun getNodeModulesFiles(): Provider<FileTree> {
-        val nodeModulesDirectoryProvider = nodeExtension.nodeModulesDir.dir("node_modules")
+        val nodeModulesDirectoryProvider = nodeExtension.nodeProjectDir.dir("node_modules")
         return zip(nodeModulesDirectoryProvider, nodeModulesOutputFilter)
                 .flatMap { (nodeModulesDirectory, nodeModulesOutputFilter) ->
                     if (nodeModulesOutputFilter != null) {

src/test/groovy/com/github/gradle/node/NodeExtensionTest.groovy

@@ -14,7 +14,7 @@ class NodeExtensionTest extends AbstractProjectTest {
         nodeExtension.npxCommand.get() == 'npx'
         nodeExtension.distBaseUrl.get() == 'https://nodejs.org/dist'
         nodeExtension.workDir.get() != null
-        nodeExtension.nodeModulesDir.get() != null
+        nodeExtension.nodeProjectDir.get() != null
         nodeExtension.version.get() == '12.16.2'
         !nodeExtension.download.get()
         nodeExtension.npmVersion.get() == ''

src/test/groovy/com/github/gradle/node/npm/task/NpmInstall_integTest.groovy

@@ -87,7 +87,7 @@ class NpmInstall_integTest extends AbstractIntegTest {
             }
 
             node {
-                nodeModulesDir = file('subdirectory')
+                nodeProjectDir = file('subdirectory')
             }
         ''')
         writeFile('subdirectory/package.json', """{

src/test/groovy/com/github/gradle/node/yarn/task/YarnInstall_integTest.groovy

@@ -82,7 +82,7 @@ class YarnInstall_integTest extends AbstractIntegTest {
 
             node {
                 yarnWorkDir = file('build/yarn')
-                nodeModulesDir = file('subdirectory')
+                nodeProjectDir = file('subdirectory')
             }
         ''')
         writeFile('subdirectory/package.json', """{

src/test/resources/fixtures/kotlin/build.gradle.kts

@@ -19,7 +19,7 @@ node {
     workDir.set(file("${project.buildDir}/nodejs"))
     npmWorkDir.set(file("${project.buildDir}/npm"))
     yarnWorkDir.set(file("${project.buildDir}/yarn"))
-    nodeModulesDir.set(file("${project.projectDir}"))
+    nodeProjectDir.set(file("${project.projectDir}"))
 }
 
 val npmInstallTask = tasks.named<NpmInstallTask>("npmInstall") {