Skip to content

Latest commit

 

History

History
167 lines (114 loc) · 8.46 KB

README.md

File metadata and controls

167 lines (114 loc) · 8.46 KB
Raw

Radashi

Radashi

License Build Status Codecov Code Style: Biome.js GitHub Discussions Gitter.im

English | Português

Ditch the bloat of Lodash. Stop reinventing the wheel.

Radashi (pronounced /ruh-DAH-shee/) is a TypeScript utility toolkit, packed with lightweight functions that are readable, performant, and robust.

Radashi is an actively maintained fork of Radash, the fastest growing Lodash alternative with 100K+ weekly downloads.

“What makes Radashi so great?”

  • unique and well-designed functions
  • tree-shakeable (use only what you need!)
  • dependency-free
  • community-first (your opinions matter)
  • future-proof (written with modern ES6+ syntax)
  • actively maintained (with a growing team of passionate maintainers)
  • type-safe (the best type definitions possible)
  • full test coverage
  • performance tracking (we track perf regressions with continuous benchmarking)
  • well-documented
  • nightly releases (radashi@beta)
  • changelog (easily see what's new in each release)

If you've been using Radash (our predecessor), you're probably interested in what makes us different. Read our comparison post to learn how we're bringing Radash to the next level while preserving its best features.

Radash documentation

Install

pnpm add radashi
yarn add radashi
npm install radashi

Beta versions

Beta versions are published regularly with new functions and improvements. They never contain breaking changes (see the Breaking changes section). The beta branch contains the source code for beta versions.

To get notified of a new beta version, watch the radashi-canary repository. You can find release notes for beta versions here.

The latest beta version can be installed with:

pnpm add radashi@beta -E

The -E flag ensures that the beta version is installed as an exact version (e.g. [email protected]). This is recommended to avoid accidental breakage.

Breaking changes

Preview releases for the next major version are also announced in the radashi-canary repository. The next branch contains the source code for the next major version.

We'd appreciate your help testing the latest next version before it's released:

pnpm add radashi@next -E

JSR.io

Radashi is also published to the JSR registry, which gives Radashi its own page.

jsr add @radashi-org/radashi
deno add @radashi-org/radashi

FAQ

  • “I need XYZ, but Radashi doesn't have it.”
    If you have a need not met by our current set of functions, we want to hear about it. Start a discussion so we can explore the idea together!

  • What does “community first” mean exactly?
    It means putting the community's needs first, leaning towards adding support for popular use cases, as opposed to being strictly minimalist. As such, your feedback is very welcome and we value your perspective. Specifically, we want you to contribute your viewpoint to discussions in our RFCs category.

  • Are my contributions welcome?
    Yes! Pull requests are encouraged, but please keep them small and focused. Sweeping changes are discouraged and won't be merged (unless the rationale's been thoroughly discussed).

    Please review “The ethos of Radashi” before submitting a pull request:

    The ethos of Radashi

  • Can I help you maintain this?
    Yes! I'll add you as a contributor to the repository. You can review pull requests and help with triage. With time, you may earn the ability to merge approved PRs.

    Apply to join the Radashi team

  • Is backwards compatibility a goal?
    Yes! We want the transition from radash to this library to be smooth. If you're coming from Radash, we recommend installing radashi@^12. This version will continue to receive backported fixes even after Radashi v13 is released. You can upgrade to the latest major version when you're ready.

  • Automatic releases
    To ensure contributions are quickly rolled out, we have the following automatic processes:

    • Patch releases
      Whenever the main branch receives a ^fix: commit, a patch release is immediately published to NPM.

    • Beta releases
      Pull requests that add a new feature can be labeled with prerelease by a maintainer. This triggers a GitHub workflow that attempts to copy the PR into the beta branch. If that succeeds, a beta release is immediately published to NPM.

      Installing radashi@beta will always fetch the latest beta release. Although the name "beta" may suggest unstable code, PRs need tests to be eligible for a prerelease.

      Beta releases provide quick access to new features without waiting for a regular release cycle. They're also an opportunity for the community to provide feedback before the feature is released to the main branch.

    • "Next" releases
      Pull requests with breaking changes can also be labeled with prerelease by a maintainer. In this case, the PR is copied into the next branch. If that succeeds, a "next" release is published to NPM.

      Installing radashi@next will always fetch the latest "next" release.

  • Release cycle
    Radashi is expected to release a new minor or major version on a monthly basis, but releases are not on a strict schedule. Pre-releases are available for testing and feedback before the final release.

Contributing

Contributions are welcome and appreciated! Check out the contributing guide before you dive in:

Contributing to Radashi

 

Radashi