node-gradle / node-gradle/gradle-node-plugin

Document how to set up the plugin so that it does not break custom repository configuration

Open Beginner friendly
#348 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Groovy
Stars
677
Forks
120
PR merge metrics
No merged PRs in 30d

Description

It would be helpful to document this approach. I've found it annoying that my project started complaining about all other dependencies which are usually fetched from a custom repository once I added this plugin.

// Append this to the bottom of your settings.gradle.kts
dependencyResolutionManagement {
  repositories {

    ivy {
      url = uri("https://nodejs.org/dist")
      patternLayout {
        artifact("v[revision]/[artifact]-v[revision]-[classifier].[ext]")
        artifact("v[revision]/[artifact]-v[revision].[ext]")
      }
 
      metadataSources {
        artifact()
      }
    
      content {
        includeGroup("org.nodejs")
      }
    }
  }
}

and

// Node configuration
node {
  version.set("xx.yy.zz")
  download.set(true)
  nodeProjectDir.set(file("${projectDir}/..."))
  distBaseUrl = null
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start from the settings.gradle.kts repository configuration and the Node configuration shown in the issue. Document this setup in the plugin's configuration guidance, including how to preserve custom repositories while resolving Node.js artifacts. Done means users can follow the documented approach without dependency resolution complaints.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin, nodejs
Domain
build-system, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.