chop-logic-core
v0.1.2
Published
An npm package for core functions of the Chop Logic project.
Downloads
212
Maintainers
Readme
Chop Logic Core
Chop Logic Core is a TypeScript library providing core functions for working with symbolic logic formulas. It is part of the broader Chop Logic project and offers essential utilities for propositional logic processing.
🚀 Current Status: The library is under active development, but several tested functions are already available for use in third-party projects.
✨ Features
- Propositional Converter – Converts logic formulas between different formats.
- Propositional XML Converter – Converts logic expressions to and from XML.
- Truth Table Generator – Generates truth tables for given propositional logic formulas.
- Propositional Executor – Evaluates logical formulas against a set of variable values.
- Propositional Validator – Checks the syntactic correctness of logic formulas.
- Propositional Replacer – Replaces logical symbols with alternative representations.
📦 Installation
You can install chop-logic-core
via npm:
npm install chop-logic-core
Or using yarn:
yarn add chop-logic-core
🔧 Usage
import { convertFormula, generateTruthTable } from 'chop-logic-core';
const formula = 'A ∧ B → C';
const converted = convertFormula(formula);
console.log(converted);
const truthTable = generateTruthTable(formula);
console.table(truthTable);
⚙️ Available Scripts
The following npm scripts are available for development and maintenance:
npm run clean
– Removes the generatedlib
folder.npm run build
– Builds both ESM and CJS versions of the library.npm run lint
– Runs ESLint to check for code quality issues.npm run lint:fix
– Runs ESLint with automatic fixes.npm run test
– Runs Jest in watch mode.npm run test:ci
– Runs Jest in CI mode, allowing zero tests to pass.npm run coverage
– Generates a test coverage report.
🛠 Contributing
Contributions are welcome! If you find a bug or have an idea for improvement, feel free to open an issue or submit a pull request. Please check the Countribution guide for additional info.
- Fork the repository.
- Clone your fork.
- Create a new feature branch.
- Implement and test your changes.
- Submit a pull request!
📄 License
This project is licensed under LGPL-3.0-or-later. See the LICENSE file for details.
🔗 Links
- GitHub Repository: chop-logic-core
- Issue Tracker: Report Issues
- npm package: chop-logic-core
Let's build better logic tools together! 🚀