docrev 0.8.1 → 0.8.5

package/lib/{spelling.js → spelling.ts}

@@ -9,44 +9,59 @@
 
 import * as fs from 'fs';
 import * as path from 'path';
+// @ts-ignore - nspell has no types
 import nspell from 'nspell';
+// @ts-ignore - dictionary-en has no types
 import dictionaryEn from 'dictionary-en';
+// @ts-ignore - dictionary-en-gb has no types
 import dictionaryEnGb from 'dictionary-en-gb';
 import { scientificWords } from './scientific-words.js';
+import type { SpellingIssue, SpellingResult } from './types.js';
 
 const DICT_NAME = '.rev-dictionary';
 
 // Cache for the spellchecker instances (one per language)
-const spellcheckerCache = {
+const spellcheckerCache: Record<string, any> = {
   en: null,
   'en-gb': null,
 };
 
+interface WordLocation {
+  word: string;
+  line: number;
+  column: number;
+}
+
+interface CheckSpellingOptions {
+  projectDir?: string;
+  lang?: 'en' | 'en-gb';
+}
+
+interface CheckFileOptions {
+  projectDir?: string;
+  lang?: 'en' | 'en-gb';
+}
+
 /**
  * Get the global dictionary path
- * @returns {string}
  */
-export function getGlobalDictPath() {
+export function getGlobalDictPath(): string {
   const home = process.env.HOME || process.env.USERPROFILE;
-  return path.join(home, DICT_NAME);
+  return path.join(home!, DICT_NAME);
 }
 
 /**
  * Get the project dictionary path
- * @param {string} directory
- * @returns {string}
  */
-export function getProjectDictPath(directory = '.') {
+export function getProjectDictPath(directory: string = '.'): string {
   return path.join(directory, DICT_NAME);
 }
 
 /**
  * Load custom words from a dictionary file
- * @param {string} dictPath
- * @returns {Set<string>}
  */
-export function loadDictionaryFile(dictPath) {
-  const words = new Set();
+export function loadDictionaryFile(dictPath: string): Set<string> {
+  const words = new Set<string>();
 
   if (fs.existsSync(dictPath)) {
     const content = fs.readFileSync(dictPath, 'utf-8');
@@ -63,10 +78,8 @@ export function loadDictionaryFile(dictPath) {
 
 /**
  * Save words to a dictionary file
- * @param {Set<string>} words
- * @param {string} dictPath
  */
-export function saveDictionaryFile(words, dictPath) {
+export function saveDictionaryFile(words: Set<string>, dictPath: string): void {
   const header = `# Custom dictionary for docrev
 # One word per line, lines starting with # are comments
 `;
@@ -83,10 +96,8 @@ export function saveDictionaryFile(words, dictPath) {
 
 /**
  * Load all custom words (global + project)
- * @param {string} projectDir
- * @returns {Set<string>}
  */
-export function loadAllCustomWords(projectDir = '.') {
+export function loadAllCustomWords(projectDir: string = '.'): Set<string> {
   const globalWords = loadDictionaryFile(getGlobalDictPath());
   const projectWords = loadDictionaryFile(getProjectDictPath(projectDir));
 
@@ -95,12 +106,8 @@ export function loadAllCustomWords(projectDir = '.') {
 
 /**
  * Add word to dictionary
- * @param {string} word
- * @param {boolean} global - Add to global dictionary
- * @param {string} projectDir
- * @returns {boolean} True if word was added
  */
-export function addWord(word, global = true, projectDir = '.') {
+export function addWord(word: string, global: boolean = true, projectDir: string = '.'): boolean {
   const dictPath = global ? getGlobalDictPath() : getProjectDictPath(projectDir);
   const words = loadDictionaryFile(dictPath);
   const normalizedWord = word.trim().toLowerCase();
@@ -120,12 +127,8 @@ export function addWord(word, global = true, projectDir = '.') {
 
 /**
  * Remove word from dictionary
- * @param {string} word
- * @param {boolean} global
- * @param {string} projectDir
- * @returns {boolean} True if word was removed
  */
-export function removeWord(word, global = true, projectDir = '.') {
+export function removeWord(word: string, global: boolean = true, projectDir: string = '.'): boolean {
   const dictPath = global ? getGlobalDictPath() : getProjectDictPath(projectDir);
   const words = loadDictionaryFile(dictPath);
   const normalizedWord = word.trim().toLowerCase();
@@ -145,11 +148,8 @@ export function removeWord(word, global = true, projectDir = '.') {
 
 /**
  * List words in dictionary
- * @param {boolean} global
- * @param {string} projectDir
- * @returns {string[]}
  */
-export function listWords(global = true, projectDir = '.') {
+export function listWords(global: boolean = true, projectDir: string = '.'): string[] {
   const dictPath = global ? getGlobalDictPath() : getProjectDictPath(projectDir);
   const words = loadDictionaryFile(dictPath);
   return [...words].sort();
@@ -157,11 +157,8 @@ export function listWords(global = true, projectDir = '.') {
 
 /**
  * Initialize the spellchecker with custom words
- * @param {string} projectDir
- * @param {string} lang - Language: 'en' (US) or 'en-gb' (British)
- * @returns {Promise<object>}
  */
-export async function getSpellchecker(projectDir = '.', lang = 'en') {
+export async function getSpellchecker(projectDir: string = '.', lang: 'en' | 'en-gb' = 'en'): Promise<any> {
   if (spellcheckerCache[lang]) {
     return spellcheckerCache[lang];
   }
@@ -188,24 +185,23 @@ export async function getSpellchecker(projectDir = '.', lang = 'en') {
 /**
  * Clear spellchecker cache (call after modifying dictionaries)
  */
-export function clearCache() {
+export function clearCache(): void {
   spellcheckerCache.en = null;
   spellcheckerCache['en-gb'] = null;
 }
 
 /**
  * Extract words from text, filtering out non-words
- * @param {string} text
- * @returns {Array<{word: string, line: number, column: number}>}
  */
-export function extractWords(text) {
-  const words = [];
+export function extractWords(text: string): WordLocation[] {
+  const words: WordLocation[] = [];
   const lines = text.split('\n');
   let inCodeBlock = false;
   let inFrontmatter = false;
 
   for (let lineNum = 0; lineNum < lines.length; lineNum++) {
     const line = lines[lineNum];
+    if (!line) continue;
     const trimmed = line.trim();
 
     // Track YAML frontmatter (only at start of file)
@@ -279,30 +275,23 @@ export function extractWords(text) {
 
 /**
  * Check if a word looks like a proper noun (name)
- * @param {string} word
- * @returns {boolean}
  */
-function looksLikeName(word) {
+function looksLikeName(word: string): boolean {
   // Capitalized, not all caps, reasonable length for a name
   return /^[A-Z][a-z]{2,}$/.test(word);
 }
 
 /**
  * Check spelling in text
- * @param {string} text
- * @param {object} options
- * @param {string} options.projectDir
- * @param {string} options.lang - 'en' (US) or 'en-gb' (British)
- * @returns {Promise<{misspelled: Array, possibleNames: Array}>}
  */
-export async function checkSpelling(text, options = {}) {
+export async function checkSpelling(text: string, options: CheckSpellingOptions = {}): Promise<SpellingResult> {
   const { projectDir = '.', lang = 'en' } = options;
   const spell = await getSpellchecker(projectDir, lang);
   const words = extractWords(text);
-  const misspelled = [];
-  const possibleNames = [];
-  const seen = new Set();
-  const seenNames = new Set();
+  const misspelled: SpellingIssue[] = [];
+  const possibleNames: SpellingIssue[] = [];
+  const seen = new Set<string>();
+  const seenNames = new Set<string>();
 
   for (const { word, line, column } of words) {
     // Skip if already reported this word
@@ -333,13 +322,8 @@ export async function checkSpelling(text, options = {}) {
 
 /**
  * Check spelling in a file
- * @param {string} filePath
- * @param {object} options
- * @param {string} options.projectDir
- * @param {string} options.lang
- * @returns {Promise<{misspelled: Array, possibleNames: Array}>}
  */
-export async function checkFile(filePath, options = {}) {
+export async function checkFile(filePath: string, options: CheckFileOptions = {}): Promise<SpellingResult> {
   const text = fs.readFileSync(filePath, 'utf-8');
   const result = await checkSpelling(text, options);
 

package/lib/{templates.js → templates.ts}

@@ -4,7 +4,14 @@
  * Used by `rev new` command to create new paper projects
  */
 
-export const TEMPLATES = {
+interface TemplateDefinition {
+  name: string;
+  description: string;
+  files: Record<string, string>;
+  directories: string[];
+}
+
+export const TEMPLATES: Record<string, TemplateDefinition> = {
   /**
    * Standard academic paper structure
    */
@@ -414,18 +421,15 @@ paper.md
 
 /**
  * Get template by name
- * @param {string} name
- * @returns {object|null}
  */
-export function getTemplate(name) {
+export function getTemplate(name: string): TemplateDefinition | null {
   return TEMPLATES[name.toLowerCase()] || null;
 }
 
 /**
  * List available templates
- * @returns {Array<{id: string, name: string, description: string}>}
  */
-export function listTemplates() {
+export function listTemplates(): Array<{ id: string; name: string; description: string }> {
   return Object.entries(TEMPLATES).map(([id, template]) => ({
     id,
     name: template.name,
@@ -435,10 +439,8 @@ export function listTemplates() {
 
 /**
  * Convert string to title case for headers
- * @param {string} str
- * @returns {string}
  */
-function titleCase(str) {
+function titleCase(str: string): string {
   return str
     .split(/[-_\s]+/)
     .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
@@ -447,12 +449,13 @@ function titleCase(str) {
 
 /**
  * Generate a custom template with specified sections
- * @param {string[]} sections - Array of section names (without .md extension)
- * @param {object} baseTemplate - Base template to extend (default: paper)
- * @returns {object}
  */
-export function generateCustomTemplate(sections, baseTemplate = TEMPLATES.paper) {
-  const files = {};
+export function generateCustomTemplate(
+  sections: string[],
+  baseTemplate?: TemplateDefinition
+): TemplateDefinition {
+  const base = baseTemplate || TEMPLATES.paper;
+  const files: Record<string, string> = {};
 
   // Generate rev.yaml with custom sections
   const sectionsList = sections.map((s) => `  - ${s}.md`).join('\n');
@@ -502,8 +505,8 @@ docx:
   }
 
   // Add common files
-  files['references.bib'] = baseTemplate.files['references.bib'] || '';
-  files['.gitignore'] = baseTemplate.files['.gitignore'] || `# Build outputs
+  files['references.bib'] = base.files['references.bib'] || '';
+  files['.gitignore'] = base.files['.gitignore'] || `# Build outputs
 *.pdf
 *.docx
 *.tex
@@ -518,6 +521,6 @@ paper.md
     name: 'Custom',
     description: 'Custom sections',
     files,
-    directories: baseTemplate.directories || ['figures'],
+    directories: base.directories || ['figures'],
   };
 }