legal-markdown-js 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Legal MD Wizard Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,168 @@
+# Legal Markdown JS
+
+A Node.js implementation of
+[LegalMarkdown](https://github.com/compleatang/legal-markdown) for processing
+legal documents with structured markdown and YAML front matter.
+
+## Table of Contents
+
+- [Goals](#goals)
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Key Features](#key-features)
+- [Documentation](#documentation)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Goals
+
+- **Core Parity**: 1:1 compatibility with the original Ruby legal-markdown tool
+- **Node.js Extensions**: Additional functionality leveraging the Node.js
+  ecosystem
+- **Type Safety**: Full TypeScript implementation with comprehensive type
+  definitions
+- **Modern Tooling**: Built with modern development practices and tooling
+
+## Installation
+
+```bash
+npm install legal-markdown-js
+```
+
+## Quick Start
+
+### Command Line Usage
+
+```bash
+# Basic document processing
+legal-md input.md output.md
+
+# Generate PDF with highlighting
+legal-md document.md --pdf --highlight
+
+# Process with custom CSS
+legal-md document.md --html --css styles.css
+```
+
+### Programmatic Usage
+
+```typescript
+import { processLegalMarkdown } from 'legal-markdown-js';
+
+const result = processLegalMarkdown(content, {
+  basePath: './documents',
+  exportMetadata: true,
+  exportFormat: 'json',
+});
+
+console.log(result.content);
+console.log(result.metadata);
+```
+
+## Key Features
+
+### Core Compatibility
+
+All original Legal Markdown features are fully implemented:
+
+- **File Formats**: Markdown, ASCII, reStructuredText, LaTeX
+- **YAML Front Matter**: Complete parsing with all standard fields
+- **Headers & Numbering**: Full hierarchical numbering system (`l.`, `ll.`,
+  `lll.`)
+- **Optional Clauses**: Boolean, equality, and logical operations
+  (`[text]{condition}`)
+- **Cross-References**: All reference types including special date handling
+  (`|reference|`)
+- **Partial Imports**: File inclusion with path resolution (`@import`)
+- **Metadata Export**: YAML and JSON export with custom paths
+
+### Node.js Enhancements
+
+Additional features available only in the Node.js version:
+
+- **Mixins System**: Template substitution with `{{variable}}` syntax
+- **PDF Generation**: Professional PDF output with styling and field
+  highlighting
+- **HTML Generation**: Custom HTML output with CSS support
+- **Template Loops**: Array iteration with `[#items]...[/items]` syntax
+- **Helper Functions**: Date, number, and string formatting helpers
+- **Batch Processing**: Multi-file processing with concurrency control
+
+## Documentation
+
+### User Documentation
+
+- **[Getting Started](docs/GETTING-STARTED.md)** - Installation and setup guide
+- **[CLI Reference](docs/CLI-REFERENCE.md)** - Complete command-line interface
+  documentation
+- **[Features Guide](docs/FEATURES-GUIDE.md)** - All features, helpers, and
+  advanced usage
+- **[Headers & Numbering](docs/HEADERS-NUMBERING.md)** - Hierarchical numbering
+  system guide
+- **[CSS Classes Reference](docs/CSS-CLASSES.md)** - CSS classes for styling and
+  document review
+- **[Compatibility](docs/COMPATIBILITY.md)** - Ruby version compatibility
+  tracking
+
+### Developer Documentation
+
+- **[Architecture](docs/ARCHITECTURE.md)** - Complete system architecture and design patterns
+- **[Contributing Guide](docs/CONTRIBUTING.md)** - Development workflow, standards, and contribution guidelines  
+- **[Helper Functions](docs/HELPERS.md)** - Complete reference for template helpers and functions
+- **[Development Guide](docs/DEVELOPMENT-GUIDE.md)** - Complete developer setup
+  and workflow
+- **[Release Process](docs/RELEASE-PROCESS.md)** - Versioning and release
+  procedures
+- **[Scripts Reference](docs/SCRIPTS-REFERENCE.md)** - Available npm scripts and
+  commands
+- **[API Documentation](docs/api/)** - Auto-generated TypeScript API docs
+
+## Testing
+
+```bash
+# Run all tests
+npm test
+
+# Run specific test types
+npm run test:unit
+npm run test:integration
+npm run test:e2e
+
+# Run with coverage
+npm run test:coverage
+```
+
+The project includes comprehensive testing with 495 tests across 29 test suites:
+
+- **Unit Tests**: Test individual components in isolation
+- **Integration Tests**: Test complete workflows and feature combinations
+- **E2E Tests**: Test CLI interface and full application behavior
+
+## Contributing
+
+We welcome contributions! Please see our
+[Contributing Guide](docs/CONTRIBUTING.md) for:
+
+- Development setup and workflow
+- Coding standards and best practices
+- Testing requirements
+- Pull request process
+
+### Quick Start for Contributors
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Follow the development guidelines
+4. Run the test suite (`npm test`)
+5. Submit a Pull Request
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Original [LegalMarkdown](https://github.com/compleatang/legal-markdown)
+  project by Casey Kuhlman
+- The legal tech community for inspiration and feedback

package/dist/browser.d.ts

@@ -0,0 +1,87 @@
+/**
+ * @fileoverview Browser-Specific Entry Point for Legal Markdown Processing
+ *
+ * This module provides a browser-compatible version of the Legal Markdown
+ * processing library that excludes Node.js-specific features like file system
+ * operations and PDF generation. It's optimized for web environments and
+ * client-side processing.
+ *
+ * Features:
+ * - YAML front matter parsing and metadata extraction
+ * - Cross-reference processing and resolution
+ * - Optional clause conditional rendering
+ * - Mixin system for reusable content blocks
+ * - Header numbering and formatting
+ * - Field tracking for document highlighting
+ * - RST and LaTeX preprocessing support
+ * - UMD build compatibility for script tag usage
+ *
+ * @example
+ * ```typescript
+ * import { processLegalMarkdown } from 'legal-markdown-js/browser';
+ *
+ * // Browser-compatible document processing
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   noClauses: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * ```
+ */
+import { fieldTracker } from './tracking/field-tracker';
+import { LegalMarkdownOptions } from '@types';
+/**
+ * Browser-compatible version of Legal Markdown processing
+ *
+ * This function provides the core Legal Markdown processing functionality
+ * optimized for browser environments. It excludes Node.js-specific features
+ * like file system operations while maintaining full compatibility with
+ * YAML parsing, content processing, and field tracking.
+ *
+ * @param {string} content - The raw Legal Markdown content to process
+ * @param {Omit<LegalMarkdownOptions, 'basePath' | 'exportPath'>} [options={}] - Browser-compatible configuration options
+ * @returns {Object} Processing result containing processed content, metadata, and reports
+ * @returns {string} returns.content - The processed document content
+ * @returns {Record<string, any>} [returns.metadata] - Extracted YAML metadata
+ * @returns {Object} [returns.fieldReport] - Field tracking report if enabled
+ * @example
+ * ```typescript
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   noClauses: false,
+ *   noReferences: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * console.log(result.fieldReport); // Field usage report
+ * ```
+ */
+export declare function processLegalMarkdown(content: string, options?: Omit<LegalMarkdownOptions, 'basePath' | 'exportPath'>): {
+    content: string;
+    metadata?: Record<string, any>;
+    fieldReport?: ReturnType<typeof fieldTracker.generateReport>;
+};
+/**
+ * UMD-compatible export object for browser environments
+ *
+ * This constant provides a namespace object that can be used in UMD builds
+ * and script tag implementations, making the library accessible through
+ * global window object or module systems.
+ *
+ * @constant {Object} LegalMarkdown
+ * @example
+ * ```typescript
+ * // ES6 import
+ * import { LegalMarkdown } from 'legal-markdown-js/browser';
+ *
+ * // UMD/Script tag usage
+ * const result = window.LegalMarkdown.processLegalMarkdown(content);
+ * ```
+ */
+export declare const LegalMarkdown: {
+    processLegalMarkdown: typeof processLegalMarkdown;
+};
+//# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AA0BH,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,QAAQ,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,GAAG,YAAY,CAAM,GAClE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/B,WAAW,CAAC,EAAE,UAAU,CAAC,OAAO,YAAY,CAAC,cAAc,CAAC,CAAC;CAC9D,CAuDA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa;;CAEzB,CAAC"}

package/dist/browser.js

@@ -0,0 +1,157 @@
+"use strict";
+/**
+ * @fileoverview Browser-Specific Entry Point for Legal Markdown Processing
+ *
+ * This module provides a browser-compatible version of the Legal Markdown
+ * processing library that excludes Node.js-specific features like file system
+ * operations and PDF generation. It's optimized for web environments and
+ * client-side processing.
+ *
+ * Features:
+ * - YAML front matter parsing and metadata extraction
+ * - Cross-reference processing and resolution
+ * - Optional clause conditional rendering
+ * - Mixin system for reusable content blocks
+ * - Header numbering and formatting
+ * - Field tracking for document highlighting
+ * - RST and LaTeX preprocessing support
+ * - UMD build compatibility for script tag usage
+ *
+ * @example
+ * ```typescript
+ * import { processLegalMarkdown } from 'legal-markdown-js/browser';
+ *
+ * // Browser-compatible document processing
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   noClauses: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LegalMarkdown = void 0;
+exports.processLegalMarkdown = processLegalMarkdown;
+const yaml_parser_1 = require("./core/parsers/yaml-parser");
+const header_processor_1 = require("./core/processors/header-processor");
+const clause_processor_1 = require("./core/processors/clause-processor");
+const reference_processor_1 = require("./core/processors/reference-processor");
+const mixin_processor_1 = require("./core/processors/mixin-processor");
+// Import with fallback for browser environments
+let convertRstToLegalMarkdownSync;
+let convertLatexToLegalMarkdownSync;
+try {
+    const rstParser = require('./extensions/rst-parser');
+    convertRstToLegalMarkdownSync = rstParser.convertRstToLegalMarkdownSync;
+}
+catch (error) {
+    // Fallback for browser environments without pandoc-wasm
+    convertRstToLegalMarkdownSync = (content) => content;
+}
+try {
+    const latexParser = require('./extensions/latex-parser');
+    convertLatexToLegalMarkdownSync = latexParser.convertLatexToLegalMarkdownSync;
+}
+catch (error) {
+    // Fallback for browser environments without pandoc-wasm
+    convertLatexToLegalMarkdownSync = (content) => content;
+}
+const field_tracker_1 = require("./tracking/field-tracker");
+/**
+ * Browser-compatible version of Legal Markdown processing
+ *
+ * This function provides the core Legal Markdown processing functionality
+ * optimized for browser environments. It excludes Node.js-specific features
+ * like file system operations while maintaining full compatibility with
+ * YAML parsing, content processing, and field tracking.
+ *
+ * @param {string} content - The raw Legal Markdown content to process
+ * @param {Omit<LegalMarkdownOptions, 'basePath' | 'exportPath'>} [options={}] - Browser-compatible configuration options
+ * @returns {Object} Processing result containing processed content, metadata, and reports
+ * @returns {string} returns.content - The processed document content
+ * @returns {Record<string, any>} [returns.metadata] - Extracted YAML metadata
+ * @returns {Object} [returns.fieldReport] - Field tracking report if enabled
+ * @example
+ * ```typescript
+ * const result = processLegalMarkdown(content, {
+ *   enableFieldTracking: true,
+ *   noClauses: false,
+ *   noReferences: false
+ * });
+ *
+ * console.log(result.content); // Processed markdown
+ * console.log(result.metadata); // YAML front matter
+ * console.log(result.fieldReport); // Field usage report
+ * ```
+ */
+function processLegalMarkdown(content, options = {}) {
+    // Clear field tracker for new document
+    field_tracker_1.fieldTracker.clear();
+    // Convert RST or LaTeX to legal markdown if needed (before YAML parsing)
+    let preprocessedContent = convertRstToLegalMarkdownSync(content);
+    preprocessedContent = convertLatexToLegalMarkdownSync(preprocessedContent);
+    // Parse YAML Front Matter
+    const { content: contentWithoutYaml, metadata } = (0, yaml_parser_1.parseYamlFrontMatter)(preprocessedContent, options.throwOnYamlError);
+    // If only processing YAML, return early
+    if (options.yamlOnly) {
+        return { content: contentWithoutYaml, metadata };
+    }
+    let processedContent = contentWithoutYaml;
+    // Process optional clauses
+    if (!options.noClauses) {
+        processedContent = (0, clause_processor_1.processOptionalClauses)(processedContent, metadata);
+    }
+    // Process cross references
+    if (!options.noReferences) {
+        processedContent = (0, reference_processor_1.processCrossReferences)(processedContent, metadata);
+    }
+    // Process mixins
+    if (!options.noMixins) {
+        processedContent = (0, mixin_processor_1.processMixins)(processedContent, metadata, options);
+    }
+    // Process headers (numbering, etc)
+    if (!options.noHeaders) {
+        processedContent = (0, header_processor_1.processHeaders)(processedContent, metadata, {
+            noReset: options.noReset,
+            noIndent: options.noIndent,
+            enableFieldTracking: options.enableFieldTracking,
+        });
+    }
+    // Apply field tracking to content if highlighting is enabled
+    if (options.enableFieldTracking) {
+        processedContent = field_tracker_1.fieldTracker.applyFieldTracking(processedContent);
+    }
+    return {
+        content: processedContent,
+        metadata,
+        fieldReport: options.enableFieldTracking ? field_tracker_1.fieldTracker.generateReport() : undefined,
+    };
+}
+/**
+ * UMD-compatible export object for browser environments
+ *
+ * This constant provides a namespace object that can be used in UMD builds
+ * and script tag implementations, making the library accessible through
+ * global window object or module systems.
+ *
+ * @constant {Object} LegalMarkdown
+ * @example
+ * ```typescript
+ * // ES6 import
+ * import { LegalMarkdown } from 'legal-markdown-js/browser';
+ *
+ * // UMD/Script tag usage
+ * const result = window.LegalMarkdown.processLegalMarkdown(content);
+ * ```
+ */
+exports.LegalMarkdown = {
+    processLegalMarkdown,
+};
+// Create global window object for script tag usage
+if (typeof window !== 'undefined') {
+    // eslint-disable-next-line no-undef
+    window.LegalMarkdown = exports.LegalMarkdown;
+}
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser.js","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;;;AAwDH,oDA8DC;AApHD,2DAAiE;AACjE,wEAAmE;AACnE,wEAA2E;AAC3E,8EAA8E;AAC9E,sEAAiE;AACjE,gDAAgD;AAChD,IAAI,6BAA0D,CAAC;AAC/D,IAAI,+BAA4D,CAAC;AAEjE,IAAI,CAAC;IACH,MAAM,SAAS,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IACpD,6BAA6B,GAAG,SAAS,CAAC,6BAA6B,CAAC;AAC1E,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,wDAAwD;IACxD,6BAA6B,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC;AAC/D,CAAC;AAED,IAAI,CAAC;IACH,MAAM,WAAW,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACxD,+BAA+B,GAAG,WAAW,CAAC,+BAA+B,CAAC;AAChF,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,wDAAwD;IACxD,+BAA+B,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,OAAO,CAAC;AACjE,CAAC;AACD,4DAAwD;AAGxD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,oBAAoB,CAClC,OAAe,EACf,UAAiE,EAAE;IAMnE,uCAAuC;IACvC,4BAAY,CAAC,KAAK,EAAE,CAAC;IAErB,yEAAyE;IACzE,IAAI,mBAAmB,GAAG,6BAA6B,CAAC,OAAO,CAAC,CAAC;IACjE,mBAAmB,GAAG,+BAA+B,CAAC,mBAAmB,CAAC,CAAC;IAE3E,0BAA0B;IAC1B,MAAM,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,GAAG,IAAA,kCAAoB,EACpE,mBAAmB,EACnB,OAAO,CAAC,gBAAgB,CACzB,CAAC;IAEF,wCAAwC;IACxC,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;QACrB,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,QAAQ,EAAE,CAAC;IACnD,CAAC;IAED,IAAI,gBAAgB,GAAG,kBAAkB,CAAC;IAE1C,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,gBAAgB,GAAG,IAAA,yCAAsB,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;QAC1B,gBAAgB,GAAG,IAAA,4CAAsB,EAAC,gBAAgB,EAAE,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,iBAAiB;IACjB,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QACtB,gBAAgB,GAAG,IAAA,+BAAa,EAAC,gBAAgB,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,mCAAmC;IACnC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QACvB,gBAAgB,GAAG,IAAA,iCAAc,EAAC,gBAAgB,EAAE,QAAQ,EAAE;YAC5D,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;SACjD,CAAC,CAAC;IACL,CAAC;IAED,6DAA6D;IAC7D,IAAI,OAAO,CAAC,mBAAmB,EAAE,CAAC;QAChC,gBAAgB,GAAG,4BAAY,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;IACvE,CAAC;IAED,OAAO;QACL,OAAO,EAAE,gBAAgB;QACzB,QAAQ;QACR,WAAW,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,4BAAY,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,SAAS;KACrF,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACU,QAAA,aAAa,GAAG;IAC3B,oBAAoB;CACrB,CAAC;AAEF,mDAAmD;AACnD,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;IAClC,oCAAoC;IACnC,MAAc,CAAC,aAAa,GAAG,qBAAa,CAAC;AAChD,CAAC"}

package/dist/cli/index.d.ts

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+/**
+ * @fileoverview Command Line Interface for Legal Markdown Processing
+ *
+ * This module provides a comprehensive CLI tool for processing Legal Markdown
+ * documents with support for various output formats, processing options, and
+ * input/output methods (files, stdin/stdout).
+ *
+ * Features:
+ * - File and stdin input processing
+ * - Multiple output formats (Markdown, HTML, PDF)
+ * - Comprehensive processing options and flags
+ * - Field highlighting and styling options
+ * - Metadata export capabilities
+ * - Error handling and user feedback
+ * - Debug mode support
+ *
+ * @example
+ * ```bash
+ * # Process a file
+ * legal-md input.md output.md
+ *
+ * # Generate PDF with highlighting
+ * legal-md input.md --pdf --highlight --title "Contract"
+ *
+ * # Process from stdin
+ * cat input.md | legal-md --stdin --stdout
+ *
+ * # Export metadata
+ * legal-md input.md --export-yaml --output-path metadata.yaml
+ * ```
+ */
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/cli/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":";AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG"}