https://github.com/mpetuska/npm-publish

Gradle plugin for NPM package publishing. Allows for arbitrary publishing as well as seamless integration with Kotlin JS/MPP plugins.
https://github.com/mpetuska/npm-publish

gradle-plugin kotlin kotlin-js npm

Last synced: 1 day ago
JSON representation

Gradle plugin for NPM package publishing. Allows for arbitrary publishing as well as seamless integration with Kotlin JS/MPP plugins.

• Host: GitHub
• URL: https://github.com/mpetuska/npm-publish
• Owner: mpetuska
• License: apache-2.0
• Created: 2020-12-27T10:46:04.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-27T22:27:41.000Z (about 2 months ago)
• Last Synced: 2024-12-14T12:08:30.690Z (9 days ago)
• Topics: gradle-plugin, kotlin, kotlin-js, npm
• Language: Kotlin
• Homepage: https://npm-publish.petuska.dev
• Size: 8.5 MB
• Stars: 128
• Watchers: 3
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
[![Slack chat](https://img.shields.io/badge/kotlinlang-%23npm--publish-darkgreen?logo=slack&style=flat-square)](https://kotlinlang.slack.com/channels/npm-publish)

[![Mkdocs docs](https://img.shields.io/badge/docs-mkdocs-blue?style=flat-square&logo=kotlin&logoColor=white)](https://npm-publish.petuska.dev)

[![Version gradle-plugin-portal](https://img.shields.io/maven-metadata/v?label=gradle%20plugin%20portal&logo=gradle&metadataUrl=https%3A%2F%2Fplugins.gradle.org%2Fm2%2Fdev.petuska%2Fnpm-publish-gradle-plugin%2Fmaven-metadata.xml&style=flat-square)](https://plugins.gradle.org/plugin/dev.petuska.npm.publish)

[![Version maven-central](https://img.shields.io/maven-central/v/dev.petuska/npm-publish-gradle-plugin?logo=apache-maven&style=flat-square)](https://mvnrepository.com/artifact/dev.petuska/npm-publish-gradle-plugin/latest)

# NPM-PUBLISH GRADLE PLUGIN

> DISCLAIMER: If you still depend on the old LEGACY Kotlin/JS compiler, please stick

> with [`npm-publish:2.1.x`](https://github.com/mpetuska/npm-publish/tree/2.1.x) version.

> LEGACY backend support was dropped since `npm-publish:3.0.0`.

Gradle plugin enabling NPM publishing (essentially `maven-publish` for NPM packages). Integrates seamlessly with

Kotlin/JS/MPP plugin if applied, providing auto configurations.

> Check the latest [release](https://github.com/mpetuska/npm-publish/releases/latest) for verified JVM, Kotlin and

> Gradle tooling versions

## Setup

Here's a bare minimum setup when using together with one of the kotlin plugins. This setup would produce the following

tasks:

* `assembleJsPackage`

* `packJsPackage`

* `publishJsPackageToNpmjsRegistry`

```kotlin title="build.gradle.kts"

plugins {

    id("dev.petuska.npm.publish") version ""

    kotlin("multiplatform") version ">" // Optional, also supports "js"

}

kotlin {

    js(IR) {

        binaries.library()

        browser() // or nodejs()

    }

}

npmPublish {

    registries {

        // For registries expecting an authentiation token, use authToken

        register("npmjs") {

            uri.set("https://registry.npmjs.org")

            authToken.set("obfuscated")

        }

        

        // For registries expecting a username and password, use auth or username + password

        register("nexus") {

            uri.set("https://nexus.example.com/repository/npm-internal")

            username.set("obfuscated")

            password.set("obfuscated")

            // Or:

            // auth.set("base64-encoded-string")

        }

    }

}

```

Full documentation can be found

on [npm-publish.petuska.dev](https://npm-publish.petuska.dev/latest/user-guide/quick-start/)

## Contributing

See [CONTRIBUTING](.github/CONTRIBUTING.md)

Thanks to all the people who contributed to npm-publish!