Репо шаблоны

$ caz nm my-project

Приведённая выше команда извлекает шаблон из caz-templates/nm, затем запрашивает некоторую информацию в соответствии с конфигурацией этого шаблона и генерирует проект в ./my-project.

$ caz nm#typescript my-project

Выполнив эту команду, CAZ извлечёт шаблон из ветки typescript репозитория caz-templates/nm.

Использование пользовательских шаблонов

$ caz zce/nm my-project

Эта команда извлекает шаблон из репозитория zce/nm. Это означает, что вы также можете извлекать шаблоны из своего публичного репозитория на GitHub.

Необходим публичный репозиторий.

Локальные шаблоны

Вместо репозитория GitHub вы также можете использовать шаблон в своей локальной файловой системе.

Например:

$ caz ~/local/template my-project

В этой команде используется шаблон из ~/local/template.

Удалённые ZIP-шаблоны

Вместо репозитория GitHub вы также можете использовать шаблон с URI zip-файла.

Пример:

$ caz https://cdn.zce.me/boilerplate.zip my-project

Команда скачает и извлечёт шаблон из https://cdn.zce.me/boilerplate.zip.

Автономный режим

$ caz nm my-project --offline

После выполнения этой команды CAZ попытается найти кэшированную версию шаблона nm или загрузить его с GitHub, если он ещё не был кэширован.

Переопределение запросов

CAZ позволяет вам указать ответы на запросы через параметры командной строки.

$ caz minima my-project --name my-proj

После выполнения этой команды вам не придётся отвечать на следующий запрос name.

Режим отладки

$ caz nm my-project --debug

Параметр --debug откроет режим отладки. В режиме отладки при возникновении исключения детали исключения будут автоматически выводиться. Это очень полезно для поиска ошибок в шаблоне.

Список доступных шаблонов

Показать все доступные шаблоны:

$ caz list [owner] [-j|--json] [-s|--short]

Аргументы

• [owner]: организации GitHub или ярлык пользователя, по умолчанию: 'caz-templates'

Опции

• -j, --json: вывод в формате json
• -s, --short: краткий вывод

Официальные шаблоны

Текущий список доступных шаблонов:

• template — для создания caz шаблонов.
• nm — для создания модулей node.
• vercel — для создания приложений vercel.
• react — для создания современных приложений react.
• vue — для создания современных приложений vue.js.
• vite — для создания приложений vue.js на базе vite.
• electron — для создания приложений electron.
• mp — для создания мини-программ wechat mini-programs.
• jekyll — для создания сайта jekyll.
• x-pages — для создания статического сайта x-pages.

Возможно, есть и другие: https://github.com/caz-templates

Вы также можете запустить $ caz list, чтобы увидеть все официальные шаблоны в реальном времени.

Все шаблоны в настоящее время размещены на GitHub, китайские пользователи могут использовать зеркало на coding.net.

Дополнительно

Конфигурация

CAZ будет читать файл конфигурации в ~/.cazrc, конфигурация по умолчанию:

; template download registry
; {owner} & {name} & {branch} будут заменены соответствующими значениями.
registry = https://github.com/{owner}/{name}/archive/{branch}.zip
; название официальной организации шаблонов
official = caz-templates
; имя ветки шаблонов по умолчанию
branch = master

Это означает, что вы... Можно настроить конфигурацию, изменив файл конфигурации.

Например, в вашем ~/.cazrc можно использовать такой код:

registry = https://gitlab.com/{owner}/{name}/archive/{branch}.zip
official = faker
branch = main

Затем выполните следующую команду:

$ caz nm my-project

Приведённая выше команда загрузит и извлечёт шаблон из https://gitlab.com/faker/nm/archive/main.zip.

Зеркало для китайского языка

Из-за ограничений сети загрузка шаблона может занять некоторое время. Можно рассмотреть возможность использования зеркального репозитория, который я настроил на coding.net.

~/.cazrc:

registry = https://zce.coding.net/p/{owner}/d/{name}/git/archive/{branch}
official = caz

Создайте свой шаблон

$ caz template my-template

Эта команда извлекает шаблон из caz-templates/template и помогает создать собственный шаблон CAZ.

Чтобы создать и распространить собственный шаблон, обратитесь к разделу «Как создать шаблон» (docs/create-template.md).

Возможно, форк официального шаблона также будет хорошим решением.

Создание каркаса

# установите его локально
$ npm install caz

# или yarn
$ yarn add caz

С ESM и async/await:

import caz from 'caz'

try {
  const template = 'nm'
  // путь проекта (относительно cwd или полный путь)
  const project = 'my-project'
  const options = { force: false, offline: false }
  // создание каркаса с помощью caz...
  await caz(template, project, options)
  // успешно создан my-project по шаблону nm
} catch (e) {
  // обработка ошибок
  console.error(e)
}

или с CommonJS и Promise:

const { default: caz } = require('caz')

const template = 'nm'
// путь проекта (относительно cwd или полный путь)
const project = 'my-project'
const options = { force: false, offline: false }
// создание каркаса с помощью caz...
caz(template, project, options)
  .then(() => {
    // успешно создан my-project по шаблону nm
  })
  .catch(e => {
    // обработка ошибок
    console.error(e)
  })

Это означает, что вы можете разработать собственный модуль создания каркаса на основе этого инструмента.

Для создания и распространения собственных инструментов создания каркасов обратитесь к разделу «Как создавать инструменты создания каркасов на основе CAZ» (docs/create-scaffold.md).

Ссылки

caz(template, project?, options?)

Создаёт новый проект на основе шаблона.

template

• Тип: string
• Описание: имя шаблона, это также может быть путь к папке шаблона

project

• Тип: string
• Описание: название проекта, это также может быть путь к папке проекта
• По умолчанию: .

options

• Тип: object
• Описание: параметры и переопределения подсказок
• По умолчанию: {}

force

• Тип: boolean
• Описание: перезаписать, если цель существует
• По умолчанию: false

offline

• Тип: boolean
• Описание: попытаться использовать автономный шаблон
• По умолчанию: false

[key: string]

• Тип: any
• Описание: опции cli для переопределения подсказок

Мотивация

👉 🛠 ⚙ Шутка: я хочу делать колёса;P

Реальная причина в том, что я думаю, мне нужен инструмент создания каркаса, который больше подходит для моей личной продуктивности. Существующие инструменты имеют более или менее определённые ограничения из-за их разных отправных точек.

Ничего больше.

Концепции

Как это работает

P.S. Изображение взято из интернета, но я забыл конкретный источник, приношу извинения автору.

Основной рабочий процесс

Основной код основан на механизме промежуточного программного обеспечения, предоставляемом zce/mwa.

Следующие промежуточные программы будут выполняться последовательно.

1. confirm — подтверждение назначения с помощью prompts.
2. resolve — разрешение шаблона из удалённой или локальной файловой системы.
3. load — установка зависимостей шаблона, загрузка конфигурации шаблона с помощью require.
4. inquire — запрос подсказок шаблона с помощью prompts.
5. setup — применить только функцию установки шаблона.