prettier

Author: Ouziel

.github/workflows/test.yml

@@ -2,9 +2,9 @@ name: Tests
 
 on:
   push:
-    branches: ["**"]
+    branches: ['**']
   pull_request:
-    branches: ["**"]
+    branches: ['**']
 
 jobs:
   test:
@@ -22,11 +22,14 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
-          cache: "npm"
+          cache: 'npm'
 
       - name: Install dependencies
         run: npm ci
 
+      - name: Check formatting
+        run: npm run format:check
+
       - name: Run tests
         run: npm test
 
@@ -42,4 +45,3 @@ jobs:
           name: codecov-umbrella
           fail_ci_if_error: true
           verbose: true
-

.husky/_/pre-push

@@ -0,0 +1,13 @@
+#!/bin/sh
+# Generated via simple-git-hooks (run `npm install` or `npx simple-git-hooks` to enable locally)
+
+if [ "$SKIP_SIMPLE_GIT_HOOKS" = "1" ]; then
+    echo "[INFO] SKIP_SIMPLE_GIT_HOOKS is set to 1, skipping hook."
+    exit 0
+fi
+
+if [ -f "$SIMPLE_GIT_HOOKS_RC" ]; then
+    . "$SIMPLE_GIT_HOOKS_RC"
+fi
+
+npm run format:check

.husky/pre-push

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+echo "Checking code format with Prettier..."
+npm run format:check
+

.prettierignore

@@ -0,0 +1,4 @@
+dist
+coverage
+node_modules
+

.prettierrc.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc.json",
+  "singleQuote": true,
+  "semi": true,
+  "trailingComma": "all",
+  "printWidth": 100
+}

README.md

@@ -155,6 +155,7 @@ See [tests/README.md](./tests/README.md) for detailed test documentation.
 ### OP_RETURN Format
 
 Counterparty OP_RETURN messages are:
+
 1. Encrypted with RC4 using the first input's transaction ID as the key
 2. Prefixed with "CNTRPRTY" (8 bytes)
 3. Followed by message type ID (1 or 4 bytes)
@@ -163,6 +164,7 @@ Counterparty OP_RETURN messages are:
 ### Taproot Format
 
 Taproot reveal transactions use witness scripts with envelope patterns:
+
 - Generic envelope: `OP_FALSE OP_IF <data chunks> OP_ENDIF`
 - Ord/XCP envelope: `OP_FALSE OP_IF "ord" "xcp" <metadata> <content> OP_ENDIF`
 
@@ -180,4 +182,3 @@ MIT
 - [Counterparty Protocol](https://counterparty.io/)
 - [GitHub Repository](https://github.com/CounterpartyXCP/TxParser)
 - [Issue Tracker](https://github.com/CounterpartyXCP/TxParser/issues)
-

package-lock.json

@@ -10,7 +10,9 @@
     "test": "vitest run",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage",
-    "prepare": "npm run build",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "prepare": "npm run build && npx simple-git-hooks",
     "prepublishOnly": "npm run build"
   },
   "keywords": [
@@ -42,12 +44,17 @@
     "@types/node": "^20",
     "@vitest/coverage-v8": "^4.0.5",
     "bitcoinjs-lib": "^7.0.0-rc.0",
+    "simple-git-hooks": "^2.10.0",
+    "prettier": "^3.3.3",
     "typescript": "^5",
     "vitest": "^4.0.5"
   },
   "files": [
     "dist",
     "README.md",
     "LICENSE"
-  ]
+  ],
+  "simple-git-hooks": {
+    "pre-push": "npm run format:check"
+  }
 }

package.json

@@ -32,4 +32,3 @@ export const MESSAGE_TYPES: Record<number, string> = {
   102: 'detach',
   110: 'destroy',
 };
-

src/constants.ts

@@ -1,6 +1,6 @@
 /**
  * Counterparty Transaction Parser
- * 
+ *
  * This module provides utilities for parsing Counterparty protocol transactions
  * from both OP_RETURN and Taproot reveal formats.
  */
@@ -32,4 +32,3 @@ export type {
   TaprootCommitPayload,
   UnknownPayload,
 } from './types';
-