@alephmatic/aleph0
v0.0.2
Published
To install dependencies:
Downloads
12
Readme
aleph0
To install dependencies:
pnpm install
To run:
pnpm run src/index.ts
Test cases
CONSOLA_LEVEL=4 pnpm src/index.ts gen "add a form that creates a blog post" -p ../examples/next
CONSOLA_LEVEL=4 pnpm src/index.ts gen "create a prisma schema file with a blog model" -p ../examples/next
Debug
CONSOLA_LEVEL=4 pnpm run src/index.ts gen "add a file named agam.ts in the app/ folder" -p ../examples/next -rd false
Snippets in aleph0
Overview
Snippets are key components in aleph0, providing valuable context to the AI. They offer insights into how various frameworks are used and demonstrate our coding conventions and patterns.
Snippet Structure
- Location: Snippets are located in the
snippets
folder. - Types of Snippets:
- General Technology Snippets: These explain general aspects of a framework. For instance how
page.tsx
is a special file in Next.js. - Metadata.ts: This file contains details about the snippet, like its purpose, file paths, and references to framework-related files. It helps the AI understand the snippet's context.
- Code Examples: Other files in the snippets directory typically contain raw code examples showing how to implement the snippet.
- General Technology Snippets: These explain general aspects of a framework. For instance how
Example Structure
Here's how snippets are organized:
snippets/
next14/
metadata.ts - Metadata for Next.js general tech snippets.
route.ts - Example of a route in Next.js version 14 (general tech snippet).
toaster/
metadata.ts - Metadata for the toaster snippet.
toaster.tsx - Example of a toaster in Next.js version 14.
Example metadata.ts
export const metadata: Metadata = {
name: "Toaster",
description:
"A toast component example - A short message that is displayed temporarily.",
// comment
path: "toaster", // directory path for the snippet
long: `multiline
multiline`,
files: [
{
name: "Toaster Component",
file: "toaster.tsx",
explanation:
"The toaster should be placed on the frontend in a `toasters/<TOASTER>.ts` file.",
references: ["page.tsx"], // extra information related to the snippet like next.js's `page.tsx` conventions.
},
],
};