Skip to content

Conversation

@richecr
Copy link
Owner

@richecr richecr commented May 25, 2025

This pull request introduces significant changes to the project, including migrating the build and runtime environment from Node.js to Bun, improving documentation, updating the monad library, and enhancing the development tooling. Below is a breakdown of the most important changes:

Migration to Bun

  • Replaced Node.js with Bun in workflows (.github/workflows/publish-release.yml, .github/workflows/test.yml) and updated commands for dependency installation, testing, and building. [1] [2]
  • Updated CONTRIBUTING.md and docs/contributing.md to reflect the use of Bun for installation, testing, and building. [1] [2] [3]
  • Added a bunfig.toml file with coverage thresholds and reporters.
  • Introduced a new build.ts file to handle Bun's build process with TypeScript support via bun-plugin-dts.

Monad Library Enhancements

  • Released version 1.0.0 with the first stable implementation of Maybe, Either, and Result monads, along with curried functions for functional composition.
  • Improved type annotations and examples in the documentation for Either, Maybe, and Result monads. [1] [2] [3] [4]

Documentation Updates

  • Updated docs/changelog.md to include details about the 1.0.0 release, emphasizing the migration to Bun and modular imports.
  • Improved examples and fixed inconsistencies in monad usage in docs/either/index.md, docs/maybe/index.md, and docs/result/index.md. [1] [2] [3]

Development Tooling

  • Replaced .editorconfig with Bun's configuration and removed .nvmrc as Node.js is no longer used. [1] [2]
  • Enhanced eslint.config.js with Prettier and Security plugins and updated rules for better code quality.
  • Updated package.json to reflect the migration to Bun, added new scripts, and adjusted dependencies and peer dependencies. [1] [2]

Miscellaneous

  • Updated copyright year in mkdocs.yml to reflect the current year.

These changes collectively modernize the project, improve performance, and enhance the developer experience.

@richecr richecr merged commit bd26a2c into main May 25, 2025
1 check passed
@richecr richecr deleted the feat/migrate_to_bun branch May 28, 2025 22:39
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