Updated readme

irjudson · irjudson · commit 1ced0bc34bb9 · 2025-11-13T09:29:37.000-05:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -45,4 +45,3 @@ jobs:
           cache: 'npm'
       - run: npm ci
       - run: npm run format:check
-
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -121,4 +121,3 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute changes.
 - **Issues**: https://github.com/harperdb/bigquery-sync/issues
 - **Discussions**: https://github.com/harperdb/bigquery-sync/discussions
 - **Email**: opensource@harperdb.io
-
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -244,4 +244,3 @@ Contributors will be:
 - Credited in documentation for major features
 
 Thank you for contributing! 🚢
-
diff --git a/README.md b/README.md
@@ -98,6 +98,7 @@ For local development and testing:
    npm install
    ```
 4. Configure `config.yaml` with your BigQuery credentials:
+
    ```yaml
    bigquery:
      projectId: your-project
@@ -112,6 +113,7 @@ For local development and testing:
          columns: ['*']
          targetTable: BigQueryData
    ```
+
 5. Run in development mode:
    ```bash
    harper dev .
@@ -457,4 +459,3 @@ Multi-threaded, multi-instance Harper cluster support:
 **Get Started:** Deploy on [Harper Fabric](https://fabric.harper.fast) - free tier available, no credit card required.
 
 **Learn More:** [Harper Documentation](https://docs.harperdb.io) | [harperdb.io](https://harperdb.io)
-
diff --git a/bin/cli.js b/bin/cli.js
@@ -321,4 +321,3 @@ async function runMultiTableMode(command, arg, config) {
 }
 
 main();
-
diff --git a/docs/HISTORY.md b/docs/HISTORY.md
@@ -3,9 +3,11 @@
 This document reconstructs the major development milestones for this repository.
 
 ## October 28, 2025 - Initial Implementation
+
 **Commit:** 40c819f
 
 Created initial BigQuery sync plugin with core functionality:
+
 - BigQuery client with query and type conversion
 - Sync engine with modulo-based partitioning
 - Validation framework for data completeness
@@ -16,77 +18,91 @@ Created initial BigQuery sync plugin with core functionality:
 Files: Added bigquery-client.js, sync-engine.js, validation.js, resources.js, schema.graphql, config, and documentation.
 
 ## October 28-30, 2025 - Early Refinements
+
 **Commits:** 7613dd0, 5d9d09c, 08a295f, bdd7bb7, c685551, d7099c0, 7021adf
 
 Iterative improvements to initial implementation:
+
 - Configuration refinements
 - Sync engine optimizations
 - Documentation updates
 
 ## November 7, 2025 - Major Refactoring
+
 **Commit:** 6c24494
 
 Significant architecture changes and feature additions.
 
 ## November 10-12, 2025 - Multi-Table Support Development
+
 **Commits:** 65e0cc2 through 37734eea2
 
 Developed comprehensive multi-table synchronization:
+
 - Multi-table orchestrator implementation
 - Maritime data synthesizer (3-table test data generator)
 - Vessel positions, port events, and vessel metadata tables
 - Test data generation with realistic patterns
 - Multi-table validation framework
 
 ## November 12-13, 2025 - Column Selection Feature (feature/column-selection branch)
+
 **Commits:** 766372b through c20ac77e
 
 Phase 1 column selection implementation:
+
 - QueryBuilder class for SQL construction with column selection
 - Type converter module for BigQuery type mapping
 - Centralized validation in validators.js
-- Column selection config (defaults to SELECT *)
+- Column selection config (defaults to SELECT \*)
 - 60+ unit tests and integration test framework
 - Comprehensive JSDoc documentation
 
 ## November 13, 2025 - CI/CD Infrastructure (ci-mods branch)
+
 **Commits:** d867f44 through e8a32d7
 
 Added continuous integration and code quality tools:
+
 - ESLint configuration with @harperdb/code-guidelines
 - Prettier configuration and formatting
 - Husky pre-commit hooks (lint + test)
 - GitHub Actions workflow:
-  * Lint job
-  * Test job (Node 20 and 22)
-  * Format check job
+  - Lint job
+  - Test job (Node 20 and 22)
+  - Format check job
 - Fixed all lint errors and warnings
 - Auto-formatted codebase
 
 ## November 13, 2025 - CI/CD Merge to Main
+
 **Commit:** 9bfa425
 
 Merged CI/CD infrastructure into main branch.
 
 ## November 13, 2025 - Column Selection Branch Refinement
+
 **Commits:** c06a521, 2c6eb09
 
 - Merged main (CI/CD) into feature/column-selection
 - Updated tests for multi-table configuration format
 - Added comprehensive backward compatibility tests:
-  * Legacy single-table format tests
-  * Multi-table format tests
-  * 33 total tests passing
+  - Legacy single-table format tests
+  - Multi-table format tests
+  - 33 total tests passing
 
 ## November 13, 2025 - Prettier Configuration Fix
+
 **Commit:** cc841b5
 
 Added .prettierignore to exclude example YAML files with intentional duplicate keys for documentation purposes.
 
 ## November 13, 2025 - Column Selection Feature Merged
+
 **Commit:** 54f15da
 
 Merged feature/column-selection into main, completing Phase 1:
+
 - Column selection with backward compatibility
 - Multi-table support
 - Comprehensive test coverage
@@ -98,6 +114,7 @@ Merged feature/column-selection into main, completing Phase 1:
 ## Feature Status
 
 ### ✅ Implemented
+
 - Single-table BigQuery sync
 - Multi-table sync orchestration
 - Column selection
@@ -107,9 +124,9 @@ Merged feature/column-selection into main, completing Phase 1:
 - Backward compatibility (legacy single-table format)
 
 ### 🚧 Planned
+
 - Rolling window sync for multi-table orchestrator
 - Backfill capability for multi-table
 - Cleanup/retention for multi-table
 - Dynamic Harper table creation via Operations API
 - Streaming insert API option for production deployments
-
diff --git a/docs/blog-post.md b/docs/blog-post.md
@@ -467,4 +467,3 @@ See [docs/QUICKSTART.md](docs/QUICKSTART.md) for the 5-minute setup guide or [MA
 - [Design Document](#) — Full technical details
 - [GitHub Repository](#) — Complete implementation
 - [HarperDB Docs](https://docs.harperdb.io) — Platform documentation
-
diff --git a/docs/design-document.md b/docs/design-document.md
@@ -939,4 +939,3 @@ Sometimes the best distributed algorithm is no coordination at all.
 - [HarperDB Documentation](https://docs.harperdb.io)
 - [Harper Clustering Documentation](https://docs.harperdb.io/docs/developers/replication)
 - [Harper Fabric](https://fabric.harper.fast)
-
diff --git a/docs/maritime-synthesizer.md b/docs/maritime-synthesizer.md
@@ -424,4 +424,3 @@ Apache-2.0
 ---
 
 **Happy sailing!** 🌊⚓
-
diff --git a/docs/plans/2025-11-12-multi-table-tdd-design.md b/docs/plans/2025-11-12-multi-table-tdd-design.md
@@ -1186,4 +1186,3 @@ if (config.useStreamingInsert) {
 **Implementation Status:** ✅ COMPLETE
 **Production Ready:** Yes
 **Next Steps:** Monitor performance, gather feedback, plan parallel orchestrator when needed
-
diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -368,4 +368,3 @@ Press `Ctrl+C` in the terminal running the synthesizer. It will:
 - Verify config.yaml syntax (must be valid YAML)
 - Ensure BigQuery permissions are correct
 - Look at the full docs in `docs/maritime-data-synthesizer.md`
-
diff --git a/docs/security.md b/docs/security.md
@@ -258,4 +258,3 @@ For security concerns:
 - PGP key available on request
 
 Thank you for helping keep this project secure! 🔒
-
diff --git a/docs/system-overview.md b/docs/system-overview.md
@@ -320,4 +320,3 @@ npx maritime-data-synthesizer reset 30
 ---
 
 **The power of synthetic data + cloud data pipelines** 🚀
-
diff --git a/eslint.config.js b/eslint.config.js
@@ -21,4 +21,3 @@ export default [
 		},
 	},
 ];
-
diff --git a/examples/README.md b/examples/README.md
@@ -53,4 +53,3 @@ node examples/<script-name>.js
 ```
 
 Some examples require configuration in `config.yaml` or `.env` file.
-
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -67,4 +67,3 @@
 		}
 	}
 }
-
diff --git a/prettier.config.js b/prettier.config.js
@@ -1,4 +1,3 @@
 import harperConfig from '@harperdb/code-guidelines/prettier';
 
 export default harperConfig;
-
diff --git a/schema/harper-bigquery-sync.graphql b/schema/harper-bigquery-sync.graphql
@@ -42,4 +42,3 @@ type SyncAudit @table {
 	reason: String
 	recordSample: String
 }
-
diff --git a/src/bigquery-client.js b/src/bigquery-client.js
@@ -232,4 +232,3 @@ export class BigQueryClient {
 		}
 	}
 }
-
diff --git a/src/bigquery.js b/src/bigquery.js
@@ -362,4 +362,3 @@ class MaritimeBigQueryClient {
 }
 
 export default MaritimeBigQueryClient;
-
diff --git a/src/config-loader.js b/src/config-loader.js
@@ -304,4 +304,3 @@ export default {
 	getPluginConfig,
 	getTableConfig,
 };
-
diff --git a/src/generator.js b/src/generator.js
@@ -475,4 +475,3 @@ class MaritimeVesselGenerator {
 }
 
 export default MaritimeVesselGenerator;
-
diff --git a/src/globals.js b/src/globals.js
@@ -19,4 +19,3 @@ const globals = new Globals();
 export { globals, Globals };
 
 export default Globals;
-
diff --git a/src/index.js b/src/index.js
@@ -64,4 +64,3 @@ export async function handleApplication(scope) {
 		);
 	}
 }
-
diff --git a/src/maritime-synthesizer.js b/src/maritime-synthesizer.js
@@ -10,4 +10,3 @@ import MaritimeBigQueryClient from './bigquery.js';
 export { MaritimeDataSynthesizer, MaritimeVesselGenerator, MaritimeBigQueryClient };
 
 export default MaritimeDataSynthesizer;
-
diff --git a/src/query-builder.js b/src/query-builder.js
@@ -182,4 +182,3 @@ export class QueryBuilder {
 }
 
 export default QueryBuilder;
-
diff --git a/src/resources.js b/src/resources.js
@@ -138,4 +138,3 @@ export class SyncControl extends Resource {
 		}
 	}
 }
-
diff --git a/src/service.js b/src/service.js
@@ -528,4 +528,3 @@ class MaritimeDataSynthesizer extends EventEmitter {
 }
 
 export default MaritimeDataSynthesizer;
-
diff --git a/src/sync-engine.js b/src/sync-engine.js
@@ -487,4 +487,3 @@ export class SyncEngine {
 
 // Export additional classes for use in resources.js
 export { BigQueryClient } from './bigquery-client.js';
-
diff --git a/src/type-converter.js b/src/type-converter.js
@@ -147,4 +147,3 @@ export default {
 	convertBigInt,
 	convertBigQueryTimestamp,
 };
-
diff --git a/src/validation.js b/src/validation.js
@@ -424,4 +424,3 @@ export class ValidationService {
 		};
 	}
 }
-
diff --git a/src/validators.js b/src/validators.js
@@ -195,4 +195,3 @@ export default {
 	validateRetryConfig,
 	validateFullConfig,
 };
-
diff --git a/test/README.md b/test/README.md
@@ -60,4 +60,3 @@ For integration testing with live BigQuery and Harper instances, see:
 
 - `examples/test-bigquery-config.js` - Tests BigQuery connection
 - Manual testing with `npx maritime-data-synthesizer start`
-
diff --git a/test/bigquery-client.test.js b/test/bigquery-client.test.js
@@ -248,4 +248,3 @@ describe('BigQueryClient', () => {
 		});
 	});
 });
-
diff --git a/test/column-selection-examples.test.js b/test/column-selection-examples.test.js
@@ -282,4 +282,3 @@ describe('Column Selection Examples', () => {
 		});
 	});
 });
-
diff --git a/test/config-loader.test.js b/test/config-loader.test.js
@@ -434,4 +434,3 @@ describe('Config Loader', () => {
 		});
 	});
 });
-
diff --git a/test/fixtures/multi-table-test-data.js b/test/fixtures/multi-table-test-data.js
@@ -188,4 +188,3 @@ export default {
 	EVENT_TYPES,
 	VESSEL_STATUSES,
 };
-
diff --git a/test/integration/column-selection.test.js b/test/integration/column-selection.test.js
@@ -259,4 +259,3 @@ async function _generateTestData() {
 async function _cleanupTestData() {
 	console.log('Test data cleanup would be implemented here');
 }
-
diff --git a/test/integration/multi-table-sync.test.js b/test/integration/multi-table-sync.test.js
@@ -583,4 +583,3 @@ async function _syncTable(tableConfig, client) {
 	await engine.initialize();
 	await engine.syncOnce();
 }
-
diff --git a/test/integration/orchestrator.test.js b/test/integration/orchestrator.test.js
@@ -320,4 +320,3 @@ describe('Multi-Table Orchestrator Integration', () => {
 		});
 	});
 });
-
diff --git a/test/integration/validation.test.js b/test/integration/validation.test.js
@@ -580,4 +580,3 @@ describe('ValidationService - Multi-Table Support', () => {
 		});
 	});
 });
-
diff --git a/test/query-builder.test.js b/test/query-builder.test.js
@@ -239,4 +239,3 @@ describe('Query Builder', () => {
 		});
 	});
 });
-
diff --git a/test/sync-engine.test.js b/test/sync-engine.test.js
@@ -319,4 +319,3 @@ describe('Sync Engine', () => {
 		});
 	});
 });
-
diff --git a/test/type-converter.test.js b/test/type-converter.test.js
@@ -267,4 +267,3 @@ describe('Type Converter', () => {
 		});
 	});
 });
-
diff --git a/test/vessel-positions-generator.test.js b/test/vessel-positions-generator.test.js
@@ -231,4 +231,3 @@ describe('VesselPositionsGenerator', () => {
 		});
 	});
 });
-

Original file line number	Diff line number	Diff line change
`@@ -321,4 +321,3 @@ async function runMultiTableMode(command, arg, config) {`
`321`	`321`	`}`
`322`	`322`
`323`	`323`	`main();`
`324`		`-`