Skip to content

Conversation

Copy link

Copilot AI commented Jan 24, 2026

README restructuring to separate origins from description and improve section ordering.

Changes

  • New "Origins" section (before License): Documents expr-eval 2.0.2 lineage, modular architecture rewrite, TypeScript/Vitest adoption, and expanded scope beyond mathematical expressions
  • Updated "Description" section: Refocused on library's versatility for strings, objects, and arrays rather than just math
  • Moved "Playground Example": Now above "Documentation" section for better discoverability
Original prompt
  1. Create a documentation section named "Origins" that explains:
    That the library was originally based on expr-eval 2.0.2, butn has been restructured with a modular architecture, TypeScript support, and comprehensive testing using Vitest.
    That expr-eval was only focused on mathemacial expressions where this library aims at being a tool to evaluate expressions that can manipulate string, objects and arrays.
    Put it on the bottom, just before the license section.

  2. Create a new "Description" section

  3. Move the Playground Example section above the Documentations section


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: Sander-Toonen <5106372+Sander-Toonen@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation sections and reorganization Restructure README documentation sections Jan 24, 2026
Copilot AI requested a review from Sander-Toonen January 24, 2026 02:35
@Sander-Toonen Sander-Toonen marked this pull request as ready for review January 24, 2026 02:40
Copilot AI review requested due to automatic review settings January 24, 2026 02:40
@Sander-Toonen Sander-Toonen merged commit d17e752 into master Jan 24, 2026
12 checks passed
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Restructures the README to better separate project background from the main description and improve section ordering for discoverability.

Changes:

  • Refocuses the Description section on broader expression capabilities (strings/objects/arrays), not just math.
  • Moves Playground Example above Documentation.
  • Adds a new Origins section near the end (before License) describing lineage and modernization.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

**This is a modern TypeScript port of the expr-eval library, completely rewritten with contemporary build tools and development practices.** Originally based on [expr-eval 2.0.2](http://silentmatt.com/javascript-expression-evaluator/), this version has been restructured with a modular architecture, TypeScript support, and comprehensive testing using Vitest.

Parses and evaluates mathematical expressions. It's a safer and more math-oriented alternative to using JavaScript's `eval` function for mathematical expressions.
A versatile expression evaluation library that goes beyond mathematical expressions. It parses and evaluates expressions that can manipulate strings, objects, and arrays, providing a safer alternative to JavaScript's `eval` function.
Copy link

Copilot AI Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated README description says the library goes beyond mathematical expressions (strings/objects/arrays), but the published docs still frame it as a mathematical expression evaluator (e.g., docs/index.md:5 and docs/index.md:11). This creates conflicting messaging for users. Consider updating the docs’ intro/tagline to match this new positioning, or rewording the README description to stay consistent with the existing docs until those are updated.

Suggested change
A versatile expression evaluation library that goes beyond mathematical expressions. It parses and evaluates expressions that can manipulate strings, objects, and arrays, providing a safer alternative to JavaScript's `eval` function.
A mathematical expression evaluation library for JavaScript. It parses and evaluates expressions with support for numbers, strings, objects, and arrays, providing a safer alternative to JavaScript's `eval` function.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants