docrev 0.2.1 → 0.5.0

package/.rev-dictionary

@@ -0,0 +1,4 @@
+# Custom dictionary for docrev
+# Add one word per line
+# Lines starting with # are comments
+

package/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Changelog
+
+All notable changes to docrev 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).
+
+## [0.3.2] - 2024-12-29
+
+### Added
+- Full TypeScript type definitions (`types/index.d.ts`)
+- GitHub Actions CI workflow (Node 18/20/22)
+- ESM subpath exports for all library modules
+- CLI integration tests (26 tests)
+- Comprehensive test coverage: 419 tests across 18 modules
+
+### Fixed
+- DOI skip detection: `% no-doi` comments now correctly apply only to the next entry
+
+### Changed
+- Added `engines` field requiring Node.js >=18.0.0
+- Updated README with badges (npm, CI, Node.js, License)
+
+## [0.3.1] - 2024-12-28
+
+### Fixed
+- Equation extraction test assertions
+- Minor bug fixes
+
+## [0.3.0] - 2024-12-27
+
+### Added
+- DOI validation via Crossref and DataCite APIs (`rev doi check`)
+- DOI lookup for missing entries (`rev doi lookup`)
+- DOI fetch and add commands (`rev doi fetch`, `rev doi add`)
+- Citation validation against bibliography (`rev citations`)
+- LaTeX equation extraction (`rev equations list`)
+- Word equation import OMML → LaTeX (`rev equations from-word`)
+- Response letter generation (`rev response`)
+- Journal validation profiles (`rev validate --journal`)
+- Advanced figure/table reference patterns (Figs. 1-3, Fig. 1a-c)
+
+### Changed
+- Improved cross-reference pattern detection
+- Enhanced Word import with better section splitting
+
+## [0.2.1] - 2024-12-26
+
+### Added
+- Table of contents option (`rev build --toc`)
+- CSV export for comments (`rev comments --export`)
+- Anonymize command for blind review (`rev anonymize`)
+- Formatting utilities (tables, boxes, spinners)
+
+## [0.2.0] - 2024-12-25
+
+### Added
+- Integrated build system (`rev build pdf/docx/tex`)
+- Comment reply functionality (`rev reply`)
+- Word document bootstrap (`rev import` creates project from .docx)
+- Section-aware import (`rev sections`)
+- Cross-reference migration (`rev migrate`)
+
+### Changed
+- Renamed project to docrev
+- Published to npm
+
+## [0.1.0] - 2024-12-24
+
+### Added
+- Initial release
+- CriticMarkup annotation parsing
+- Word ↔ Markdown round-trips
+- Interactive review TUI (`rev review`)
+- Comment management (`rev comments`, `rev resolve`)
+- Project templates (`rev new`)

package/README.md

@@ -1,6 +1,9 @@
 # docrev
 
 [![npm](https://img.shields.io/npm/v/docrev)](https://www.npmjs.com/package/docrev)
+[![CI](https://github.com/gcol33/docrev/actions/workflows/ci.yml/badge.svg)](https://github.com/gcol33/docrev/actions/workflows/ci.yml)
+[![Node.js](https://img.shields.io/node/v/docrev)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 CLI tool for Word ↔ Markdown round-trips. Handle reviewer feedback on academic papers: import track changes, review interactively, manage comments, validate DOIs, and build to PDF/DOCX/LaTeX.
 
@@ -35,6 +38,18 @@ rev --version
 rev install    # Check for missing dependencies
 ```
 
+### Shell Completions (Optional)
+
+Enable tab completion for `rev` commands:
+
+```bash
+# Bash - add to ~/.bashrc
+eval "$(rev completions bash)"
+
+# Zsh - add to ~/.zshrc
+eval "$(rev completions zsh)"
+```
+
 ## Features
 
 - **Integrated build system** - Combine sections → paper.md → PDF, DOCX, or LaTeX
@@ -118,6 +133,7 @@ rev build docx
 |---------|-------------|
 | `rev build [formats...]` | Build PDF/DOCX/TEX from sections |
 | `rev build --toc` | Build with table of contents |
+| `rev build --show-changes` | Export DOCX with visible track changes |
 | `rev new <name>` | Create new project from template |
 | `rev new --list` | List available templates |
 | `rev install` | Check/install dependencies (pandoc-crossref) |
@@ -176,6 +192,16 @@ rev build docx
 | `rev equations from-word <docx>` | Extract equations from Word to LaTeX |
 | `rev response [files]` | Generate response letter from comments |
 | `rev anonymize <file>` | Prepare document for blind review |
+| `rev validate --journal <name>` | Check manuscript against journal requirements |
+| `rev validate --list` | List available journal profiles |
+
+### Multi-Reviewer & Git
+
+| Command | Description |
+|---------|-------------|
+| `rev merge <md> <docx...>` | Merge feedback from multiple Word documents |
+| `rev diff [ref]` | Compare sections against git history |
+| `rev history [file]` | Show revision history for sections |
 
 ### Configuration
 
@@ -185,6 +211,48 @@ rev build docx
 | `rev split <file>` | Split annotated paper.md back to section files |
 | `rev help [topic]` | Show help (topics: workflow, syntax, commands) |
 
+### Convenience Commands
+
+| Command | Description |
+|---------|-------------|
+| `rev word-count` | Show word counts per section |
+| `rev word-count -j <journal>` | Warn if over journal word limit |
+| `rev stats` | Project dashboard (words, figures, citations) |
+| `rev search <query>` | Search across all section files |
+| `rev backup` | Create timestamped backup zip |
+| `rev export` | Export project as distributable zip |
+| `rev preview <format>` | Build and open document |
+| `rev watch [format]` | Auto-rebuild on file changes |
+| `rev lint` | Check for broken refs, missing citations |
+
+### Grammar & Style
+
+| Command | Description |
+|---------|-------------|
+| `rev grammar` | Check grammar/style issues |
+| `rev grammar --rules` | List available grammar rules |
+| `rev grammar --learn <word>` | Add word to custom dictionary |
+| `rev grammar --list` | Show custom dictionary |
+
+### Spelling
+
+| Command | Description |
+|---------|-------------|
+| `rev spelling` | Check spelling in all sections |
+| `rev spelling --british` | Use British English dictionary |
+| `rev spelling --learn <word>` | Add word to global dictionary |
+| `rev spelling --learn-project <word>` | Add word to project dictionary |
+| `rev spelling --list` | Show global dictionary |
+| `rev spelling --list-all` | Show global + project dictionaries |
+
+### Direct DOCX Editing
+
+| Command | Description |
+|---------|-------------|
+| `rev annotate <docx>` | Add comments to Word document |
+| `rev apply <md> <docx>` | Apply annotations as track changes |
+| `rev comment <docx>` | Interactive comment mode |
+
 ## Project Structure
 
 A typical rev project:
@@ -249,6 +317,27 @@ docx:
 {>>Author: comment<<}    # Comments
 ```
 
+## Template Variables
+
+Use template variables in section files (processed during build):
+
+```markdown
+Last updated: {{date}}
+Version: {{version}}
+Word count: {{word_count}}
+```
+
+| Variable | Description |
+|----------|-------------|
+| `{{date}}` | Current date (YYYY-MM-DD) |
+| `{{date:MMMM D, YYYY}}` | Custom format (December 29, 2025) |
+| `{{year}}` | Current year |
+| `{{version}}` | Version from rev.yaml |
+| `{{title}}` | Document title |
+| `{{author}}` | First author name |
+| `{{authors}}` | All authors (comma-separated) |
+| `{{word_count}}` | Total word count |
+
 ## Comment Replies
 
 Reply to reviewer comments with your name: