einsteinjs 0.1.2 → 0.1.3

package/README.md

@@ -1,34 +1,82 @@
 # EinsteinJS
 
-A type-safe snippet registry and compiler for VSCode and Cursor.
+A type-safe snippet registry and compiler for VSCode, Cursor, and editors based on VSCode.
+
+Define snippets using an expressive DSL while EinsteinJS handles validation, compilation and JSON generation automatically.
 
 ## Installation
 
+Using Bun:
+
 ```bash
 bun add einsteinjs
 ```
 
+Using npm:
+
+```bash
+npm install einsteinjs
+```
+
 ## Usage
 
 ```ts
-import { registry, build } from "einsteinjs"
+import { registry, defineConfig } from "einsteinjs"
 
 const rfc = registry
-  .it("React Functional Component")
-  .scope(["typescriptreact"])
-  .prefix("rfc")
-  .body([
-    "export default function ${1:Component}() {",
-    "  return <div>$0</div>",
-    "}"
-  ])
-  .tag(["react"])
+    .it("React Functional Component")
+    .describe("Creates a React functional component")
+    .scope(["typescriptreact"])
+    .prefix("rfc")
+    .body([
+        "export default function ${1:Component}() {",
+        "  return <div>$0</div>",
+        "}"
+    ])
+    .template()
+    .tag(["react", "tsx"])
+
+export default defineConfig({
+    output: "./dist/react.json",
+
+    snippets: [rfc]
+})
+```
+
+Build your snippets:
+
+```ts
+import config from "./snippets.config"
+
+import { build } from "einsteinjs"
+
+await build(config)
+```
+
+Run:
+
+```bash
+bun run build.ts
+```
+
+Generated output:
+
+```json
+{
+    "React Functional Component": {
+        "scope": "typescriptreact",
+        "prefix": "rfc",
+        "body": [
+            "export default function ${1:Component}() {",
+            "  return <div>$0</div>",
+            "}"
+        ],
+        "description": "Creates a React functional component",
+        "isFileTemplate": true
+    }
+}
 ```
 
-## Features
+## License
 
-- Type-safe API
-- Duplicate prefix validation
-- Duplicate name validation
-- VSCode-compatible output
-- Extensible compiler architecture
+MIT

package/dist/index.d.ts

@@ -1,10 +1,35 @@
 type Scope = 'typescriptreact' | 'javascriptreact' | 'typescript' | 'javascript' | 'html' | 'json';
 interface Snippet {
+    /**
+     * Nome do snippet.
+     *
+     * Será usado como chave no JSON final.
+     */
     name: string;
-    scope: Scope[];
+    /**
+     * Descrição exibida pelo VSCode.
+     */
+    description?: string;
+    /**
+     * Escopos do VSCode.
+     */
+    scope: string[];
+    /**
+     * Prefixo digitado pelo usuário.
+     */
     prefix: string;
+    /**
+     * Corpo do snippet.
+     */
     body: string[];
+    /**
+     * Tags para documentação futura.
+     */
     tags: string[];
+    /**
+     * Define se o snippet é um template de arquivo.
+     */
+    isFileTemplate: boolean;
 }
 
 /**
@@ -41,6 +66,17 @@ declare class SnippetBuilder {
      * Corpo do snippet.
      */
     body(body: string[]): this;
+    describe(description: string): this;
+    /**
+     * Define se é um template de arquivo.
+     *
+     * Ex:
+     *
+     * .template()
+     * .template(true)
+     * .template(false)
+     */
+    template(isFileTemplate?: boolean): this;
     /**
      * Tags para futuras features:
      * documentação, filtros, busca etc.

package/dist/index.js

@@ -13,13 +13,27 @@ function compileSnippet(snippet) {
   return {
     [snippet.name]: {
       /**
-       * VSCode espera string.
-       * Nós trabalhamos com array
-       * e convertemos somente aqui.
+       * O VSCode espera:
+       *
+       * "typescriptreact,typescript"
        */
       scope: snippet.scope.join(","),
       prefix: snippet.prefix,
-      body: snippet.body
+      body: snippet.body,
+      /**
+       * A DSL usa:
+       * .describe()
+       * mas o VSCode espera:
+       * description
+       */
+      description: snippet.description,
+      /**
+       * A DSL usa:
+       * .template()
+       * mas o VSCode espera:
+       * isFileTemplate
+       */
+      isFileTemplate: snippet.isFileTemplate
     }
   };
 }
@@ -14580,10 +14594,12 @@ config(en_default());
 // src/schemas/snippet.schema.ts
 var snippetSchema = external_exports.object({
   name: external_exports.string().min(1),
+  description: external_exports.string().optional(),
   scope: external_exports.array(external_exports.string()).min(1),
   prefix: external_exports.string().min(1),
   body: external_exports.array(external_exports.string()).min(1),
-  tags: external_exports.array(external_exports.string())
+  tags: external_exports.array(external_exports.string()),
+  isFileTemplate: external_exports.boolean()
 });
 
 // src/build.ts
@@ -14619,7 +14635,12 @@ var SnippetBuilder = class {
    * Partial permite criar o objeto aos poucos.
    */
   snippet = {
-    tags: []
+    tags: [],
+    /**
+     * Por padrão o snippet
+     * NÃO é template.
+     */
+    isFileTemplate: false
   };
   /**
    * Nome do snippet.
@@ -14652,6 +14673,23 @@ var SnippetBuilder = class {
     this.snippet.body = body;
     return this;
   }
+  describe(description) {
+    this.snippet.description = description;
+    return this;
+  }
+  /**
+   * Define se é um template de arquivo.
+   *
+   * Ex:
+   *
+   * .template()
+   * .template(true)
+   * .template(false)
+   */
+  template(isFileTemplate = true) {
+    this.snippet.isFileTemplate = isFileTemplate;
+    return this;
+  }
   /**
    * Tags para futuras features:
    * documentação, filtros, busca etc.

package/package.json

@@ -1,29 +1,30 @@
 {
-  "name": "einsteinjs",
-  "version": "0.1.2",
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "exports": {
-    ".": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+    "name": "einsteinjs",
+    "version": "0.1.3",
+    "description": "A type-safe snippet registry and compiler for VSCode and Cursor.",
+    "files": [
+        "dist"
+    ],
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "scripts": {
+        "build": "tsup src/index.ts --format esm --dts",
+        "prepublishOnly": "bun run build"
+    },
+    "dependencies": {
+        "tsup": "^8.5.1"
+    },
+    "devDependencies": {
+        "oxfmt": "^0.54.0",
+        "oxlint": "^1.69.0",
+        "typescript": "^5.9.3",
+        "zod": "^4.4.3"
     }
-  },
-  "scripts": {
-    "build": "tsup src/index.ts --format esm --dts",
-    "prepublishOnly": "bun run build"
-  },
-  "devDependencies": {
-    "oxfmt": "^0.54.0",
-    "oxlint": "^1.69.0",
-    "typescript": "^5.9.2",
-    "zod": "^4.4.3"
-  },
-  "dependencies": {
-    "tsup": "^8.5.1"
-  }
-}
+}