@igniter-js/cli 0.1.0 → 0.1.2

package/dist/templates/copilot.next.instructions.hbs

@@ -0,0 +1,67 @@
+
+  You are an expert in Solidity, TypeScript, Node.js, Next.js 14 App Router, React, Vite, Viem v2, Wagmi v2, Shadcn UI, Radix UI, and Tailwind Aria.
+  
+  Key Principles
+  - Write concise, technical responses with accurate TypeScript examples.
+  - Use functional, declarative programming. Avoid classes.
+  - Prefer iteration and modularization over duplication.
+  - Use descriptive variable names with auxiliary verbs (e.g., isLoading).
+  - Use lowercase with dashes for directories (e.g., components/auth-wizard).
+  - Favor named exports for components.
+  - Use the Receive an Object, Return an Object (RORO) pattern.
+  
+  JavaScript/TypeScript
+  - Use "function" keyword for pure functions. Omit semicolons.
+  - Use TypeScript for all code. Prefer interfaces over types. Avoid enums, use maps.
+  - File structure: Exported component, subcomponents, helpers, static content, types.
+  - Avoid unnecessary curly braces in conditional statements.
+  - For single-line statements in conditionals, omit curly braces.
+  - Use concise, one-line syntax for simple conditional statements (e.g., if (condition) doSomething()).
+  
+  Error Handling and Validation
+  - Prioritize error handling and edge cases:
+    - Handle errors and edge cases at the beginning of functions.
+    - Use early returns for error conditions to avoid deeply nested if statements.
+    - Place the happy path last in the function for improved readability.
+    - Avoid unnecessary else statements; use if-return pattern instead.
+    - Use guard clauses to handle preconditions and invalid states early.
+    - Implement proper error logging and user-friendly error messages.
+    - Consider using custom error types or error factories for consistent error handling.
+  
+  React/Next.js
+  - Use functional components and TypeScript interfaces.
+  - Use declarative JSX.
+  - Use function, not const, for components.
+  - Use Shadcn UI, Radix, and Tailwind Aria for components and styling.
+  - Implement responsive design with Tailwind CSS.
+  - Use mobile-first approach for responsive design.
+  - Place static content and interfaces at file end.
+  - Use content variables for static content outside render functions.
+  - Minimize 'use client', 'useEffect', and 'setState'. Favor RSC.
+  - Use Zod for form validation.
+  - Wrap client components in Suspense with fallback.
+  - Use dynamic loading for non-critical components.
+  - Optimize images: WebP format, size data, lazy loading.
+  - Model expected errors as return values: Avoid using try/catch for expected errors in Server Actions. Use useActionState to manage these errors and return them to the client.
+  - Use error boundaries for unexpected errors: Implement error boundaries using error.tsx and global-error.tsx files to handle unexpected errors and provide a fallback UI.
+  - Use useActionState with react-hook-form for form validation.
+  - Code in services/ dir always throw user-friendly errors that tanStackQuery can catch and show to the user.
+  - Use next-safe-action for all server actions:
+    - Implement type-safe server actions with proper validation.
+    - Utilize the `action` function from next-safe-action for creating actions.
+    - Define input schemas using Zod for robust type checking and validation.
+    - Handle errors gracefully and return appropriate responses.
+    - Use import type { ActionResponse } from '@/types/actions'
+    - Ensure all server actions return the ActionResponse type
+    - Implement consistent error handling and success responses using ActionResponse
+  
+  Key Conventions
+  1. Rely on Next.js App Router for state changes.
+  2. Prioritize Web Vitals (LCP, CLS, FID).
+  3. Minimize 'use client' usage:
+     - Prefer server components and Next.js SSR features.
+     - Use 'use client' only for Web API access in small components.
+     - Avoid using 'use client' for data fetching or state management.
+  
+  Refer to Next.js documentation for Data Fetching, Rendering, and Routing best practices.
+  

package/dist/templates/copilot.review.instructions.hbs

@@ -0,0 +1,42 @@
+## Code Review Instructions
+IMPORTANT: NEVER MODIFY A FILE WITHOUT DETAILING THE PLAN TO YOUR USER FIRST, ALWAYS REQUEST EXPRESS PERMISSION FROM YOUR USER;
+
+### 1. Review Process
+1. **Initial Analysis**
+  - Check code structure following Igniter.js patterns
+  - Identify potential security issues
+  - Evaluate test coverage
+  - Check compliance with SOLID and Clean Code
+
+2. **Verification Checklist**
+  - Clear and consistent naming
+  - Correct file structure
+  - Proper error handling
+  - Appropriate TypeScript typing
+  - Required documentation
+  - Unit/integration tests
+  - Performance and optimizations
+  - Security and validations
+
+3. **Feedback**
+  - Provide objective and constructive suggestions
+  - Prioritize critical issues
+  - Include code examples when relevant
+  - Justify suggested changes
+
+### 2. Response Format
+```markdown
+## Review Summary
+- Status: [APPROVED|CHANGES_REQUESTED]
+- Critical Issues: [number]
+- Improvements: [number]
+
+## Issues
+1. [CRITICAL|IMPROVEMENT] - Concise description
+  - File: path/to/file
+  - Reason: Explanation
+  - Suggestion: Proposed code/solution
+
+## Recommendations
+- List of general suggestions
+```

package/dist/templates/copilot.test.instructions.hbs

@@ -0,0 +1,55 @@
+# Test Instructions
+IMPORTANT: NEVER MODIFY A FILE WITHOUT DETAILING THE PLAN TO YOUR USER FIRST, ALWAYS REQUEST EXPRESS PERMISSION FROM YOUR USER;
+
+# Testing Guidelines
+
+## 1. Testing Strategy & Framework
+**Framework:** Vitest  
+**Core Principles:**
+  - Each test file mirrors source file structure
+  - Focus on behavior, not implementation
+  - Follow AAA pattern (Arrange, Act, Assert)
+  - Use descriptive test names
+  - Test both success and failure cases
+
+## 2. Test Types & Coverage
+- **Unit Tests:** Individual components/functions
+- **Integration Tests:** Interactions between features
+- **E2E Tests:** Critical user flows
+- **Coverage Goal:** Minimum 80% coverage
+
+## 3. Testing Process
+1. Ask user if testing is needed: "Would you like me to generate tests for this code?"
+2. If yes, analyze source code and dependencies
+3. Generate test plan following SOLID principles
+4. Request approval before implementation
+5. Create test files with appropriate naming
+
+## 4. Test File Structure
+```typescript
+describe('Feature: [Component/Function Name]', () => {
+  describe('Given [context]', () => {
+    describe('When [action]', () => {
+      it('Then [expected result]', () => {
+        // AAA Pattern
+        // Arrange (Setup)
+        // Act (Execute)
+        // Assert (Verify)
+      })
+    })
+  })
+})
+```
+
+## 5. Best Practices
+- Use mocks for external dependencies
+- Keep tests focused and independent
+- Test edge cases and error scenarios
+- Write maintainable test code
+- Use utilities for common operations
+- Follow TDD when applicable
+
+## 6. Naming Conventions
+- Test files: `*.spec.ts` or `*.test.ts`
+- Test suites: Clear feature description
+- Test cases: Should describe behavior

package/dist/templates/eslintrc.hbs

@@ -1,3 +1,6 @@
 {
-  "extends": ["@rocketseat/eslint-config/next", "next/core-web-vitals"],
-} 
+  "extends": [
+    "@igniter-js/eslint-config/next",
+    "next/core-web-vitals"
+  ]
+}

package/dist/templates/feature.controller.hbs

@@ -57,7 +57,9 @@ export const {{pascalCase name}}Controller = igniter.controller({
       body: z.object({
         {{#each fields}}
         {{#unless isRelation}}
-        {{name}}: {{zodType}}.optional(),
+        {{#if (ne name "id")}}
+        {{name}}: {{#if isOptional}}{{zodType}}{{else}}{{zodType}}.optional(){{/if}},
+        {{/if}}
         {{/unless}}
         {{/each}}
       }),

package/dist/templates/feature.interface.hbs

@@ -1,3 +1,8 @@
+{{#each fields}}
+{{#if relations}}
+import type { {{pascalCase type}} } from '../{{kebabCase type}}/{{kebabCase type}}.interface';
+{{/if}}
+{{/each}}
 
 /**
  * Represents a {{pascalCase name}} entity.
@@ -6,15 +11,17 @@ export interface {{pascalCase name}} {
   {{#each fields}}
   {{#if isRelation}}
   {{#if isList}}
-  /** Array of IDs representing the related {{name}} entities */
+  /** Array of IDs representing the related {{pascalCase type}} entities */
   {{name}}Ids: string[];
+  /** Related {{pascalCase type}} entities */
+  {{name}}: {{pascalCase type}}[];
   {{else}}
-  /** ID of the related {{name}} entity */
-  {{name}}Id: string;
+  /** Related {{pascalCase type}} entity */
+  {{name}}: {{pascalCase type}};
   {{/if}}
   {{else}}
   /** {{pascalCase name}}'s {{name}} property */
-  {{name}}{{#if isOptional}}?{{/if}}: {{lowerCase type}};
+  {{name}}: {{getTypeFormat type isRelation}}{{#if isOptional}}{{#unless hasDefault}}  | null{{/unless}}{{/if}};
   {{/if}}
   {{/each}}
 }
@@ -24,17 +31,16 @@ export interface {{pascalCase name}} {
  */
 export interface Create{{pascalCase name}}DTO {
   {{#each fields}}
-  {{#if isRelation}}
   {{#if isList}}
-  /** Array of IDs for the {{name}} relationships to be created */
-  {{name}}Ids: string[];
-  {{else}}
-  /** ID for the {{name}} relationship to be created */
-  {{name}}Id: string;
-  {{/if}}
+  /** Array of IDs for the {{pascalCase type}} relationships to be created */
+  {{name}}Ids{{#if (equals relations.type 'one-to-many')}}?{{/if}}: string[];
   {{else}}
-  /** {{name}} value for the new {{pascalCase name}} */
-  {{name}}{{#if isOptional}}?{{/if}}: {{lowerCase type}};
+  {{#unless (equals name (concat (lowerCase ../name) "Id"))}}
+  {{#unless isRelation}}
+  /** {{pascalCase name}}'s {{name}} property  */
+  {{name}}{{#if isOptional}}?{{/if}}: {{getTypeFormat type isRelation}}{{#if isOptional}} | null{{/if}};
+  {{/unless}}
+  {{/unless}}
   {{/if}}
   {{/each}}
 }
@@ -44,28 +50,32 @@ export interface Create{{pascalCase name}}DTO {
  */
 export interface Update{{pascalCase name}}DTO {
   {{#each fields}}
-  {{#if isRelation}}
   {{#if isList}}
-  /** Array of IDs for the {{name}} relationships to be updated */
+  /** Array of IDs for the {{pascalCase type}} relationships to be created */
   {{name}}Ids?: string[];
   {{else}}
-  /** ID for the {{name}} relationship to be updated */
-  {{name}}Id?: string;
-  {{/if}}
-  {{else}}
-  /** Updated {{name}} value */
-  {{name}}?: {{lowerCase type}};
+  {{#unless (equals name (concat (lowerCase ../name) "Id"))}}
+  {{#unless isRelation}}
+  /** {{pascalCase name}}'s {{name}} property  */
+  {{name}}?: {{getTypeFormat type isRelation}}{{#if isOptional}} | null{{/if}};
+  {{/unless}}
+  {{/unless}}
   {{/if}}
   {{/each}}
 }
 
 /**
- * Query parameters for fetching {{pascalCase name}} entities
+ * Query parameters for fetching Category entities
  */
-export interface {{pascalCase name}}QueryParams {
+export interface CategoryQueryParams {
+  /** Current page number for pagination */
   page?: number;
+  /** Number of items to return per page */
   limit?: number;
+  /** Property to sort by */
   sortBy?: string;
+  /** Sort order */
   sortOrder?: 'asc' | 'desc';
+  /** Search term for filtering */
   search?: string;
 }

package/dist/templates/globals.hbs

@@ -26,7 +26,7 @@
   --chart-3: oklch(0.398 0.07 227.392);
   --chart-4: oklch(0.828 0.189 84.429);
   --chart-5: oklch(0.769 0.188 70.08);
-  --radius: 0.625rem;
+  --radius: 1.5rem;
   --sidebar: oklch(0.985 0 0);
   --sidebar-foreground: oklch(0.145 0 0);
   --sidebar-primary: oklch(0.205 0 0);

package/dist/templates/layout.hbs

@@ -1,50 +1,43 @@
-import localFont from "next/font/local";
+import type { Metadata } from "next";
 
-import { type Metadata } from "next";
-import { Toaster } from 'sonner'
+import { Geist, Geist_Mono } from "next/font/google";
 import { IgniterProvider } from '@igniter-js/core/client'
+import { ThemeProvider } from "next-themes";
 
-import "./globals.css";
+import "./globals.css"
 
-const geistSans = localFont({
-  src: "./fonts/GeistVF.woff",
+const geistSans = Geist({
   variable: "--font-geist-sans",
-  weight: "100 900",
+  subsets: ["latin"],
 });
 
-const geistMono = localFont({
-  src: "./fonts/GeistMonoVF.woff",
+const geistMono = Geist_Mono({
   variable: "--font-geist-mono",
-  weight: "100 900",
+  subsets: ["latin"],
 });
 
 export const metadata: Metadata = {
-  title: "Igniter Framework",
-  description: "A modern framework optimized for AI-powered development, featuring built-in best practices and type safety for rapid web applications",
+  title: "Igniter Boilerplate",
+  description: "A customizable boilerplate for Igniter applications",
 };
 
-/**
- * Root layout component that wraps the entire application
- * Business Rule: We need to await connection() to ensure proper request-time behavior in Next.js 15
- * @param children - React components to be rendered inside the layout
- */
-export default async function RootLayout({
+export default function RootLayout({
   children,
 }: Readonly<{
   children: React.ReactNode;
 }>) {
   return (
-    <html lang="pt-BR" suppressHydrationWarning>
-      <body className="antialiased">
+    <html lang="en" suppressHydrationWarning>
+      <body
+        className={`${geistSans.variable} ${geistMono.variable} antialiased`}
+      >
         <ThemeProvider
           attribute="class"
           defaultTheme="system"
           enableSystem
           disableTransitionOnChange
-          forcedTheme='light'
         >
           <IgniterProvider>
-            <Toaster position="top-center" />
             {children}
           </IgniterProvider>
         </ThemeProvider>