feat: Closes #163 .npmrc support

Author: mpetuska

npm-publish-docs/src/docs/user-guide/configuration/extension.md

@@ -22,6 +22,7 @@ npmPublish {
     | [`npmBin`](#npmBin)             | RegularFile   | `$nodeHome/bin/npm`      |                                 |
     | [`readme`](#readme)             | RegularFile   |                          |                                 |
     | [`npmIgnore`](#npmignore)       | RegularFile   | `$projectDir/.npmignore` |                                 |
+    | [`npmrc`](#npmrc)               | RegularFile   | `$projectDir/.npmrc`     |                                 |
     | [`organization`](#organization) | String        |                          |                                 |
     | [`version`](#version)           | String        | `Project::version`       |                                 |
     | [`access`](#access)             | NpmAccess     | `NpmAccess.PUBLIC`       |                                 |
@@ -38,6 +39,7 @@ npmPublish {
     | [`npmBin`](#npmBin)             |     | `npm.publish.npmBin`       | `NPM_PUBLISH_NPMBIN`       |
     | [`readme`](#readme)             |     | `npm.publish.readme`       | `NPM_PUBLISH_README`       |
     | [`npmIgnore`](#npmignore)       |     | `npm.publish.npmIgnore`    | `NPM_PUBLISH_NPMIGNORE`    |
+    | [`npmrc`](#npmrc)               |     | `npm.publish.npmrc`        | `NPM_PUBLISH_NPMRC`        |
     | [`organization`](#organization) |     | `npm.publish.organization` | `NPM_PUBLISH_ORGANIZATION` |
     | [`version`](#version)           |     | `npm.publish.version`      | `NPM_PUBLISH_VERSION`      |
     | [`access`](#access)             |     | `npm.publish.access`       | `NPM_PUBLISH_ACCESS`       |
@@ -54,6 +56,7 @@ npmPublish {
       npmBin.set(File("/path/to/node/bin/npm"))
       readme.set(rootDir.resolve("README.md"))
       npmIgnore.set(projectDir.resolve(".npmIgnore"))
+      npmrc.set(projectDir.resolve(".npmrc"))
       organization.set("${project.group}")
       version.set("${project.version}")
       access.set(RESTRICTED)
@@ -95,6 +98,11 @@ explicitly. The file name is ignored and renamed to `README.md` when assembling.
 A location of the default `.npmignore` file. If set, it will be used as a default for all packages that do not have one
 set explicitly.
 
+### `npmrc`
+
+A location of the default `.npmrc` file. If set, it will be used as a default for all registries that do not have one
+set explicitly.
+
 ### `organization`
 
 Default package scope. If set, it will be used as a default for all packages that do not have one set explicitly.

npm-publish-docs/src/docs/user-guide/configuration/registry.md

@@ -38,16 +38,17 @@ npmPublish {
 
 === "Properties"
 
-    | Property                  | Type      | Default                                              | When Kotlin plugin is present |
-    |:--------------------------|-----------|:-----------------------------------------------------|-------------------------------|
-    | [`access`](#access)       | NpmAccess | [`NpmPublishExtension::access`](extension.md#access) |                               |
-    | [`dry`](#dry)             | NpmAccess | [`NpmPublishExtension::dry`](extension.md#dry)       |                               |
-    | [`uri`](#uri)             | URI       |                                                      |                               |
-    | [`otp`](#otp)             | String    |                                                      |                               |
-    | [`authToken`](#authtoken) | String    |                                                      |                               |
-    | [`auth`](#auth)           | String    |                                                      |                               |
-    | [`username`](#username)   | String    |                                                      |                               |
-    | [`password`](#password)   | String    |                                                      |                               |
+    | Property                  | Type        | Default                                              | When Kotlin plugin is present |
+    |:--------------------------|-------------|:-----------------------------------------------------|-------------------------------|
+    | [`access`](#access)       | NpmAccess   | [`NpmPublishExtension::access`](extension.md#access) |                               |
+    | [`dry`](#dry)             | NpmAccess   | [`NpmPublishExtension::dry`](extension.md#dry)       |                               |
+    | [`uri`](#uri)             | URI         |                                                      |                               |
+    | [`otp`](#otp)             | String      |                                                      |                               |
+    | [`authToken`](#authtoken) | String      |                                                      |                               |
+    | [`auth`](#auth)           | String      |                                                      |                               |
+    | [`username`](#username)   | String      |                                                      |                               |
+    | [`password`](#password)   | String      |                                                      |                               |
+    | [`npmrc`](#npmrc)         | RegularFile | [`NpmPublishExtension::npmrc`](extension.md#npmrc)   |                                                                         |
 
 === "Keys"
 
@@ -136,3 +137,7 @@ Should always be specified together with a username.
 
 !!! note
     Only one of `authToken`, `auth` or `username` + `password` should be provided.
+
+### `npmrc`
+
+An optional `.npmrc` to use when publishing packages to this registry.

npm-publish-gradle-plugin/src/main/kotlin/config/extension.kt

@@ -4,7 +4,6 @@ import dev.petuska.npm.publish.extension.NpmPublishExtension
 import dev.petuska.npm.publish.extension.domain.NpmAccess
 import dev.petuska.npm.publish.util.notFalse
 import dev.petuska.npm.publish.util.sysProjectEnvPropertyConvention
-import dev.petuska.npm.publish.util.unsafeCast
 import org.gradle.api.Project
 
 internal fun Project.configure(extension: NpmPublishExtension) {
@@ -20,14 +19,21 @@ internal fun Project.configure(extension: NpmPublishExtension) {
   extension.nodeBin.convention(extension.nodeHome.map { it.file("bin/node") })
   extension.npmBin.convention(extension.nodeHome.map { it.file("bin/npm") })
   extension.readme.convention(
-    sysProjectEnvPropertyConvention("readme").map { layout.projectDirectory.file(it) }
+    sysProjectEnvPropertyConvention("readme").map(layout.projectDirectory::file)
   )
   extension.npmIgnore.convention(
     sysProjectEnvPropertyConvention(
       "npmIgnore",
-      provider { layout.projectDirectory.file(".npmignore") }
-        .map { (if (it.asFile.exists()) it else null).unsafeCast() }
-    ).map { layout.projectDirectory.file(it) }
+      provider { layout.projectDirectory.file(".npmignore").asFile }
+        .map { (if (it.exists()) it.absolutePath else null) }
+    ).map(layout.projectDirectory::file)
+  )
+  extension.npmrc.convention(
+    sysProjectEnvPropertyConvention(
+      "npmrc",
+      provider { layout.projectDirectory.file(".npmrc").asFile }
+        .map { (if (it.exists()) it.absolutePath else null) }
+    ).map(layout.projectDirectory::file)
   )
   extension.organization.convention(
     sysProjectEnvPropertyConvention("organization")

npm-publish-gradle-plugin/src/main/kotlin/config/registry.kt

@@ -10,6 +10,7 @@ import dev.petuska.npm.publish.util.notFalse
 import dev.petuska.npm.publish.util.sysProjectEnvPropertyConvention
 import dev.petuska.npm.publish.util.toCamelCase
 import org.gradle.api.Project
+import java.io.File
 import java.net.URI
 
 internal fun Project.configure(registry: NpmRegistry) {
@@ -25,6 +26,10 @@ internal fun Project.configure(registry: NpmRegistry) {
   registry.auth.convention(sysProjectEnvPropertyConvention(prefix + "auth"))
   registry.username.convention(sysProjectEnvPropertyConvention(prefix + "username"))
   registry.password.convention(sysProjectEnvPropertyConvention(prefix + "password"))
+  registry.npmrc.convention(
+    sysProjectEnvPropertyConvention(prefix + "npmrc", extension.npmrc.asFile.map(File::getAbsolutePath))
+      .map(layout.projectDirectory::file)
+  )
   registry.dry.convention(
     sysProjectEnvPropertyConvention(prefix + "dry", extension.dry.map(Boolean?::toString)).map { it.notFalse() }
   )

npm-publish-gradle-plugin/src/main/kotlin/extension/NpmPublishExtension.kt

@@ -59,6 +59,13 @@ public abstract class NpmPublishExtension : WithGradleFactories(), ExtensionAwar
    */
   public abstract val npmIgnore: RegularFileProperty
 
+  /**
+   * A location of the default `.npmrc` file.
+   * If set, it will be used as a default for all registries that do not have one set explicitly.
+   * @see [NpmRegistry.npmrc]
+   */
+  public abstract val npmrc: RegularFileProperty
+
   /**
    * Default package scope.
    * If set, it will be used as a default for all packages that do not have one set explicitly.

npm-publish-gradle-plugin/src/main/kotlin/extension/domain/NpmRegistry.kt

@@ -6,10 +6,14 @@ import dev.petuska.npm.publish.task.NpmPublishTask
 import dev.petuska.npm.publish.util.NamedInput
 import dev.petuska.npm.publish.util.NpmPublishDsl
 import org.gradle.api.NamedDomainObjectContainer
+import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.InputFile
 import org.gradle.api.tasks.Optional
+import org.gradle.api.tasks.PathSensitive
+import org.gradle.api.tasks.PathSensitivity
 import java.net.URI
 
 /**
@@ -74,6 +78,15 @@ public abstract class NpmRegistry : NamedInput {
   @get:Optional
   public abstract val password: Property<String>
 
+  /**
+   * A location of the default `.npmrc` file.
+   * If set, it will be used as a default for all registries that do not have one set explicitly.
+   */
+  @get:InputFile
+  @get:Optional
+  @get:PathSensitive(PathSensitivity.RELATIVE)
+  public abstract val npmrc: RegularFileProperty
+
   /**
    * Specifies if a dry-run should be added to the npm command arguments by default. Dry run does all the
    * normal run des except actual file uploading. Defaults to `false`.

npm-publish-gradle-plugin/src/main/kotlin/task/NpmPublishTask.kt

@@ -5,19 +5,24 @@ import dev.petuska.npm.publish.extension.domain.NpmRegistry
 import dev.petuska.npm.publish.util.configure
 import org.gradle.api.Action
 import org.gradle.api.file.DirectoryProperty
+import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.provider.Property
 import org.gradle.api.publish.plugins.PublishingPlugin.PUBLISH_TASK_GROUP
 import org.gradle.api.tasks.*
 import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.options.Option
 import java.util.*
+import javax.inject.Inject
 
 /**
  * A publishing task that publishes a given package to a given registry.
  */
 @Suppress("LeakingThis")
 @UntrackedTask(because = "Must always run")
 public abstract class NpmPublishTask : NpmExecTask() {
+  @get:Inject
+  internal abstract val fs: FileSystemOperations
+
   /**
    * A registry to publish to
    * @see [NpmRegistry]
@@ -98,7 +103,13 @@ public abstract class NpmPublishTask : NpmExecTask() {
       if (d) add("--dry-run")
       if (tag.isPresent) add("--tag=${tag.get()}")
     }
-    npmExec(args) { it.workingDir(packageDir.get()) }.rethrowFailure()
+    val workingDir = project.layout.buildDirectory.dir("registries/${reg.name}/${packageDir.get().asFile.name}")
+    fs.sync {
+      it.from(packageDir)
+      if (reg.npmrc.isPresent) it.from(reg.npmrc)
+      it.into(workingDir)
+    }
+    npmExec(args) { it.workingDir(workingDir.get()) }.rethrowFailure()
     if (!d) info { "Published package at $pDir to ${reg.name} registry" }
   }
 }