using npm-publish with groovy

[sharongur]

im trying to use this plugin in a java project, i already have a java to typescript generator, so i only need the pubish capabilities of this plugin

im struggling to make it work in my groovy gradle project.
it throws:

Caused by: java.lang.RuntimeException: org.gradle.internal.metaobject.AbstractDynamicObject$CustomMessageMissingMethodException: Could not find method registries() for arguments [precompiled_TypescriptGenerator$_run_closure1$_closure2@2f923aab] on extension 'npmPublishing' of type dev.petuska.npm.publish.dsl.NpmPublishExtension.

the plugin configuration is as it sttes in the guide:

npmPublish { registries { register("npmjs") { uri.set("https://registry.npmjs.org") authToken.set("obfuscated") } } }

[mpetuska]

That's odd since registries method takes groovy Action object as an argument. From your report I see one inconsistency: your config uses "npmPublish" block as appropriate, but error log mentions "npmPublishing" which is old and incorrect. Could you double check that the dsl config you've sent is what you actually have in your project?

[mpetuska]

Also the package is from v2 of the plugin as well. Could you make sure you're using the latest version of the plugin as well?

[sharongur]

ok so i did take the wrong dependency from maven repo and after i got the right version it still didnt work and i found out why

I was taking the example code from youre website documntation:
https://npm-publish.petuska.dev/3.1/user-guide/quick-start/

which states the code block as:
npmPublishing{}

while the readme file in github states the right syntax of:
npmPublish{}

anyway i have another issue now:

i copied your quick start:
npmPublish { registries { register("npmjs") { uri.set("https://company.nexus") authToken.set("obfuscated") } } }

and i swap the url to my own companys registry but i get this error:

Caused by: java.lang.RuntimeException: java.lang.IllegalStateException: Could not create domain object 'npmjs' (NpmRegistry)
at TypescriptGeneratorPlugin.apply(TypescriptGeneratorPlugin.java:30)

do you mind explaining what should i set instead of npmjs? if i dont pubish it to some public repo but to my own companys private nexus server

[mpetuska]

Thnks for spotting typo in the docs! As for your registry issue, the "npmjs" bit is just a domain oblect name and as such can be any string. Not sure why it's crashing though since error log does not orovide much info. I'll try to reproduce it myself tomorrow and get back to you.

[mpetuska]

Oh, wait. I know what's up. You're passing in string when an instance of uri is expected. See here https://npm-publish.petuska.dev/3.1/user-guide/quick-start/#__codelineno-0-16

[mpetuska]

Also noticed that kotlin/js tab sample is incorrect as well

[sharongur]

ok that did the trick!
thanks for the fast response!

now the gradle is compiling. but for some reason i cant see the task 'publishJsPackageToNpmjsRegistry' when doing tasks command on my subproject.

infact, any of the listed commands arent on my project...

ill show you my entire gradle structure ( no kotlin involved)
i have a java project, in which only some classes are generated as typescript via another plugin

now i needed to add the ability to publish those generated typescript classes to my private npm

i create a new plugin that will contain both your plugin and the typescript plugin to make the developers life easier

i made this intro just so you'll understand the structure

buildSrc build.gradle

plugins {
id 'groovy-gradle-plugin'
}
repositories {
gradlePluginPortal() // so that external plugins can be resolved in dependencies section
mavenCentral()
}
dependencies {
// https://mvnrepository.com/artifact/dev.petuska.npm.publish/dev.petuska.npm.publish.gradle.plugin
implementation 'dev.petuska.npm.publish:dev.petuska.npm.publish.gradle.plugin:3.1.0'
// https://mvnrepository.com/artifact/cz.habarta.typescript-generator/typescript-generator-gradle-plugin
implementation 'cz.habarta.typescript-generator:typescript-generator-gradle-plugin:3.1.1185'
}

myPlugin.gradle (inside buildSrc module)

plugins {
id "cz.habarta.typescript-generator"
id "dev.petuska.npm.publish"
}
npmPublish {
registries {
register("npmjs") {
uri.set(uri("http://privatenpm/"))
authToken.set("obfuscated")
}
}
}

this thing compiles succesfully

but a subproject that has

plugins {
id 'myPlugin'
}

when i run tasks on it i dont have the tasks listed and of course when i run
./gradlew -p subProject publishJsPackageToNpmjsRegistry
i get
'Task 'publishJsPackageToNpmjsRegistry' not found in project'

Sorry if its way 2 detailed...
i gave all those details just in case my plugin within plugin will be the cause of my issues

thanks in advance

[mpetuska]

Well you only declared a registry so far. So you told the plugin where to publish, but not what to publish. You need to declare a package too and attach all the files you'd like to publish via its files{} api. The reason it's optional for kotlin js projects is that the plugin autoconfigures a package for each of your kotlin.js target.

[mpetuska]

See here https://npm-publish.petuska.dev/3.1/user-guide/quick-start/#__codelineno-2-7

"Standalone" tab is what applies to you.

[sharongur]

ahhh now i understand....

so i added the needed configuration, but the rest i need generated.

i made the gradle compile but still i cant see the relevant tasks

npmPublish {
packages {
version.set("4.20.69")
files {
from("build/typescript-generator")
}
}
registries {
register("npmjs") {
uri.set(uri("http:/companynexus/"))
authToken.set("obfuscated")
}
}
}

this is basically all the info i have...

i didnt understand this step:

During the package assembly, a package.json file is generated from various configuration options.

i simply have a .ts file i want to publish, i dont have a package.json, can the plugin generate it for me?
do i have to configure the assemble and pack tasks first? then run them before the publish?

[mpetuska]

You're almost there. However you need to register a package (just like you did with registry) and cofigure it inside there. Key options you'll need to touch are files{}, version main and moduleName

[sharongur]

I have the tasks! i simply forgot the put the register("js")!
now its looking like

npmPublish {
packages {
register("js") {
version.set("4.20.69")
files {
from("build/typescript-generator")
}
}
}
registries {
register("npmjs") {
uri.set(uri("http:/companynexus"))
authToken.set("obfuscated")
}
}
}

and now im looking here
https://npm-publish.petuska.dev/3.1/user-guide/configuration/package/
and i see files{}(which i already configured)
version (already configured)
main - i dont have an entry point, these are just bundle of files and not a working app, some sort of library and also dynamic i will not know the file names only the directory
and i dont see moduleName - maybe you mean packageName? i dont care about it i dont mind the defualt you stated in the docs

and regardless of that - when i run the task it complains about diffrerent values

• In plugin 'dev.petuska.npm.publish' type 'dev.petuska.npm.publish.task.NpmPublishTask' property 'node' doesn't have a configured value.
  Reason: This property isn't marked as optional and no value has been configured.

• In plugin 'dev.petuska.npm.publish' type 'dev.petuska.npm.publish.task.NpmPublishTask' property 'nodeHome' doesn't have a configured value.
  Reason: This property isn't marked as optional and no value has been configured.

[sharongur]

ooohhh i have to run the assemble and pack tasks first?

and theres no default for the pack task so i have to manually register it and put the sourcepackagedir!

i will try it and update here

[mpetuska]

Ok, few things left. packageName is indeed what I meant with moduleName and it's required otherwise you won't be able to install the package later.
As for your node errors, since you don't use kotlin plugin (which provides bundled nodejs) you need to declare your node home path yourself in top level npmPublish block. Alternatively, you could set NODE_HOME environment variable.

As for making sure your package files are built and ready for assembly, I recommend just adding whatever task is generating those files as a dependency to your package's assembly task.

[mpetuska]

Is your project oss btw? I'm happy to have a look and raise a PR for you with optimal config.

[sharongur]

no unfortunately its not, but im super close and i really really appreciate your help!

edit: never mind it was the dry option! i manage to pack it! now im checking the actual publish!

[mpetuska]

Can you try this config instead? Hopefully it will make more sense with a specific example.

tasks {
  // This is just a stub to imitate your ts generation task
  register("generateJsFile") {
    val outDir = buildDir.resolve("genJs")
    // Note that it declares outputs
    outputs.dir(outDir)
    doFirst {
      outDir.mkdirs()
      buildDir.resolve("genJs/custom.js").writeText("console.log('hello world')")
    }
  }
}

npmPublish {
  nodeHome.set(File("${System.getProperty("user.home")}/.gradle/nodejs/node-v16.13.0-linux-x64/"))
  packages {
    register("myPrivatePackage") {
      version.set("4.20.69")
      packageName.set("my-private-package")
      files {
        // Since the task declares outputs, we can just source directly from it
        // Additionally, it will also add it as a dependency to relevant npm-publish tasks automatically
        from(tasks.named("generateJsFile"))
      }
    }
  }
  registries {
    register("nexus") {
      uri.set(uri("http://companynexus"))
      authToken.set("obfuscated")
    }
  }
}

[sharongur]

i tired your suggestion but it didnt work, i will share my current working configuration:

plugins {
id "cz.habarta.typescript-generator"
id "dev.petuska.npm.publish"
}
tasks.register("packJsPackageExtension", dev.petuska.npm.publish.task.NpmPackTask.class) {
packageDir.set(layout.projectDirectory.dir("build/packages/js"))
dry.set(false)
}
npmPublish {
nodeHome.set(layout.projectDirectory.dir('/usr/'))
packages {
register("js") {
version.set("4.20.69")
packageName.set("coolio")
files {
from("build/packages")
}
}
}
registries {
register("npmjs") {
uri.set(uri("http://companynexus))
}
}
}

im just waiting for my dev ops guy to send me the actual authkey

once ill upload the first package i will try and beautify everything and adjust farther to my needs, i need to assemble and pack from multiple subprojects into one package and only then upload it.

and in the end i want to depend the java project publish to those tasks so every publish the js files will also be published

[mpetuska]

Here you go, apologies for the delay.

[sharongur]

Hey! been able to look into it only today!

It looks good! thank you! i will now work on converting it to my real project

Thanks alot!

[sharongur]

hey my friend!
how you doing? hoping all is well

i have a small question

is there a way to dynamically determine the from() section in files{}?

npmPublish {
nodeHome.set(tasks.nodeSetup.flatMap { it.nodeDir })
packages {
register("js") {
version.set("0.0.1")
packageName.set("coolio")
files {
from(tasks.getByPath(":GradlePluginTestModule:generateTypeScript"))
from(tasks.getByPath(":GradlePluginTest:generateTypeScript"))
}
}
}
}

instead of listing all the projects, is there a way to dynamically iterate through all the subprojects that have our plugin?

something like

subprojects.findAll { subproject -> subproject.plugins.hasPlugin('generateTypeScript') }

i just dont know how to integrate it with the files{} code block

[mpetuska]

I'm not sure. Best ask that in gradle forums.

[sushant-dev01]

@sharongur how did you set nodeHome? I can make it work on windows machine