skillgrid 0.0.18-alpha.20250911T13103 → 0.0.19

package/README.md

@@ -1,211 +1,55 @@
-# Библиотека компонентов Skillgrid
+# Skillgrid
 
-Современная библиотека React-компонентов со встроенной поддержкой i18n, интеграцией Storybook и автоматизированным тестированием.
-
-## Возможности
+**Библиотека компонентов Skillgrid**
 
-- 🌐 Встроенная поддержка i18n с локализацией на уровне компонентов
-- 📚 Интеграция со Storybook
-- ✅ Тестирование с помощью Vitest
-- 🎨 Поддержка CSS Modules
-- 🔧 Настраиваемая генерация компонентов
-- 📦 Поддержка TypeScript
+Современная библиотека React-компонентов со встроенной поддержкой i18n, интеграцией Storybook и автоматизированным тестированием.
 
 ## Установка
 
 ```bash
-yarn install
-```
-
-## Быстрый старт
-
-### Одновременный запуск Storybook и тестов
-
-```bash
-yarn start
-```
-
-### Запуск сервера разработки
-
-```bash
-yarn dev
-```
-
-### Запуск тестов
-
-```bash
-yarn test
-```
-
-### Запуск Storybook
-
-```bash
-yarn storybook
+yarn add skillgrid
 ```
 
-### Сборка библиотеки
+или
 
 ```bash
-yarn build
+npm install skillgrid
 ```
 
-## Документация
-
-Полная документация доступна в формате VitePress в директории `/docs`. 
-
-### Запуск документации локально
-
-```bash
-# Запуск в режиме разработки
-yarn docs
-
-# Сборка документации
-yarn docs:build
-
-# Предпросмотр собранной документации
-yarn docs:preview
-```
-
-### Структура документации
-
-- `/docs/components/` - Документация по компонентам
-- `/docs/locale/` - Система локализации
-- `/docs/generator/` - Генератор компонентов
-
-## Генерация компонентов
-
-Создавайте новые компоненты с помощью CLI:
-
-```bash
-yarn skillgrid generate component MyComponent
-# или короче
-yarn skillgrid g c MyComponent
-```
-
-### Параметры командной строки
-
-Генератор компонентов поддерживает несколько флагов для настройки генерируемых файлов:
-
-```bash
-# Генерация без поддержки i18n
-yarn skillgrid g c MyComponent --no-i18n
-
-# Генерация без хуков
-yarn skillgrid g c MyComponent --no-hooks
-
-# Генерация без историй
-yarn skillgrid g c MyComponent --no-stories
-
-# Комбинация флагов
-yarn skillgrid g c MyComponent --no-i18n --no-hooks --no-stories
-```
-
-## Интернационализация (i18n)
-
-### Локализация на уровне компонентов
-
-Каждый компонент с поддержкой i18n имеет свой файл переводов (`ComponentName.i18n.json`):
-
-```json
-{
-  "en": {
-    "componentname": {
-      "example": "Example text for ComponentName"
-    }
-  },
-  "ru": {
-    "componentname": {
-      "example": "Пример текста для ComponentName"
-    }
-  }
-}
-```
-
-### Пользовательские переводы
-
-Вы можете переопределить стандартные переводы для любого компонента, используя проп `i18n`:
+## Быстрый старт
 
 ```tsx
-<MyComponent 
-  i18n={{
-    en: {
-      mycomponent: {
-        example: "Custom English text",
-        otherKey: "Other text"
-      }
-    },
-    ru: {
-      mycomponent: {
-        example: "Пользовательский русский текст",
-        otherKey: "Другой текст"
-      }
-    }
-  }}
-/>
-```
-
-## Конфигурация
-
-Создайте файл `.skillgridrc.json` в корне вашего проекта для настройки параметров по умолчанию:
-
-```json
-{
-  "componentsDir": "components",
-  "style": "css",
-  "withStories": true,
-  "withHook": true,
-  "withI18n": true,
-  "indexFile": "src/index.ts",
-  "appFile": "src/App.tsx",
-  "storybookUrl": "http://localhost:6006"
+import { Button, ConfigProvider } from 'skillgrid';
+
+function App() {
+  return (
+    // Перед импортом компонентов библиотеки 
+    // приложение следует обернуть в <ConfigProvider>
+    <ConfigProvider>
+      <Button onClick={() => console.log('Clicked!')}>
+        Нажми меня
+      </Button>
+    </ConfigProvider>
+  );
 }
 ```
 
-### Параметры конфигурации
+## Требования
 
-| Опция | Тип | По умолчанию | Описание |
-|-------|-----|--------------|----------|
-| `componentsDir` | string | `"components"` | Директория для генерации компонентов |
-| `style` | string | `"css"` | Формат стилей (css/scss) |
-| `withStories` | boolean | `true` | Генерировать stories |
-| `withHook` | boolean | `true` | Генерировать хуки |
-| `withI18n` | boolean | `true` | Генерировать i18n |
-| `indexFile` | string | `"src/index.ts"` | Путь к главному индексному файлу |
-| `appFile` | string | `"src/App.tsx"` | Путь к файлу приложения |
-| `storybookUrl` | string | `"http://localhost:6006"` | URL Storybook |
+Для работы библиотеки необходимы:
+- `react` версии `17.0.2` или новее
+- `react-dom` версии `17.0.2` или новее
 
-## Структура компонента
 
-При генерации компонента со всеми включенными функциями создаются следующие файлы:
+## Особенности
 
-```
-ComponentName/
-├── ComponentName.tsx           # Основной файл компонента
-├── ComponentName.type.ts      # TypeScript типы
-├── ComponentName.module.css   # Стили
-├── ComponentName.test.tsx     # Тесты
-├── ComponentName.stories.tsx  # Истории Storybook
-├── ComponentName.hook.ts      # Пользовательский хук
-├── ComponentName.i18n.json   # Переводы
-└── index.ts                  # Экспорты
-```
+- 🎯 **Типобезопасность**: Полная поддержка TypeScript.
+- 🌐 **Локализация**: Встроенная и настраиваемая система i18n.
+- 📚 **Документация**: Интерактивная документация компонентов в Storybook.
+- 🛠️ **Инструменты**: CLI для генерации новых компонентов.
+- ⚡️ **Производительность**: Оптимизированные и легковесные компоненты.
+- 🎨 **Стилизация**: Поддержка CSS Modules и темизации.
+
+## Лицензия
 
-## Участие в разработке
-
-1. Сделайте форк репозитория
-2. Создайте ветку для вашей функции (`git checkout -b feature/DEV-XXX-amazing-feature`)
-3. Зафиксируйте ваши изменения (`git commit -m '[DEV-XXX] Добавлена новая функция'`)
-4. Отправьте изменения в ваш форк (`git push origin feature/DEV-XXX-amazing-feature`)
-5. Откройте Merge Request
-
-## Используемые технологии
-
-- React 18.3.1
-- TypeScript 5.8.3
-- Vite 6.3.5
-- Vitest для тестирования
-- Storybook 8.6.12
-- Ant Design 5.25.1
-- ESLint и Prettier для линтинга и форматирования
-- Stylelint для CSS
-- VitePress для документации
+[Документ лицензии](./LICENSE.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skillgrid",
-  "version": "0.0.18-alpha.20250911T13103",
+  "version": "0.0.19",
   "description": "Skillgrid Components Library",
   "keywords": [
     "react",
@@ -33,7 +33,6 @@
     "dev": "vite",
     "build": "vite build",
     "type-check": "tsc",
-    "prepublish": "npm run build",
     "format": "prettier --write .",
     "lint": "eslint . --ext .ts,.tsx",
     "lint:fix": "eslint . --ext .ts,.tsx --fix",
@@ -41,7 +40,6 @@
     "lint:css:fix": "stylelint **/*.css --fix",
     "lint:fix:all": "npm run lint:fix && npm run lint:css:fix",
     "preview": "vite preview",
-    "prepare": "husky",
     "skillgrid": "tsx scripts/generators/index.ts",
     "test:generators": "vitest run scripts/generators/tests",
     "storybook": "storybook dev -p 6006",
@@ -54,15 +52,7 @@
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
-    "docs": "yarn docs:dev",
-    "version:major": "node ./scripts/publish/version.js major",
-    "version:minor": "node ./scripts/publish/version.js minor",
-    "version:patch": "node ./scripts/publish/version.js patch",
-    "publish:current": "node ./scripts/publish/publish.js current",
-    "publish:alpha": "node ./scripts/publish/publish.js alpha",
-    "publish:beta": "node ./scripts/publish/publish.js beta",
-    "publish:next": "node ./scripts/publish/publish.js next",
-    "publish:latest": "node ./scripts/publish/publish.js latest"
+    "docs": "yarn docs:dev"
   },
   "devDependencies": {
     "@eslint/js": "^9.25.0",
@@ -144,4 +134,4 @@
     "wrap-ansi": "7.0.0",
     "cliui": "7.0.4"
   }
-}
+}