update for npm

Author: gitdog01

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - YYYY-MM-DD
+
+### Added
+
+- Initial release of the `go-prettier-format` plugin.
+- Formats Go code using `go/format` compiled to WebAssembly.
+- Support for both CJS and ESM environments.
+- CLI and editor integration support. 

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing to go-prettier-format
+
+First off, thank you for considering contributing! Your help is appreciated.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+If you find a bug, please make sure to include the following:
+- A clear and descriptive title.
+- Steps to reproduce the bug.
+- The expected behavior and what happened instead.
+- Your environment details (Node.js version, OS, etc.).
+
+Please check the existing issues to see if a similar bug has already been reported.
+
+### Suggesting Enhancements
+
+If you have an idea for a new feature or an improvement, feel free to open an issue to discuss it. This lets us coordinate our efforts and prevent duplication of work.
+
+### Pull Requests
+
+We welcome pull requests! For major changes, please open an issue first to discuss what you would like to change.
+
+When submitting a pull request, please make sure to:
+- Update the `README.md` if any user-facing changes were made.
+- Ensure the tests pass (`npm test`).
+- Follow the existing code style.
+
+## Development Setup
+
+To get your development environment set up, please follow these steps. You will need to have Go installed to build the WebAssembly module.
+
+1.  **Clone the repository:**
+    ```bash
+    git clone https://github.com/gitdog01/go-prettier-format.git
+    cd go-prettier-format
+    ```
+
+2.  **Install dependencies:**
+    ```bash
+    npm install
+    ```
+
+3.  **Build the project:**
+    The project needs to be built before you can test your changes. This includes compiling the Go source to WASM and bundling the JavaScript.
+    ```bash
+    npm run build
+    ```
+
+4.  **Run tests:**
+    To make sure everything is working correctly, run the test suite:
+    ```bash
+    npm test
+    ``` 

README.md

@@ -1,6 +1,9 @@
 # Prettier Plugin for Go (using WASM)
 
-This is a Prettier plugin for the Go programming language. It formats Go code using the official `go/format` package, which is compiled to WebAssembly (WASM) to run in a Node.js environment.
+[![npm version](https://img.shields.io/npm/v/go-prettier-format.svg)](https://www.npmjs.com/package/go-prettier-format)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+This is a [Prettier](https://prettier.io/) v3 plugin for the Go programming language. It formats Go code using the official `go/format` package, which is compiled to WebAssembly (WASM) to run in a Node.js environment.
 
 ## Background
 
@@ -10,7 +13,7 @@ This project was born out of the desire to have a single, unified formatting too
 
 ## Installation
 
-First, install Prettier and this plugin from NPM:
+First, install Prettier (v3 or later) and this plugin from NPM:
 
 ```bash
 npm install --save-dev prettier go-prettier-format
@@ -32,14 +35,16 @@ npx prettier --write your-file.go
 npx prettier --write "**/*.go"
 ```
 
+> Note: For cross-platform compatibility in npm scripts, it's recommended to use single quotes: `'**/*.go'`.
+
 ### package.json Script
 
 For convenience, you can add a script to your `package.json`:
 
 ```json
 {
   "scripts": {
-    "format": "prettier --write \"**/*.go\""
+    "format": "prettier --write '**/*.go'"
   }
 }
 ```
@@ -79,6 +84,7 @@ npm test
 ```
 
 This command will:
+- Build the latest version of the plugin from source.
 - Create a `test_result` directory.
 - Copy the sample files from the `tests/` directory into it.
 - Run the Prettier formatter on the files inside `test_result/`.
@@ -89,11 +95,12 @@ You can then compare the original files in `tests/` with the formatted files in
 
 ## Publishing to NPM
 
-To publish a new version to NPM:
+This package is configured to build automatically before publishing.
+
+1.  Update the version number in `package.json` using `npm version <patch|minor|major>`.
+2.  Run `npm publish`.
 
-1.  Build the latest WASM binary: `npm run build:wasm`.
-2.  Update the version number in `package.json`.
-3.  Run `npm publish`.
+The `prepublishOnly` script will handle building the Wasm and JavaScript bundles before the package is uploaded to the registry.
 
 ## How it Works