How ashmeetsehgal/json-deep-compare works
Main Components
A. Library Core (Left Side)
1. Source Modules (src/)
• Comparator.js
• JSONCompare.js
• Options.js
• PathUtils.js
• RegexValidator.js
• Result.js
• index.js (entry-point)
2. Type Definitions (types/)
• index.d.ts
• test.ts
3. Examples (examples/)
• Various usage scenario scripts (basic-usage.js, type-checking.js, etc.)
4. Tests (test/)
• api-validation.test.js, esm-test.mjs, module-import.test.js, etc.
B. Build & Publish Pipeline (Right Side)
1. Build Configuration
• Babel configuration (babel.esm.config.js)
• TypeScript config (tsconfig.json)
• build-index.js (bundler entry)
2. Scripts
• scripts/publish-package.js
• scripts/publish-packages.js
3. CI/CD Workflows (.github/workflows/)
• Test, coverage, codeql-analysis, npm-publish, renovate, pr-validation, etc.
4. Package Metadata
• package.json / package-lock.json / .npmrc / .npmignore
5. Publishing Targets
• npm registry
• GitHub Packages (optional)
Architectural Patterns & Design Principles
• Separation of Concerns: Core library vs. build/publish logic kept in separate directories.
• Extensibility: Examples folder and plugin-like regexChecks / options data flow—show options flowing into JSONCompare.
Technologies, Frameworks & External Services
• Jest – label near Tests.
• Renovate / Dependabot – small labels under CI/CD representing dependency management.