https://github.com/chrimaeon/gradle-npm-versions

Gradle plugin for checking your Kotlin/JS NPM package versions.
https://github.com/chrimaeon/gradle-npm-versions

gradle gradle-plugin kotlin kotlin-multiplatform kotlinjs npm versioning

Last synced: 19 days ago
JSON representation

Gradle plugin for checking your Kotlin/JS NPM package versions.

• Host: GitHub
• URL: https://github.com/chrimaeon/gradle-npm-versions
• Owner: chrimaeon
• License: apache-2.0
• Created: 2024-04-20T18:38:28.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2025-01-12T11:34:15.000Z (24 days ago)
• Last Synced: 2025-01-12T12:30:41.485Z (24 days ago)
• Topics: gradle, gradle-plugin, kotlin, kotlin-multiplatform, kotlinjs, npm, versioning
• Language: Kotlin
• Homepage:
• Size: 263 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gradle Licenses Plugin [![Build & Test](https://github.com/chrimaeon/gradle-npm-versions/actions/workflows/main.yml/badge.svg)](https://github.com/chrimaeon/gradle-npm-versions/actions/workflows/main.yml)

[![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg?style=for-the-badge)](http://www.apache.org/licenses/LICENSE-2.0)

[![Gradle Plugin](https://img.shields.io/badge/Gradle-8.0%2B-%2302303A.svg?style=for-the-badge&logo=Gradle)](https://gradle.org/)

[![gradlePluginPortal](https://img.shields.io/gradle-plugin-portal/v/com.cmgapps.npm.versions?label=Gradle%20Plugin%20Portal&style=for-the-badge&logo=Gradle)](https://plugins.gradle.org/plugin/com.cmgapps.licenses)

This Gradle plugin provides a task to check NPM package version for

your [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) project.

## Usage

### Integration

#### Using the plugins DSL

Kotlin

```kotlin

plugins {

    id("com.cmgapps.npm.versions") version "0.4.1"

}

```

Groovy

```groovy

plugins {

    id 'com.cmgapps.npm.versions' version '0.4.1'

}

```

#### Using legacy plugin application

Kotlin

```kotlin

buildscript {

    repositories {

        maven {

            url = uri("https://plugins.gradle.org/m2/")

        }

    }

    dependencies {

        classpath("com.cmgapps.gradle:gradle-npm-versions-plugin:0.4.1")

    }

}

apply(plugin = "com.cmgapps.npm.versions")

```

Groovy

```groovy

buildscript {

    repositories {

        maven {

            url 'https://plugins.gradle.org/m2/'

        }

    }

    dependencies {

        classpath 'com.cmgapps.gradle:gradle-npm-versions-plugin:0.4.1'

    }

}

apply plugin: 'com.cmgapps.npm.versions'

```

### Task

Applying the plugin will create tasks to check for NPM Package Version

* `npmVersions`

This will check the [NPM](https://www.npmjs.com/) Registry for the latest version available for

your `npm` dependencies.

### Configuration

With the [npmVersions](./src/main/kotlin/com/cmgapps/gradle/NpmVersionsExtension.kt) extension you can enable the file reporters and output file location.

There are 4 reporters:

- **Plain Text**: Same format as the console output

- **JSON**: A JSON of the package versions

- **HTML**: An HTML website

- **XML**: An XML of the packages.

```gradle

npmVersions {

    plainText {

        enabled.set(true)

        outputFile.set(project.layout.buildDirectory.file("npmVersions.txt"))

    }

    json {

        enabled.set(true)

    }

    html {

        enabled.set(true)

    }

    xml {

        enabled.set(true)

    }

}

```

### Output

The console output will look like this:

```text

┌──────────────┐

│ NPM Packages │

└──────────────┘

The following packages are using the latest version:

 · bootstrap:5.3.3

The following packages have updated versions:

 · kotlin [1.0 -> 1.9.23]

```

## License

```text

Copyright (c) 2024. Christian Grach 

SPDX-License-Identifier: Apache-2.0

```