Packaging

Author: schani

.github/workflows/publish.yml

@@ -0,0 +1,50 @@
+name: Publish Package to NPM
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Use Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '18.x'
+        registry-url: 'https://registry.npmjs.org'
+        cache: 'npm'
+    
+    - name: Install dependencies
+      run: npm ci
+    
+    - name: Verify package version matches release tag
+      run: |
+        PKG_VERSION=$(node -p "require('./package.json').version")
+        GITHUB_REF_NAME=${GITHUB_REF#refs/tags/}
+        GITHUB_TAG=${GITHUB_REF_NAME#v}
+        echo "Package version: $PKG_VERSION"
+        echo "GitHub tag (without v): $GITHUB_TAG"
+        if [ "$PKG_VERSION" != "$GITHUB_TAG" ] && [ "$PKG_VERSION" != "${GITHUB_TAG#v}" ]; then
+          echo "⚠️ WARNING: GitHub release tag ($GITHUB_REF_NAME) doesn't match package.json version ($PKG_VERSION)"
+          echo "The package will be published with the version from package.json: $PKG_VERSION"
+        fi
+    
+    - name: Build
+      run: npm run build
+    
+    - name: Test
+      run: npm test
+      
+    - name: Verify dual module compatibility
+      run: |
+        node -e "require('./dist/index.js')" # Test CJS
+        node --input-type=module -e "import * as mod from './dist/index.mjs'; console.log(typeof mod.convertJsonSchemaToZod === 'function')" # Test ESM
+    
+    - name: Publish to NPM
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

CHANGELOG.md

@@ -0,0 +1,20 @@
+# 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).
+
+## [Unreleased]
+
+### Added
+- Initial implementation of JSON Schema to Zod conversion
+- Support for basic types (string, number, integer, boolean, null, object, array)
+- String validations (minLength, maxLength, pattern)
+- Number validations (minimum, maximum, exclusiveMinimum, exclusiveMaximum, multipleOf)
+- Array validations (minItems, maxItems, uniqueItems)
+- Object validations (required properties, additionalProperties)
+- Schema composition (const, enum, anyOf, allOf, oneOf)
+- Dual module support (CommonJS and ESM)
+- GitHub Actions CI workflow
+- GitHub Actions publish workflow

CLAUDE.md

@@ -0,0 +1,22 @@
+# zod-from-json-schema Development Guidelines
+
+## Commands
+- **Build:** `npm run build` (generates CJS and ESM outputs)
+- **Test all:** `npm test`
+- **Test single file:** `npx vitest run src/path/to/file.test.ts`
+- **Test with pattern:** `npx vitest run -t "test pattern"`
+- **Clean:** `npm run clean` (removes dist directory)
+
+## Code Style
+- **TypeScript:** Use strict types, avoid `any` except in JSON Schema interfaces
+- **Imports:** Use named imports from zod (`import { z } from "zod"`)
+- **Formatting:** 4-space indentation, avoid lines > 80 chars
+- **Naming:** Use camelCase for functions/variables, PascalCase for types/interfaces
+- **Error handling:** Use Zod's built-in validation or custom refinements
+- **Comments:** Document functions with JSDoc comments including params, return types
+- **Compatibility:** Keep dual-module support (CJS/ESM) for all exported functions
+
+## Architecture
+- Functions should be pure with no side effects
+- Keep JSON Schema to Zod conversion logic separate from utility functions
+- Write tests for each supported feature and edge case

README.md

@@ -76,10 +76,15 @@ const jsonSchema = {
 const zodSchema = convertJsonSchemaToZod(jsonSchema);
 
 // Use the Zod schema to validate data
-const validData = zodSchema.parse({
-  name: "John Doe",
-  age: 30
-});
+try {
+  const validData = zodSchema.parse({
+    name: "John Doe",
+    age: 30
+  });
+  console.log("Valid data:", validData);
+} catch (error) {
+  console.error("Validation error:", error);
+}
 ```
 
 ## Supported JSON Schema Features

RELEASE.md

@@ -0,0 +1,42 @@
+# Release Process for zod-from-json-schema
+
+This document outlines the steps to create a new release of the package.
+
+## Release Steps
+
+1. **Update package version in package.json**:
+   ```bash
+   # From the project root directory
+   npm version patch   # For a bug fix (0.0.x)
+   npm version minor   # For new features (0.x.0)
+   npm version major   # For breaking changes (x.0.0)
+   ```
+   This will automatically:
+   - Update the version in package.json
+   - Create a git commit with that change
+   - Create a git tag for the version
+
+2. **Push the changes and tag**:
+   ```bash
+   git push origin main --tags
+   ```
+
+3. **Create a GitHub Release**:
+   - Go to the "Releases" section of your GitHub repository
+   - Click "Draft a new release"
+   - Select the tag you just pushed (should match the version in package.json)
+   - Add a title and description for the release
+   - Click "Publish release"
+
+4. **Monitor the GitHub Actions workflow**:
+   - The publish workflow will trigger automatically when the release is created
+   - It will verify that the package version matches the release tag
+   - It will build, test, and publish the package to npm
+   - You can monitor progress in the "Actions" tab of your GitHub repository
+
+## Important Notes
+
+- The version in package.json determines what version is published to npm
+- The GitHub release tag should match the version in package.json (with or without a leading 'v')
+- If there is a mismatch, the workflow will warn you but will still publish using the version in package.json
+- Make sure to update the CHANGELOG.md file before creating a release