К основному содержанию
правило CX Codex

npm — правило для Claude Code: что делает и как установить

Правило npm для Claude Code задаёт стандарты публикации компонентов в виде пакетов с версионированием. Настраивает package.json, сборку через tsup и директивы Tailwind.

Apache-2.0 ★ 141 обновлён 2026-11-17

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/rules/npm.md
Открыть на GitHub

Что делает npm

Правило инструктирует ассистента, как оформлять UI-библиотеки для распространения через реестр npm. Оно требует выносить React в peerDependencies, настраивать поле exports под ESM и CommonJS, генерировать типы TypeScript и ограничивать список файлов через массив files.

В инструкциях разобран шаблон сборки на базе tsup с хуком prepublishOnly. Для стилей на Tailwind правило требует документировать директиву @source с путем к node_modules, иначе сканер классов не увидит внешние компоненты.

Какие задачи решает

  • настроить package.json для публикации библиотеки с типами TypeScript
  • разделить зависимости на peerDependencies и обычные зависимости
  • прописать пути сборки под CommonJS и ESM в поле exports
  • сконфигурировать директиву Tailwind CSS для сканирования пакета

Примеры запросов агенту

  • Помоги оформить package.json для публикации UI-компонентов в npm
  • Настрой скрипт сборки tsup для генерации ESM, CJS и типов d.ts
  • Как правильно подключить стили Tailwind из внешнего пакета?

Как установить npm

Вручную: положить файлы

.claude/rules/npm.md

Поле paths во frontmatter ограничивает файлы

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Вопросы о npm

Как установить npm в Claude Code?

Скопируйте файл правила в проект по пути .claude/rules/npm.md.

Зачем нужно правило npm?

Оно помогает ассистенту правильно конфигурировать публикацию пакетов, предотвращая типичные ошибки с резолвом модулей и зависимостями React.

Что нужно для работы сборки по правилу npm?

В проекте используется сборщик tsup, генерирующий бандлы форматов CJS и ESM вместе с файлами деклараций типов.

Исходный текст

npm.md · Apache-2.0
---
title: Publishing to NPM
impact: LOW
impactDescription: Traditional package distribution
tags: npm, package, publishing, versioning, exports
---

## Publishing Components to NPM

Distribute components as npm packages for stable, versioned dependencies with centralized updates.

### When to Use NPM

Choose npm when:

- Users need stable, versioned dependencies
- Centralized control over updates
- Automatic dependency resolution
- Users don't need source code access

### Package Configuration

**Bad:**

```json
{
  "name": "@acme/ui-components",
  "version": "1.0.0",
  "main": "./src/index.ts",
  "types": "./src/index.ts",
  "dependencies": {
    "react": "^18.0.0",
    "react-dom": "^18.0.0"
  }
}
```

Missing `exports` field, pointing to source files instead of built dist, and including React in dependencies instead of peerDependencies.

**Correct:**

```json
{
  "name": "@acme/ui-components",
  "version": "1.0.0",
  "description": "Accessible React components",
  "main": "./dist/index.js",
  "module": "./dist/index.mjs",
  "types": "./dist/index.d.ts",
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.mjs",
      "require": "./dist/index.js"
    },
    "./styles.css": "./dist/styles.css"
  },
  "files": ["dist"],
  "scripts": {
    "build": "tsup",
    "prepublishOnly": "npm run build"
  },
  "peerDependencies": {
    "react": "^18.0.0",
    "react-dom": "^18.0.0"
  },
  "dependencies": {
    "clsx": "^2.0.0",
    "tailwind-merge": "^2.0.0"
  }
}
```

**Key points:**

- Use `exports` for modern module resolution
- Include ESM (`module`) and CommonJS (`main`)
- Specify `types` for TypeScript
- Use `peerDependencies` for React
- Limit published files with `files` array

### Tailwind Configuration

**Critical:** Document this requirement for Tailwind-based components:

**Example:**

```css
@import "tailwindcss";

/* Users must add this to scan your package */
@source "../node_modules/@acme/ui-components";
```

### Build and Publish

**Example:**

```json
{
  "scripts": {
    "build": "tsup src/index.ts --format cjs,esm --dts",
    "prepublishOnly": "npm run build"
  }
}
```

**Steps:**

1. Build (`npm run build`)
2. Verify `dist` contents
3. Update version (`npm version patch|minor|major`)
4. Publish (`npm publish`)

### Trade-offs

**Source Code:**

- Users cannot modify directly
- Bug fixes require package updates
- Customization limited to exposed API

**Bundle Size:**

- All components included
- Tree-shaking helps but imperfect

**Customization:**

- Work within exposed API only
- Forking required for deep changes

### Usage

**Example:**

```bash
npm install @acme/ui-components
```

```tsx
import { Button } from "@acme/ui-components";

// Pre-built, versioned code from node_modules
```

### Choosing Distribution

**npm when:**

- Stable, versioned dependencies needed
- Centralized updates preferred
- Source access not required

**Registry when:**

- Source code access needed
- Customization beyond props important
- Copy-paste workflow preferred

Consider offering both to let developers choose.

© maxtrigify · Apache-2.0 · maxtrigify/Otto

Похожие правила IDE

Все правила IDE по теме «Фронтенд и UI» →
updating-npm-package spencerpauly Скилл updating-npm-package для Claude Code обновляет npm-пакеты: сверяет версии через npmjs.com и составляет отчёт о миграции при мажорных релизах. CX Codex +1 438установок npm-package jwynia Скилл npm-package ведёт агента через создание npm-библиотеки на Bun: скаффолдинг, строгий TypeScript, тесты, сборка и публикация. CX Codex +1 335установок migrate-to-rslib rstackjs Скилл migrate-to-rslib переводит сборку библиотек с tsc или tsup на Rslib с проверкой билда и сохранением исходного кода. CX Codex +1 201установок check-npm grafana Скилл check-npm проверяет конфигурацию пакетного менеджера в JS/TS-репозитории: версии инструментов, lifecycle-скрипты, опасные протоколы зависимостей и минимальный возраст релиза. CX Codex +1 3 200установок npm-security-best-practices reason-machines Скилл npm-security-best-practices для Claude Code защищает npm-зависимости от атак на цепочку поставок и настраивает безопасную установку пакетов. Охватывает Node.js-проекты. CX Codex +1 925установок bootstrap-npm twbs Скилл bootstrap-npm для Claude Code и Cursor собирает стартовый проект на Bootstrap 6 через npm и командную строку без бандлера. Запускается при настройке Bootstrap в проекте с npm или компиляции Sass в CSS. CX Codex +1 639установок

Из того же набора18

Весь набор →
registry Правило registry для Claude Code описывает публикацию UI-компонентов как исходного кода. Оно задаёт формат метаданных и шаги размещения реестра. CX Codex +1 ★ 141звёзд репо marketplaces Правило marketplaces для Claude Code систематизирует поиск и интеграцию компонентов из внешних реестров. Оно помогает агенту оценивать качество готового кода перед добавлением в проект. CX Codex +1 ★ 141звёзд репо design-tokens Правило design-tokens для Claude Code заменяет жёстко заданные цвета семантическими токенами. Переключение светлой и тёмной темы меняет значения переменных, а не классы компонентов. CX Codex +1 ★ 141звёзд репо composition Правило composition для Claude Code помогает разбивать крупные UI-компоненты на небольшие субагенты с четкими задачами. Оно применяется при проектировании библиотек и сложных интерфейсов. CX Codex +1 ★ 141звёзд репо overview Правило overview для Claude Code задаёт принципы создания доступных и составных UI-компонентов. Оно подключается при проектировании компонентов и их API. CX Codex +1 ★ 141звёзд репо types Правило types для Claude Code стандартизирует описание пропсов компонентов в TypeScript. Оно задаёт архитектуру для создания гибких и типизированных интерфейсов в React-проектах. CX Codex +1 ★ 141звёзд репо data-attributes Правило data-attributes для Claude Code задаёт паттерны data-state и data-slot для стилизации состояний и связи компонентов. CX Codex +1 ★ 141звёзд репо principles Правило principles для Claude Code, Codex, Cursor, GitHub Copilot, Windsurf и Cline задаёт шесть критериев проектирования компонентов для оценки кода, рефакторинга и создания интерфейсов. CX Codex +1 ★ 141звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой