add-package

Scaffold and standardize Remix packages to match monorepo conventions.

33.3k|2.8k|Updated Oct 26, 2020
One-click install
npx skills add https://github.com/remix-run/remix --skill add-package-remix-run
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: add-package
Source: https://github.com/remix-run/remix/tree/main/.agents/skills/add-package
Command: npx skills add https://github.com/remix-run/remix --skill add-package-remix-run

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Create or align a package in the Remix monorepo to match existing package conventions, ensuring consistent structure, tests, and docs across packages.

Core Features & Use Cases

  • Scaffold new packages under packages/ with standard files (package.json, tsconfig.json, tsconfig.build.json, CHANGELOG.md, README.md, LICENSE, .changes/README.md, src/) and set up baseline configuration to mirror Remix 3 patterns.
  • Align an existing package to Remix 3 conventions (folder layout, test setup, TypeScript/build config, exports, and README structure) to ensure consistency and interoperability.

Quick Start

Create the package directory and baseline files, then configure package.json, tsconfig, tests, and README to mirror @remix-run/* packages.

Frequently Asked Questions about add-package

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

FAQPage Schema
How do I scaffold a new package in a Remix monorepo?▼

Scaffold a new Remix package by creating the directory under packages/ and generating baseline files like package.json, tsconfig.json, and README.md. This workflow ensures the new package mirrors Remix 3 patterns and satisfies monorepo requirements.

What's the best way to align an existing package's structure to Remix 3 conventions?▼

Align an existing package to Remix 3 conventions by updating its folder layout, test setup, TypeScript/build config, and exports configuration. This standardizes package structure to ensure consistency and interoperability across the Remix monorepo.

What files do I need to set up when creating a package under packages/?▼

Creating a package requires standard files including package.json, tsconfig.json, tsconfig.build.json, CHANGELOG.md, README.md, LICENSE, and a src/ directory. You also need a .changes/README.md to match existing Remix package conventions.

Can I use this workflow to standardize package.json exports configuration for Remix packages?▼

Yes, you can use this workflow to enforce package.json layout and exports configuration. It standardizes the package.json structure to match @remix-run/* packages, ensuring proper module resolution and build setup within the monorepo.

Does scaffolding a Remix package include test and documentation setup?▼

Scaffolding a Remix package includes baseline test setup and documentation style enforcement. It configures test environments and generates a README.md following Remix standards, ensuring tests and docs are consistent with other packages.

Why does my existing Remix package fail monorepo consistency checks?▼

Your package likely fails monorepo consistency checks because its structure, TypeScript config, or README layout deviates from Remix 3 standards. Aligning the package's folder layout, tests, and exports configuration enforces the required conventions.