remeda-utility

Apply a deterministic workflow to implement, test, document, export, and map Remeda utilities.

5.4k|168|Updated May 7, 2018
One-click install
npx skills add https://github.com/remeda/remeda --skill remeda-utility
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: remeda-utility
Source: https://github.com/remeda/remeda/tree/main/.agents/skills/remeda-utility
Command: npx skills add https://github.com/remeda/remeda --skill remeda-utility

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill prevents half-shipped Remeda changes by guiding you through implementation, tests, JSDoc, exports, and (when applicable) migration mapping pages so every function is correct and discoverable.

Core Features & Use Cases

  • End-to-end function authoring checklist: implement the runtime and types, then validate behavior with runtime tests, type tests, and optional property-based tests.
  • Strict test separation & conventions: keeps expect() in .test.ts and expectTypeOf() in .test-d.ts to avoid mixed assertion modes.
  • JSDoc quality guardrails: enforces required tags like @signature, @example, @dataFirst/@dataLast, and @category per overload.
  • Export and migration completeness: ensures the function is re-exported from src/index.ts and that Lodash/Ramda/Just-equivalent functions include mapping pages.

Quick Start

Use this skill when you modify code in packages/remeda/src/ or a mapping page under packages/docs/src/content/mapping/{lodash,ramda,just}/ to follow the ordered checklist for implementation, tests, JSDoc, export wiring, and any required migration pages.

Frequently Asked Questions about remeda-utility

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add JSDoc tags for Remeda function overloads?

To add JSDoc for Remeda functions, include required tags like @signature, @example, @dataFirst or @dataLast, and @category for each overload to ensure proper documentation and discoverability.

Why separate runtime and type tests for TypeScript utility functions?

Separating runtime and type tests keeps expect() assertions in .test.ts files and expectTypeOf() checks in .test-d.ts files, preventing mixed assertion modes and maintaining strict test conventions.

What is the best way to map Lodash or Ramda functions to Remeda equivalents?

The best way to map Lodash, Ramda, or Just equivalents is by creating migration mapping pages under the packages/docs/src/content/mapping/ directory following specific page conventions.

How do I export a new Remeda utility function from the main index?

To export a new Remeda utility, ensure the function is re-exported alphabetically from the src/index.ts file, completing the end-to-end authoring checklist for full discoverability.

Does my Remeda function need a specific API structure to pass code review?

Yes, Remeda functions require a purry-based API structure to pass code review, ensuring the implementation aligns with the deterministic workflow for runtime, types, and documentation.

What steps are required to ship a Remeda utility function end-to-end?

Shipping a Remeda utility requires implementing runtime and types, validating behavior with separated runtime and type tests, adding mandated JSDoc, exporting alphabetically, and updating migration pages.