fitch-js 0.1.0 → 1.0.0

package/README.md

@@ -1,5 +1,8 @@
 # Fitch-JS
 
+[![npm version](https://img.shields.io/npm/v/fitch-js.svg)](https://www.npmjs.com/package/fitch-js)
+[![license](https://img.shields.io/npm/l/fitch-js.svg)](https://github.com/lagomorph-labs/fitch-js/blob/main/LICENSE)
+
 **We are not affiliated with the [Open Logic Project](https://openlogicproject.org/) or [Carnap](https://carnap.io/) in any way. (Currently)**
 
 This is a JavaScript library for validating Fitch-style natural deduction proofs. It provides functionality to check the validity of logical proofs in both propositional and first-order logic entirely in the browser, with no server-side dependencies.
@@ -154,24 +157,26 @@ fitch-js/
 └── package.json
 ```
 
-## Development Setup
+## Installation
 
-1. Clone the repository
-2. Install dependencies:
-   ```bash
-   cd fitch-js
-   npm install
-   ```
-3. Run tests:
-   ```bash
-   npm test
-   ```
+```bash
+npm install fitch-js
+```
+
+Or with yarn:
+
+```bash
+yarn add fitch-js
+```
 
 ## Usage
 
 ```javascript
-const { parseFormula } = require('./src/parser');
-const { checkProof } = require('./src/proofChecker');
+// ESM
+import { parseFormula, checkProof, parseProofText } from 'fitch-js';
+
+// CommonJS
+const { parseFormula, checkProof, parseProofText } = require('fitch-js');
 
 // Example: Existential Elimination
 const proof = {
@@ -251,6 +256,22 @@ Restrictions:
 - Subproof must start with assumption P(c)
 - Q must be derivable from the subproof
 
+## Development
+
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+3. Run tests:
+   ```bash
+   npm test
+   ```
+4. Build:
+   ```bash
+   npm run build
+   ```
+
 ## Contributing
 
 Contributions are welcome! Please feel free to submit a Pull Request. Before contributing:

package/dist/cjs/index.js

@@ -75,6 +75,12 @@ Object.defineProperty(exports, "getLineForPosition", {
     return _index.getLineForPosition;
   }
 });
+Object.defineProperty(exports, "getProofLineForDocumentLine", {
+  enumerable: true,
+  get: function get() {
+    return _index.getProofLineForDocumentLine;
+  }
+});
 Object.defineProperty(exports, "isLineAvailable", {
   enumerable: true,
   get: function get() {

package/dist/cjs/proof/index.js

@@ -21,6 +21,12 @@ Object.defineProperty(exports, "getLineForPosition", {
     return _textParser.getLineForPosition;
   }
 });
+Object.defineProperty(exports, "getProofLineForDocumentLine", {
+  enumerable: true,
+  get: function get() {
+    return _textParser.getProofLineForDocumentLine;
+  }
+});
 Object.defineProperty(exports, "parseProofText", {
   enumerable: true,
   get: function get() {

package/dist/cjs/proof/textParser.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getDocumentLineForProofLine = getDocumentLineForProofLine;
 exports.getLineForPosition = getLineForPosition;
+exports.getProofLineForDocumentLine = getProofLineForDocumentLine;
 exports.parseProofText = parseProofText;
 var _parser = require("../parser.js");
 var _symbols = require("../symbols.js");
@@ -59,17 +60,30 @@ function parseProofText(text) {
   var goalText = null;
   /** @type {number[]} */
   var subproofStack = [];
+
+  // Build document line -> proof line mapping for citation translation
+  // Users write document line numbers (1-indexed), we need proof line numbers
+  /** @type {Map<number, number>} */
+  var docToProofLine = new Map();
+  var proofCount = 0;
   for (var i = 0; i < rawLines.length; i++) {
-    var raw = rawLines[i];
-    var trimmed = raw.trim();
+    var trimmed = rawLines[i].trim();
+    if (trimmed && !trimmed.startsWith('//')) {
+      proofCount++;
+      docToProofLine.set(i + 1, proofCount); // 1-indexed doc line -> 1-indexed proof line
+    }
+  }
+  for (var _i = 0; _i < rawLines.length; _i++) {
+    var raw = rawLines[_i];
+    var _trimmed = raw.trim();
 
     // Skip empty lines
-    if (!trimmed) continue;
+    if (!_trimmed) continue;
 
     // Handle comments
-    if (trimmed.startsWith('//')) {
+    if (_trimmed.startsWith('//')) {
       // Check for goal declaration
-      var goalMatch = trimmed.match(/\/\/\s*Goal:\s*(.+)/i);
+      var goalMatch = _trimmed.match(/\/\/\s*Goal:\s*(.+)/i);
       if (goalMatch) {
         goalText = goalMatch[1].trim();
         try {
@@ -95,38 +109,55 @@ function parseProofText(text) {
     }
 
     // Parse the line content (strip leading pipes and whitespace)
-    var content = trimmed.replace(/^\|+\s*/, '');
+    var content = _trimmed.replace(/^\|+\s*/, '');
     var colonIndex = content.lastIndexOf(':');
     var formulaText = '';
     var ruleText = '';
     /** @type {number[]} */
     var citations = [];
     /** @type {SubproofCitation[]} */
-    var subproofCitations = [];
+    var subproofs = [];
+    /** @type {string[]} */
+    var issues = [];
     if (colonIndex !== -1) {
       formulaText = content.substring(0, colonIndex).trim();
       var rulePart = content.substring(colonIndex + 1).trim();
       var ruleParts = rulePart.split(/\s+/);
       ruleText = ruleParts[0] || '';
 
-      // Parse citations
+      // Parse citations - translate from document line numbers to proof line numbers
       for (var j = 1; j < ruleParts.length; j++) {
         var cit = ruleParts[j];
         if (cit.includes('-')) {
           var _cit$split$map = cit.split('-').map(Number),
             _cit$split$map2 = _slicedToArray(_cit$split$map, 2),
-            start = _cit$split$map2[0],
-            end = _cit$split$map2[1];
-          if (!isNaN(start) && !isNaN(end)) {
-            subproofCitations.push({
-              start: start,
-              end: end
-            });
+            startDoc = _cit$split$map2[0],
+            endDoc = _cit$split$map2[1];
+          if (!isNaN(startDoc) && !isNaN(endDoc)) {
+            // Translate document lines to proof lines
+            var start = docToProofLine.get(startDoc);
+            var end = docToProofLine.get(endDoc);
+            if (start === undefined || end === undefined) {
+              // Invalid citation - reference to non-proof line (comment/blank)
+              issues.push("Invalid subproof citation ".concat(cit, ": references non-proof line"));
+            } else {
+              subproofs.push({
+                start: start,
+                end: end
+              });
+            }
           }
         } else {
-          var num = parseInt(cit, 10);
-          if (!isNaN(num)) {
-            citations.push(num);
+          var docLineNum = parseInt(cit, 10);
+          if (!isNaN(docLineNum)) {
+            // Translate document line to proof line
+            var proofLineNum = docToProofLine.get(docLineNum);
+            if (proofLineNum === undefined) {
+              // Invalid citation - reference to non-proof line (comment/blank)
+              issues.push("Invalid citation ".concat(docLineNum, ": references non-proof line"));
+            } else {
+              citations.push(proofLineNum);
+            }
           }
         }
       }
@@ -137,8 +168,6 @@ function parseProofText(text) {
     // Parse formula
     /** @type {Formula|null} */
     var formula = null;
-    /** @type {string[]} */
-    var issues = [];
     try {
       if (formulaText) {
         formula = (0, _parser.parseFormula)((0, _symbols.convertAsciiToSymbols)(formulaText));
@@ -161,7 +190,7 @@ function parseProofText(text) {
       formula: formula,
       rule: normalizedRule,
       citations: citations,
-      subproofCitations: subproofCitations,
+      subproofs: subproofs,
       depth: depth,
       location: [].concat(subproofStack),
       issues: issues
@@ -219,4 +248,28 @@ function getDocumentLineForProofLine(text, proofLineNum) {
     }
   }
   return 0;
+}
+
+/**
+ * Finds the proof line number for a given document line number
+ *
+ * @param {string} text - The original document text
+ * @param {number} documentLineNum - The 1-indexed document line number (as users see it)
+ * @returns {number} The 1-indexed proof line number, or 0 if not a proof line
+ */
+function getProofLineForDocumentLine(text, documentLineNum) {
+  var textLines = text.split('\n');
+  var proofLineCount = 0;
+  var targetIndex = documentLineNum - 1; // Convert to 0-indexed
+
+  for (var i = 0; i < textLines.length; i++) {
+    var trimmed = textLines[i].trim();
+    if (trimmed && !trimmed.startsWith('//')) {
+      proofLineCount++;
+      if (i === targetIndex) {
+        return proofLineCount;
+      }
+    }
+  }
+  return 0; // Not a valid proof line
 }

package/dist/cjs/proof/types.js

@@ -21,7 +21,7 @@ exports["default"] = exports.RULE_MAP = void 0;
  * @property {Formula|null} formula - The parsed formula, or null if parsing failed
  * @property {string} rule - The normalized rule name (e.g., '∧I', 'Pr')
  * @property {number[]} citations - Line numbers cited in justification
- * @property {SubproofCitation[]} subproofCitations - Subproof ranges cited
+ * @property {SubproofCitation[]} subproofs - Subproof ranges cited
  * @property {number} depth - Subproof nesting depth (0 = main proof)
  * @property {number[]} location - Path through subproof tree
  * @property {string[]} issues - Parse errors for this line

package/dist/esm/index.js

@@ -14,4 +14,4 @@ export { isVariable, isLineAvailable, isValidCitation } from './ruleValidators.j
 export { convertAsciiToSymbols, convertSymbolsToAscii, symbolMappings } from './symbols.js';
 
 // Text-format proof parsing
-export { parseProofText, getLineForPosition, getDocumentLineForProofLine, RULE_MAP } from './proof/index.js';
+export { parseProofText, getLineForPosition, getDocumentLineForProofLine, getProofLineForDocumentLine, RULE_MAP } from './proof/index.js';

package/dist/esm/proof/index.js

@@ -3,5 +3,5 @@
  * @module proof
  */
 
-export { parseProofText, getLineForPosition, getDocumentLineForProofLine } from './textParser.js';
+export { parseProofText, getLineForPosition, getDocumentLineForProofLine, getProofLineForDocumentLine } from './textParser.js';
 export { RULE_MAP } from './types.js';

package/dist/esm/proof/textParser.js

@@ -54,17 +54,30 @@ export function parseProofText(text) {
   var goalText = null;
   /** @type {number[]} */
   var subproofStack = [];
+
+  // Build document line -> proof line mapping for citation translation
+  // Users write document line numbers (1-indexed), we need proof line numbers
+  /** @type {Map<number, number>} */
+  var docToProofLine = new Map();
+  var proofCount = 0;
   for (var i = 0; i < rawLines.length; i++) {
-    var raw = rawLines[i];
-    var trimmed = raw.trim();
+    var trimmed = rawLines[i].trim();
+    if (trimmed && !trimmed.startsWith('//')) {
+      proofCount++;
+      docToProofLine.set(i + 1, proofCount); // 1-indexed doc line -> 1-indexed proof line
+    }
+  }
+  for (var _i = 0; _i < rawLines.length; _i++) {
+    var raw = rawLines[_i];
+    var _trimmed = raw.trim();
 
     // Skip empty lines
-    if (!trimmed) continue;
+    if (!_trimmed) continue;
 
     // Handle comments
-    if (trimmed.startsWith('//')) {
+    if (_trimmed.startsWith('//')) {
       // Check for goal declaration
-      var goalMatch = trimmed.match(/\/\/\s*Goal:\s*(.+)/i);
+      var goalMatch = _trimmed.match(/\/\/\s*Goal:\s*(.+)/i);
       if (goalMatch) {
         goalText = goalMatch[1].trim();
         try {
@@ -90,38 +103,55 @@ export function parseProofText(text) {
     }
 
     // Parse the line content (strip leading pipes and whitespace)
-    var content = trimmed.replace(/^\|+\s*/, '');
+    var content = _trimmed.replace(/^\|+\s*/, '');
     var colonIndex = content.lastIndexOf(':');
     var formulaText = '';
     var ruleText = '';
     /** @type {number[]} */
     var citations = [];
     /** @type {SubproofCitation[]} */
-    var subproofCitations = [];
+    var subproofs = [];
+    /** @type {string[]} */
+    var issues = [];
     if (colonIndex !== -1) {
       formulaText = content.substring(0, colonIndex).trim();
       var rulePart = content.substring(colonIndex + 1).trim();
       var ruleParts = rulePart.split(/\s+/);
       ruleText = ruleParts[0] || '';
 
-      // Parse citations
+      // Parse citations - translate from document line numbers to proof line numbers
       for (var j = 1; j < ruleParts.length; j++) {
         var cit = ruleParts[j];
         if (cit.includes('-')) {
           var _cit$split$map = cit.split('-').map(Number),
             _cit$split$map2 = _slicedToArray(_cit$split$map, 2),
-            start = _cit$split$map2[0],
-            end = _cit$split$map2[1];
-          if (!isNaN(start) && !isNaN(end)) {
-            subproofCitations.push({
-              start: start,
-              end: end
-            });
+            startDoc = _cit$split$map2[0],
+            endDoc = _cit$split$map2[1];
+          if (!isNaN(startDoc) && !isNaN(endDoc)) {
+            // Translate document lines to proof lines
+            var start = docToProofLine.get(startDoc);
+            var end = docToProofLine.get(endDoc);
+            if (start === undefined || end === undefined) {
+              // Invalid citation - reference to non-proof line (comment/blank)
+              issues.push("Invalid subproof citation ".concat(cit, ": references non-proof line"));
+            } else {
+              subproofs.push({
+                start: start,
+                end: end
+              });
+            }
           }
         } else {
-          var num = parseInt(cit, 10);
-          if (!isNaN(num)) {
-            citations.push(num);
+          var docLineNum = parseInt(cit, 10);
+          if (!isNaN(docLineNum)) {
+            // Translate document line to proof line
+            var proofLineNum = docToProofLine.get(docLineNum);
+            if (proofLineNum === undefined) {
+              // Invalid citation - reference to non-proof line (comment/blank)
+              issues.push("Invalid citation ".concat(docLineNum, ": references non-proof line"));
+            } else {
+              citations.push(proofLineNum);
+            }
           }
         }
       }
@@ -132,8 +162,6 @@ export function parseProofText(text) {
     // Parse formula
     /** @type {Formula|null} */
     var formula = null;
-    /** @type {string[]} */
-    var issues = [];
     try {
       if (formulaText) {
         formula = parseFormula(convertAsciiToSymbols(formulaText));
@@ -156,7 +184,7 @@ export function parseProofText(text) {
       formula: formula,
       rule: normalizedRule,
       citations: citations,
-      subproofCitations: subproofCitations,
+      subproofs: subproofs,
       depth: depth,
       location: [].concat(subproofStack),
       issues: issues
@@ -214,4 +242,28 @@ export function getDocumentLineForProofLine(text, proofLineNum) {
     }
   }
   return 0;
+}
+
+/**
+ * Finds the proof line number for a given document line number
+ *
+ * @param {string} text - The original document text
+ * @param {number} documentLineNum - The 1-indexed document line number (as users see it)
+ * @returns {number} The 1-indexed proof line number, or 0 if not a proof line
+ */
+export function getProofLineForDocumentLine(text, documentLineNum) {
+  var textLines = text.split('\n');
+  var proofLineCount = 0;
+  var targetIndex = documentLineNum - 1; // Convert to 0-indexed
+
+  for (var i = 0; i < textLines.length; i++) {
+    var trimmed = textLines[i].trim();
+    if (trimmed && !trimmed.startsWith('//')) {
+      proofLineCount++;
+      if (i === targetIndex) {
+        return proofLineCount;
+      }
+    }
+  }
+  return 0; // Not a valid proof line
 }

package/dist/esm/proof/types.js

@@ -15,7 +15,7 @@
  * @property {Formula|null} formula - The parsed formula, or null if parsing failed
  * @property {string} rule - The normalized rule name (e.g., '∧I', 'Pr')
  * @property {number[]} citations - Line numbers cited in justification
- * @property {SubproofCitation[]} subproofCitations - Subproof ranges cited
+ * @property {SubproofCitation[]} subproofs - Subproof ranges cited
  * @property {number} depth - Subproof nesting depth (0 = main proof)
  * @property {number[]} location - Path through subproof tree
  * @property {string[]} issues - Parse errors for this line

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fitch-js",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "A JavaScript library for validating Fitch-style natural deduction proofs",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -42,4 +42,4 @@
     "jest": "^29.7.0",
     "typescript": "^5.3.3"
   }
-} 
+}