basecoat-cli 0.1.0 → 0.2.0-beta.1

package/README.md

@@ -0,0 +1,56 @@
+# basecoat-cli
+
+This package provides a Command Line Interface (CLI) to help you quickly scaffold [Basecoat](https://basecoatui.com) components into your project.
+
+## Prerequisites
+
+- Ensure you have Node.js and npm (or your preferred package manager) installed.
+- For the components to function correctly, your project should have:
+  - [Tailwind CSS](https://tailwindcss.com/docs/installation) installed and configured.
+  - The `basecoat-css` package installed and imported (or `basecoat.css` manually added).
+  - [Alpine.js](https://alpinejs.dev/docs/installation) installed and initialized, as Basecoat components rely on it for interactivity.
+
+## Usage
+
+Use the `add` command to add components to your project:
+
+```bash
+# npx
+npx basecoat-cli add [component]
+
+# pnpm
+pnpm dlx basecoat-cli add [component]
+
+# bun
+bunx basecoat-cli add [component]
+
+# yarn
+yarn dlx basecoat-cli add [component]
+```
+
+Replace `[component]` with the name of the component you wish to add (e.g., `dialog`, `select`) or leave it out if you want to pick from the list of available components
+or install all of them at once.
+
+The CLI will prompt you for:
+
+1.  **Template Engine:** Choose between Nunjucks (`.njk`) or Jinja (`.html.jinja`).
+2.  **Assets Directory:** The path where component assets (like JavaScript files) should be placed (e.g., `src/assets/js/components`).
+3.  **Macros Directory:** The path where component macros should be placed (e.g., `src/_includes/macros/components`).
+
+The CLI will then copy the necessary JavaScript files and Nunjucks/Jinja macros for the selected component into the specified directories.
+
+### Example
+
+To add the `dialog` component:
+
+```bash
+npx basecoat-cli add dialog
+```
+
+## Documentation
+
+For more detailed information on components, their usage, and customization options, please refer to the [Basecoat documentation](https://basecoatui.com/installation/#install-cli).
+
+## License
+
+[MIT](https://github.com/hunvreus/basecoat/blob/main/LICENSE.md)

package/dist/assets/jinja/dialog.html.jinja

@@ -75,7 +75,7 @@
           {% endfor %}
         >
           <h2 id="{{ id }}-title">{{ title | safe }}</h2>
-          <p>{{ description | safe }}</p>
+          {% if description %}<p>{{ description | safe }}</p>{% endif %}
         </header>
       {% endif %}
       {% if caller %}

package/dist/assets/jinja/dropdown-menu.html.jinja

@@ -21,7 +21,7 @@
   x-data="dropdownMenu"
   @click.away="open = false"
   {% if id %}id="{{ id }}"{% endif %}
-  {% for key, value in main_attrs %}
+  {% for key, value in main_attrs.items() %}
     {% if key != "class" %}{{ key }}="{{ value }}"{% endif %}
   {% endfor %}
 >
@@ -35,7 +35,7 @@
     id="{{ id }}-trigger"
     aria-controls="{{ id }}-menu"
     {% endif %}
-    {% for key, value in trigger_attrs %}
+    {% for key, value in trigger_attrs.items() %}
       {{ key }}="{{ value }}"
     {% endfor %}
   >
@@ -47,7 +47,7 @@
     aria-hidden="true"
     x-bind="$content"
     {% if id %}id="{{ id }}-menu"{% endif %}
-    {% for key, value in content_attrs %}
+    {% for key, value in content_attrs.items() %}
       {{ key }}="{{ value }}"
     {% endfor %}
   >

package/dist/assets/jinja/select.html.jinja

@@ -4,6 +4,7 @@
   @param id {string} [optional] - Unique identifier for the select component.
   @param selected {string} [optional] - The initially selected value.
   @param name {string} [optional] - The name attribute for the hidden input storing the selected value.
+  @param items {array} [optional] - An array of items (objects with type, label, value, attrs, and items) to render.
   @param main_attrs {object} [optional] - Additional HTML attributes for the main container div.
   @param trigger_attrs {object} [optional] - Additional HTML attributes for the trigger button.
   @param content_attrs {object} [optional] - Additional HTML attributes for the popover content div.

package/dist/assets/jinja/toast.html.jinja

@@ -10,7 +10,7 @@
 {% macro toaster(
   id="toaster",
   toasts=[],
-  main_attrs=None,
+  main_attrs={},
   is_fragment=False
 ) %}
 <div
@@ -21,7 +21,7 @@
   {% endfor %}
   {% if is_fragment %}hx-swap-oob="beforeend"{% endif %}
 >
-{% for item in toasts.items() %}
+{% for item in toasts %}
   {{ toast(
     category=item.category,
     title=item.title,