Merge branch 'main' of github.com:formkit/jsonreader

andrew-boyd · andrew-boyd · commit cdee4fb47043 · 2025-03-14T12:36:16.000-04:00
# Conflicts:
#	packages/docs/package.json
#	packages/docs/pages/docs/api-reference.vue
#	packages/docs/pages/docs/examples.vue
#	packages/docs/pages/docs/getting-started.vue
#	packages/docs/pages/index.vue
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -41,11 +41,5 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
-      - name: Run linting
-        run: pnpm lint
-
-      - name: Run type checking
-        run: pnpm --filter jsonreader typecheck
-
       - name: Run tests
         run: pnpm test 
diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 # jsonreader monorepo
 
-This is a monorepo for the `jsonreader` package and its documentation site.
+[![Tests](https://github.com/formkit/jsonreader/actions/workflows/tests.yml/badge.svg)](https://github.com/formkit/jsonreader/actions/workflows/tests.yml)
+
+This is a monorepo for the `@formkit/jsonreader` package and its documentation site.
 
 ## About jsonreader
 
-`jsonreader` is a specialized utility for processing JSON data from streams in real-time. Unlike traditional JSON parsers that require the entire payload before processing, `jsonreader` allows you to:
+`@formkit/jsonreader` is a specialized utility for processing JSON data from streams in real-time. Unlike traditional JSON parsers that require the entire payload before processing, `@formkit/jsonreader` allows you to:
 
 - Process JSON progressively as it arrives from a stream
 - Extract specific properties as soon as they become available
@@ -35,7 +37,7 @@ Each commercial project requires a separate license. See the [documentation](htt
 ## Quick Start
 
 ```typescript
-import { jsonReader, jsonPathReader } from 'jsonreader';
+import { jsonReader, jsonPathReader } from '@formkit/jsonreader';
 
 // Get a stream reader (e.g. from fetch API)
 const response = await fetch('https://api.example.com/large-data.json');
diff --git a/package.json b/package.json
@@ -1,14 +1,15 @@
 {
   "name": "jsonreader-monorepo",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "private": true,
-  "description": "A monorepo for the jsonreader package and its documentation",
+  "description": "A monorepo for the @formkit/jsonreader package and its documentation",
   "scripts": {
     "build": "pnpm -r build",
     "dev:docs": "pnpm --filter docs dev",
-    "dev:jsonreader": "pnpm --filter jsonreader dev",
+    "dev:jsonreader": "pnpm --filter @formkit/jsonreader dev",
     "test": "pnpm -r test",
-    "lint": "pnpm -r lint"
+    "lint": "pnpm -r lint",
+    "release": "pnpm build && bumpp -r && cd packages/jsonreader && pnpm publish"
   },
   "keywords": [
     "json",
@@ -26,6 +27,7 @@
   "devDependencies": {
     "@tailwindcss/typography": "^0.5.16",
     "autoprefixer": "^10.4.21",
+    "bumpp": "^10.1.0",
     "postcss": "^8.5.3",
     "shikiji": "^0.10.2",
     "tailwindcss": "^3.4.11"
diff --git a/packages/docs/components/DocFooter.vue b/packages/docs/components/DocFooter.vue
@@ -49,7 +49,7 @@
             </li>
             <li>
               <a
-                href="https://www.npmjs.com/package/jsonreader"
+                href="https://www.npmjs.com/package/@formkit/jsonreader"
                 target="_blank"
                 class="text-gray-600 hover:text-accent-1 transition-colors"
                 >npm Package</a
@@ -60,7 +60,7 @@
         <div class="fade-in">
           <h3 class="text-xl font-bold text-black mb-6">About</h3>
           <p class="text-gray-600 mb-6">
-            jsonreader is a utility for processing JSON data from streams in
+            @formkit/jsonreader is a utility for processing JSON data from streams in
             real-time, optimized for AI tool calls and large API responses.
           </p>
           <div class="flex items-center space-x-4">
diff --git a/packages/docs/pages/docs/api-reference.vue b/packages/docs/pages/docs/api-reference.vue
@@ -14,7 +14,7 @@
 
         <CodeBlock
           language="javascript"
-          code="import { jsonReader } from 'jsonreader';
+          code="import { jsonReader } from '@formkit/jsonreader';
 
 for await (const partialData of jsonReader(reader)) {
   // Process the partial data
@@ -157,7 +157,7 @@ for await (const partialData of jsonReader(reader)) {
 
         <CodeBlock
           language="javascript"
-          code="import { jsonReader } from 'jsonreader';
+          code="import { jsonReader } from '@formkit/jsonreader';
 
 for await (const partialData of jsonReader(reader, {
   // Only yield when these properties are present
@@ -190,7 +190,7 @@ for await (const partialData of jsonReader(reader, {
 
         <CodeBlock
           language="javascript"
-          code="import { jsonPathReader } from 'jsonreader';
+          code="import { jsonPathReader } from '@formkit/jsonreader';
 
 const reader = response.body.getReader();
 const paths = [
@@ -348,7 +348,7 @@ for await (const [value, path] of jsonPathReader(reader, paths)) {
 
         <CodeBlock
           language="javascript"
-          code="import { jsonPathReader } from 'jsonreader';
+          code="import { jsonPathReader } from '@formkit/jsonreader';
 
 async function searchWithRealtimeResults() {
   const response = await fetch('https://api.search-service.com/search?q=jsonreader');
diff --git a/packages/docs/pages/docs/examples.vue b/packages/docs/pages/docs/examples.vue
@@ -49,7 +49,7 @@
 
         <CodeBlock
           language="javascript"
-          code="import { jsonReader } from 'jsonreader';
+          code="import { jsonReader } from '@formkit/jsonreader';
 
 async function processAIFunctionCall() {
   // Call an AI model with function calling enabled
@@ -128,7 +128,7 @@ async function processAIFunctionCall() {
 
         <CodeBlock
           language="javascript"
-          code="import { jsonPathReader } from 'jsonreader';
+          code="import { jsonPathReader } from '@formkit/jsonreader';
 
 async function progressiveProfileLoader() {
   const response = await fetch('/api/user/profile');
@@ -192,7 +192,7 @@ async function progressiveProfileLoader() {
         <CodeBlock
           language="javascript"
           code="import { createReadStream } from 'fs';
-import { jsonReader } from 'jsonreader';
+import { jsonReader } from '@formkit/jsonreader';
 
 async function processLargeJsonFile(filePath) {
   // Create a file stream
diff --git a/packages/docs/pages/docs/getting-started.vue b/packages/docs/pages/docs/getting-started.vue
@@ -100,7 +100,7 @@ pnpm add jsonreader"
 
       <CodeBlock
         language="javascript"
-        code="import { jsonReader } from 'jsonreader';
+        code="import { jsonReader } from '@formkit/jsonreader';
 
 async function processStreamingData() {
   // Get a stream from somewhere (e.g., fetch API)
@@ -135,7 +135,7 @@ async function processStreamingData() {
 
       <CodeBlock
         language="javascript"
-        code="import { jsonReader } from 'jsonreader';
+        code="import { jsonReader } from '@formkit/jsonreader';
 
 async function processToolResults() {
   const response = await fetch('https://api.ai-service.com/v1/generate');
@@ -170,7 +170,7 @@ async function processToolResults() {
 
       <CodeBlock
         language="javascript"
-        code="import { jsonPathReader } from 'jsonreader';
+        code="import { jsonPathReader } from '@formkit/jsonreader';
 
 // Define paths to extract
 const paths = [
diff --git a/packages/docs/pages/index.vue b/packages/docs/pages/index.vue
@@ -63,7 +63,7 @@
           <!-- Simple Code Example -->
           <CodeBlock
             language="javascript"
-            code="import { jsonReader } from 'jsonreader';
+            code="import { jsonReader } from '@formkit/jsonreader';
 
 // Get a reader from a streaming response
 const reader = response.body.getReader();
@@ -516,7 +516,7 @@ pnpm add jsonreader"
 
         <CodeBlock
           language="javascript"
-          code="import { jsonReader } from 'jsonreader';
+          code="import { jsonReader } from '@formkit/jsonreader';
 
 async function processStreamingData() {
   // Get a stream from somewhere (e.g., fetch API)
@@ -596,7 +596,7 @@ async function processStreamingData() {
 
         <CodeBlock
           language="javascript"
-          code="import { jsonReader } from 'jsonreader';
+          code="import { jsonReader } from '@formkit/jsonreader';
 
 for await (const data of jsonReader(reader, {
   // Won't yield anything until 'metadata' is complete
@@ -635,7 +635,7 @@ for await (const data of jsonReader(reader, {
 
         <CodeBlock
           language="javascript"
-          code="import { jsonPathReader } from 'jsonreader';
+          code="import { jsonPathReader } from '@formkit/jsonreader';
 
 for await (const [value, path] of jsonPathReader(reader, [
   'results',
diff --git a/packages/jsonreader/README.md b/packages/jsonreader/README.md
@@ -1,4 +1,6 @@
-# jsonreader
+# @formkit/jsonreader
+
+[![Tests](https://github.com/formkit/jsonreader/actions/workflows/tests.yml/badge.svg)](https://github.com/formkit/jsonreader/actions/workflows/tests.yml)
 
 A lightweight utility for reading and parsing JSON from streams in real-time, yielding progressively updated results as data arrives.
 
@@ -23,19 +25,19 @@ Each commercial project requires a separate license. See the [documentation](htt
 
 ```bash
 # npm
-npm install jsonreader
+npm install @formkit/jsonreader
 
 # yarn
-yarn add jsonreader
+yarn add @formkit/jsonreader
 
 # pnpm
-pnpm add jsonreader
+pnpm add @formkit/jsonreader
 ```
 
 ## Basic Usage
 
 ```typescript
-import { jsonReader } from 'jsonreader';
+import { jsonReader } from '@formkit/jsonreader';
 
 // Example with a fetch request
 const response = await fetch('https://api.example.com/large-data.json');
@@ -56,7 +58,7 @@ for await (const partialData of jsonReader(reader)) {
 ### Getting Specific Properties as Soon as They're Available
 
 ```typescript
-import { jsonPathReader } from 'jsonreader';
+import { jsonPathReader } from '@formkit/jsonreader';
 
 const response = await fetch('https://api.example.com/large-data.json');
 if (!response.body) throw new Error('No response body');
@@ -80,7 +82,7 @@ for await (const [value, path] of jsonPathReader(reader, paths)) {
 ### Controlling When Data is Yielded
 
 ```typescript
-import { jsonReader } from 'jsonreader';
+import { jsonReader } from '@formkit/jsonreader';
 
 const response = await fetch('https://api.example.com/large-data.json');
 if (!response.body) throw new Error('No response body');
@@ -152,7 +154,7 @@ Paths use dot notation to refer to nested properties:
 ## Example: Real-time UI Updates During File Upload
 
 ```typescript
-import { jsonPathReader } from 'jsonreader';
+import { jsonPathReader } from '@formkit/jsonreader';
 
 async function processFileUpload(fileUploadResponse) {
   const reader = fileUploadResponse.body.getReader();
@@ -184,7 +186,7 @@ async function processFileUpload(fileUploadResponse) {
 
 ## How It Works
 
-The `jsonreader` utility parses JSON data character by character as it arrives from a stream. It builds up a syntactically valid JSON structure as data comes in, closing any unclosed objects or arrays to create valid partial representations.
+The `@formkit/jsonreader` utility parses JSON data character by character as it arrives from a stream. It builds up a syntactically valid JSON structure as data comes in, closing any unclosed objects or arrays to create valid partial representations.
 
 For each chunk of data received:
 
diff --git a/packages/jsonreader/examples/README.md b/packages/jsonreader/examples/README.md
@@ -1,6 +1,8 @@
-# jsonreader Examples
+# @formkit/jsonreader Examples
 
-This directory contains examples demonstrating how to use the `jsonreader` package for streaming JSON processing.
+[![Tests](https://github.com/formkit/jsonreader/actions/workflows/tests.yml/badge.svg)](https://github.com/formkit/jsonreader/actions/workflows/tests.yml)
+
+This directory contains examples demonstrating how to use the `@formkit/jsonreader` package for streaming JSON processing.
 
 ## Running the Examples
 
@@ -30,7 +32,7 @@ node examples/basic-usage.js
 ## Available Examples
 
 1. **Basic Usage** (`basic-usage.ts`)
-   - Demonstrates the fundamental usage patterns of jsonreader
+   - Demonstrates the fundamental usage patterns of @formkit/jsonreader
    - Shows how to use `jsonReader` with fetch API
    - Shows how to use `jsonPathReader` to extract specific paths
    - Shows how to use options to control when data is yielded
@@ -43,7 +45,7 @@ node examples/basic-usage.js
 
 ## Example Code Structure
 
-Each example file is structured to demonstrate specific features of the `jsonreader` package:
+Each example file is structured to demonstrate specific features of the `@formkit/jsonreader` package:
 
 - **Import**: Import the necessary functions from the package
 - **Setup**: Create a ReadableStream or obtain one from an API
diff --git a/packages/jsonreader/package.json b/packages/jsonreader/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "jsonreader",
-  "version": "0.1.0",
+  "name": "@formkit/jsonreader",
+  "version": "1.0.1",
   "description": "A utility for reading and parsing JSON streams in real-time",
   "type": "module",
   "main": "dist/index.js",
@@ -37,16 +37,16 @@
     "progressive",
     "esm"
   ],
-  "author": "",
+  "author": "Justin Schroeder <justin@formkit.com>",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/username/jsonreader.git"
+    "url": "git+https://github.com/formkit/jsonreader.git"
   },
   "bugs": {
-    "url": "https://github.com/username/jsonreader/issues"
+    "url": "https://github.com/formkit/jsonreader/issues"
   },
-  "homepage": "https://github.com/username/jsonreader#readme",
+  "homepage": "https://github.com/formkit/jsonreader#readme",
   "engines": {
     "node": ">=18.0.0"
   },
@@ -60,6 +60,6 @@
     "eslint": "^8.55.0",
     "typescript": "^5.3.2",
     "tsup": "^8.0.1",
-    "vitest": "^1.0.1"
+    "vitest": "^3.0.8"
   }
 } 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
