@qdesignsystems/design-system-core 0.1.5 → 0.1.6

package/AGENTS.md

@@ -0,0 +1,145 @@
+# Q Design System — AI Agent Rules
+
+## CRITICAL: Component Import Rule
+
+**NEVER install or use local shadcn/ui components (via `npx shadcn@latest add ...`).**
+**ALWAYS import components from `@qdesignsystems/design-system-core`.**
+
+This project uses a pre-built design system package. All components are already available — do not scaffold new ones.
+
+---
+
+## How to Import Components
+
+All components come from one package:
+
+```tsx
+import { Button, Card, Input, Badge, ... } from '@qdesignsystems/design-system-core';
+```
+
+### Base Components
+
+```tsx
+import {
+  // Layout
+  Card, CardHeader, CardFooter, CardTitle, CardDescription, CardContent, CardAction,
+
+  // Inputs
+  Button, Input, Textarea, Checkbox, RadioGroup, RadioGroupItem, Switch, Toggle,
+
+  // Display
+  Badge, Alert, AlertTitle, AlertDescription, Separator, Skeleton, Label,
+
+  // Navigation
+  Pagination, PaginationContent, PaginationLink, PaginationItem,
+  PaginationPrevious, PaginationNext, PaginationEllipsis,
+
+  // Overlay
+  Popover, PopoverTrigger, PopoverContent,
+  DropdownMenu, DropdownMenuTrigger, DropdownMenuContent, DropdownMenuItem,
+  DropdownMenuLabel, DropdownMenuSeparator, DropdownMenuGroup,
+
+  // Structure
+  Accordion, AccordionItem, AccordionTrigger, AccordionContent,
+  Collapsible, CollapsibleTrigger, CollapsibleContent,
+
+  // Form
+  Form, FormItem, FormLabel, FormControl, FormDescription, FormMessage, FormField,
+
+  // Sidebar
+  Sidebar, SidebarContent, SidebarFooter, SidebarGroup, SidebarGroupContent,
+  SidebarGroupLabel, SidebarHeader, SidebarMenu, SidebarMenuButton,
+  SidebarMenuItem, SidebarProvider, SidebarTrigger, SidebarInset,
+
+  // Utilities
+  cn, ThemeProvider,
+} from '@qdesignsystems/design-system-core';
+```
+
+### Pre-built Composite Components
+
+These are ready-to-use demo components. Use them as-is or as a starting point:
+
+```tsx
+// Buttons
+import { Button14, Button16, Button17, Button19, Button20 } from '@qdesignsystems/design-system-core';
+
+// Button Groups
+import { ButtonGroup01, ButtonGroup02, ButtonGroup03 } from '@qdesignsystems/design-system-core';
+
+// Cards
+import { Card01, Card02, Card03, Card04, Card05, Card06, Card10, Card13, Card14 } from '@qdesignsystems/design-system-core';
+
+// Inputs
+import { Input01, Input02, Input03 /* ... up to Input46 */ } from '@qdesignsystems/design-system-core';
+
+// Badges
+import { Badge01, Badge02 /* ... up to Badge24 */ } from '@qdesignsystems/design-system-core';
+
+// Forms
+import { Form01, Form02, Form03 /* ... up to Form10 */ } from '@qdesignsystems/design-system-core';
+
+// Checkboxes
+import { Checkbox01, Checkbox02 /* ... up to Checkbox16 */ } from '@qdesignsystems/design-system-core';
+
+// Radio Groups
+import { RadioGroup01, RadioGroup02 /* ... up to RadioGroup13 */ } from '@qdesignsystems/design-system-core';
+
+// Dropdowns
+import { DropdownMenu01, DropdownMenu05, DropdownMenu08, DropdownMenu09 } from '@qdesignsystems/design-system-core';
+
+// Popovers
+import { Popover01, Popover02 /* ... up to Popover12 */ } from '@qdesignsystems/design-system-core';
+
+// Pagination
+import { Pagination01, Pagination02 /* ... up to Pagination15 */ } from '@qdesignsystems/design-system-core';
+
+// Calendars
+import { Calendar01, Calendar02 /* ... up to Calendar21 */ } from '@qdesignsystems/design-system-core';
+
+// Comboboxes
+import { Combobox01, Combobox02 /* ... up to Combobox12 */ } from '@qdesignsystems/design-system-core';
+
+// Data Tables
+import { DataTable01, DataTable02, DataTable03, DataTable05, DataTable07, DataTable08, DataTable09, DataTable13 } from '@qdesignsystems/design-system-core';
+
+// Collapsibles
+import { Collapsible01, Collapsible02 /* ... up to Collapsible09 */ } from '@qdesignsystems/design-system-core';
+
+// Toasts / Notifications
+import { Sonner01, Sonner02 /* ... up to Sonner20 */ } from '@qdesignsystems/design-system-core';
+```
+
+---
+
+## Rules
+
+1. **Never run `npx shadcn@latest add <component>`** — components already exist in the package
+2. **Never create files in `src/components/ui/`** — do not scaffold local shadcn components
+3. **Always import from `@qdesignsystems/design-system-core`**
+4. **Use Tailwind utility classes** for layout and spacing — the theme CSS variables are already loaded
+5. **Do not add a `:root { }` or `.dark { }` block** to any CSS file — this overrides the theme
+
+---
+
+## CSS Setup (must be correct)
+
+`src/main.tsx` must have these imports at the very top:
+
+```tsx
+import '@qdesignsystems/design-system-core/styles.css';
+import '@qdesignsystems/theme-myra/styles.css'; // or theme-q
+```
+
+`src/index.css` must NOT contain `:root { }` or `.dark { }` variable blocks. It should only contain:
+
+```css
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+@layer base {
+  * { @apply border-border; }
+  body { @apply bg-background text-foreground; }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qdesignsystems/design-system-core",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -28,7 +28,9 @@
   ],
   "files": [
     "dist",
-    "scripts/init.cjs"
+    "scripts/init.cjs",
+    "README.md",
+    "AGENTS.md"
   ],
   "scripts": {
     "build": "tsup && node scripts/strip-css-sourcemap.cjs",

package/scripts/init.cjs

@@ -134,7 +134,23 @@ if (!entryPatched) {
   log(YELLOW, '⚠', 'Could not find main entry file — please add imports manually (see below)');
 }
 
-// ─── 3. Summary ───────────────────────────────────────────────────────────────
+// ─── 3. Copy AGENTS.md to project root ───────────────────────────────────────
+// AGENTS.md tells AI assistants (Lovable, Cursor, etc.) to use our components
+const agentsSrc = path.join(__dirname, '..', 'AGENTS.md');
+const agentsDest = path.join(projectRoot, 'AGENTS.md');
+
+if (fs.existsSync(agentsSrc)) {
+  if (fs.existsSync(agentsDest)) {
+    log(GREEN, '✔', 'AGENTS.md already exists at project root');
+  } else {
+    fs.copyFileSync(agentsSrc, agentsDest);
+    log(GREEN, '✔', 'Copied AGENTS.md to project root (tells AI to use design system components)');
+  }
+} else {
+  log(YELLOW, '⚠', 'Could not find AGENTS.md in package — skipping');
+}
+
+// ─── 4. Summary ───────────────────────────────────────────────────────────────
 console.log('');
 console.log(`${BOLD}Setup complete!${RESET}`);
 console.log('');