panrelease 0.14.0 → 0.15.0

package/README.md

@@ -1,20 +1,43 @@
-# Panrelease
+# Panrelease (Node.js)
 
-## Quick start
+[![npm version](https://img.shields.io/npm/v/panrelease.svg?style=flat-square)](https://www.npmjs.com/package/panrelease)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
 
-Install using npm:
+**Panrelease** is a versatile release automation tool that manages version bumping, changelog updates, and Git operations. This package provides the Node.js implementation of Panrelease, powered by WebAssembly, allowing it to run seamlessly in any Node.js environment without requiring a Rust installation.
 
-```shell
-npm i --save-dev panrelease
+## Features
+
+- **Semantic Versioning** - Automatic major, minor, patch, and post-release version bumping.
+- **Node.js Native Support** - Direct support for `package.json` and lockfiles (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`).
+- **Changelog Automation** - Updates `CHANGELOG.md` following [Keep a Changelog](https://keepachangelog.com/) format.
+- **Git Integration** - Commits version changes, creates tags, and supports GPG signing.
+- **Monorepo Friendly** - Can manage multiple modules in a single project.
+- **WebAssembly Powered** - Fast and consistent execution across different platforms.
+
+## Installation
+
+Install as a development dependency in your project:
+
+### npm
+```bash
+npm install --save-dev panrelease
 ```
 
-Or yarn:
+### yarn
+```bash
+yarn add --dev panrelease
+```
 
-```shell
-yarn add -D panrelease
+### pnpm
+```bash
+pnpm add --save-dev panrelease
 ```
 
-Write a configuration file:
+## Quick Start
+
+### 1. Configure Panrelease
+
+Create a `.panproject.toml` file in your project root:
 
 ```toml
 [vcs]
@@ -23,14 +46,44 @@ software = "Git"
 [modules.root]
 path = "."
 packageManager = "Npm"
+main = true
 ```
 
-Add custom script in your package.json
+### 2. Add a Script to package.json
 
 ```json
 {
   "scripts": {
-    "rel": "panrelease release"
+    "release": "panrelease"
   }
 }
-```
+```
+
+### 3. Run a Release
+
+```bash
+# Release a new patch version (e.g., 1.0.0 -> 1.0.1)
+npm run release -- patch
+
+# Or run directly via npx
+npx panrelease minor
+```
+
+## Commands
+
+| Command | Description | Example |
+|---------|-------------|---------|
+| `patch` | Increment patch version | `1.0.0` -> `1.0.1` |
+| `minor` | Increment minor version | `1.0.0` -> `1.1.0` |
+| `major` | Increment major version | `1.0.0` -> `2.0.0` |
+| `post`  | Create post-release (build metadata) | `1.0.0` -> `1.0.0+r1` |
+| `show`  | Show current project version | `panrelease show` |
+| `<version>` | Set explicit version | `panrelease 2.1.0` |
+
+## Documentation
+
+For full configuration options, advanced features like **hooks**, and **strict mode**, please refer to the [Main Repository Documentation](https://github.com/dghilardi/panrelease#readme).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/dghilardi/panrelease/blob/main/LICENSE) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "panrelease",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "description": "Utility to release software",
   "keywords": [
     "cli",
@@ -17,12 +17,10 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
-  "main": "index.js",
+  "main": "pkg/panrelease.js",
   "license": "MIT",
   "bin": {
     "panrelease": "bin/index.js"
   },
-  "scripts": {
-    "panrelease": "./bin/index.js"
-  }
-}
+  "scripts": {}
+}

package/pkg/panrelease.js

@@ -186,13 +186,12 @@ function debugString(val) {
     // TODO we could test for more things here, like `Set`s and `Map`s.
     return className;
 }
-
-function passArray8ToWasm0(arg, malloc) {
-    const ptr = malloc(arg.length * 1, 1) >>> 0;
-    getUint8Memory0().set(arg, ptr / 1);
-    WASM_VECTOR_LEN = arg.length;
-    return ptr;
-}
+/**
+* @param {Array<any>} js_args
+*/
+module.exports.run = function(js_args) {
+    wasm.run(addHeapObject(js_args));
+};
 
 function handleError(f, args) {
     try {
@@ -201,12 +200,13 @@ function handleError(f, args) {
         wasm.__wbindgen_exn_store(addHeapObject(e));
     }
 }
-/**
-* @param {Array<any>} js_args
-*/
-module.exports.run = function(js_args) {
-    wasm.run(addHeapObject(js_args));
-};
+
+function passArray8ToWasm0(arg, malloc) {
+    const ptr = malloc(arg.length * 1, 1) >>> 0;
+    getUint8Memory0().set(arg, ptr / 1);
+    WASM_VECTOR_LEN = arg.length;
+    return ptr;
+}
 
 const ReifyRunArgsFinalization = (typeof FinalizationRegistry === 'undefined')
     ? { register: () => {}, unregister: () => {} }
@@ -233,11 +233,15 @@ module.exports.__wbindgen_object_drop_ref = function(arg0) {
     takeObject(arg0);
 };
 
-module.exports.__wbg_writeFileSync_dfa398d60f0576e5 = function() { return handleError(function (arg0, arg1, arg2, arg3) {
-    writeFileSync(getStringFromWasm0(arg0, arg1), getStringFromWasm0(arg2, arg3));
-}, arguments) };
+module.exports.__wbg_cwd_6cc81e58cbab7b00 = function(arg0) {
+    const ret = cwd();
+    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    getInt32Memory0()[arg0 / 4 + 1] = len1;
+    getInt32Memory0()[arg0 / 4 + 0] = ptr1;
+};
 
-module.exports.__wbg_log_e9b70fc156898f33 = function(arg0, arg1) {
+module.exports.__wbg_log_c142934b4d83fb0c = function(arg0, arg1) {
     console.log(getStringFromWasm0(arg0, arg1));
 };
 
@@ -250,12 +254,16 @@ module.exports.__wbindgen_string_get = function(arg0, arg1) {
     getInt32Memory0()[arg0 / 4 + 0] = ptr1;
 };
 
+module.exports.__wbg_writeFileSync_06704cc76fb5e237 = function() { return handleError(function (arg0, arg1, arg2, arg3) {
+    writeFileSync(getStringFromWasm0(arg0, arg1), getStringFromWasm0(arg2, arg3));
+}, arguments) };
+
 module.exports.__wbindgen_error_new = function(arg0, arg1) {
     const ret = new Error(getStringFromWasm0(arg0, arg1));
     return addHeapObject(ret);
 };
 
-module.exports.__wbg_execSync_3821530c3c68494c = function() { return handleError(function (arg0, arg1, arg2, arg3) {
+module.exports.__wbg_execSync_31508369da459cc5 = function() { return handleError(function (arg0, arg1, arg2, arg3) {
     let deferred0_0;
     let deferred0_1;
     try {
@@ -271,20 +279,12 @@ module.exports.__wbg_execSync_3821530c3c68494c = function() { return handleError
     }
 }, arguments) };
 
-module.exports.__wbg_existsSync_67f2bec9d1cdcdf0 = function() { return handleError(function (arg0, arg1) {
+module.exports.__wbg_existsSync_c76d43a4bbcc6150 = function() { return handleError(function (arg0, arg1) {
     const ret = existsSync(getStringFromWasm0(arg0, arg1));
     return ret;
 }, arguments) };
 
-module.exports.__wbg_cwd_910b2c84dc4c2152 = function(arg0) {
-    const ret = cwd();
-    const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
-    const len1 = WASM_VECTOR_LEN;
-    getInt32Memory0()[arg0 / 4 + 1] = len1;
-    getInt32Memory0()[arg0 / 4 + 0] = ptr1;
-};
-
-module.exports.__wbg_readFileSync_59db60323489d25b = function() { return handleError(function (arg0, arg1, arg2, arg3, arg4) {
+module.exports.__wbg_readFileSync_09ba85d465f2bf5c = function() { return handleError(function (arg0, arg1, arg2, arg3, arg4) {
     const ret = readFileSync(getStringFromWasm0(arg1, arg2), getStringFromWasm0(arg3, arg4));
     const ptr1 = passStringToWasm0(ret, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
     const len1 = WASM_VECTOR_LEN;

package/pkg/panrelease_bg.wasm.d.ts

@@ -5,5 +5,5 @@ export function __wbg_reifyrunargs_free(a: number): void;
 export function run(a: number): void;
 export function __wbindgen_malloc(a: number, b: number): number;
 export function __wbindgen_realloc(a: number, b: number, c: number, d: number): number;
-export function __wbindgen_free(a: number, b: number, c: number): void;
 export function __wbindgen_exn_store(a: number): void;
+export function __wbindgen_free(a: number, b: number, c: number): void;