Skip to content

vv0rkz/js-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@vv0rkz/js-template

⚡ Переиспользуемый шаблон для JS проектов с husky, changelog, GitHub tools

🚀 Установка

npm install -D @vv0rkz/js-template npx jst init

💻 Использование

# Короткая команда (рекомендуется)

npm run _ tasks
npm run _ release
npm run _ create-task "Новая фича"

# Или полная
npm run jst tasks
npm run jst release

📋 Команды

Управление проектом

  • jst init — инициализация проекта

Разработка

  • jst changelog — создать changelog
  • jst release — полный релиз (проверка + changelog + README)
  • jst update-readme — обновить README
  • jst push-release — запушить релиз в main

Управление задачами

  • jst tasks — список открытых задач
  • jst create-task [название] — создать задачу
  • jst bugs — список открытых багов
  • jst create-bug [название] — создать баг
  • jst all-issues — все открытые issues

📦 Что устанавливается

  • ✅ Husky + хуки (commit-msg, pre-push, post-commit)
  • ✅ Commitlint конфиг (проверка коммитов)
  • ✅ Changelogen конфиг (автогенерация changelog)
  • ✅ GitHub tools скрипты (управление задачами)
  • ✅ .gitignore (готовый файл)

🎯 Пример использования

Установка в новый проект

mkdir my-awesome-js-project
cd my-awesome-js-project
npm init -y
npm install -D @vv0rkz/js-template
npx jst init

Работа с задачами

Создать задачу
npm run _ create-task "Добавить темную тему"

Посмотреть все задачи
npm run _ tasks

Создать баг
npm run _ create-bug "Кнопка не работает"

Посмотреть баги
npm run _ bugs

Релиз версии

Сделать фичу
git add .
git commit -m "feat: добавлена темная тема"

Создать релиз
npm run _ release

Запушить в main
npm run _ push-release

📁 Структура проекта после установки

my-project/
├── .husky/
│ ├── commit-msg # Проверка формата коммитов
│ ├── pre-push # Запуск тестов перед push
│ └── post-commit # Сообщение после коммита
├── tools-gh/ # GitHub утилиты
│ ├── create-task.js
│ ├── create-bug.js
│ ├── update-readme.js
│ └── ...
├── .gitignore # Готовый .gitignore
├── changelog.config.js # Конфиг для changelog
├── commitlint.config.js # Правила для коммитов
└── package.json # С готовыми скриптами

🛠️ Технологии

📝 Формат коммитов

feat: новая функция fix: исправление бага docs: изменения в документации refactor: рефакторинг кода perf: улучшение производительности test: добавление тестов chore: обновление зависимостей

📄 Лицензия

MIT © vv0rkz

# 🚀 Публикация
cd js-template
npm login
npm publish --access public
# 💻 Использование в проекте

# В новом проекте
npm install -D @vv0rkz/js-template
npx jst init

# Работа через короткую команду _
npm run _ tasks
npm run _ release
npm run _ create-task "Моя задача"

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published