zedx 0.2.0 → 0.3.1

package/README.md

@@ -2,10 +2,15 @@
 
 Boilerplate generator for [Zed Editor](https://zed.dev/) extensions.
 
+![screenshot](./assets/screenshot1.png)
+
 ## Installation
 
 ```bash
 npm install -g zedx
+
+# or
+brew install tahayvr/tap/zedx
 ```
 
 ### Usage
@@ -23,6 +28,7 @@ zedx version major   # 1.2.3 → 2.0.0
 
 ### Supported extension types:
 
-1. Themes
+1. **Themes** - Color schemes for the editor
+2. **Languages** - Syntax highlighting, indentation, and optional LSP support
 
-   (more coming soon)
+You can choose to include theme, language, or both when creating an extension.

package/dist/generator.js

@@ -13,14 +13,31 @@ async function renderTemplate(templatePath, data) {
 }
 export async function generateExtension(options, targetDir) {
     await fs.ensureDir(targetDir);
-    const extToml = await renderTemplate(path.join(TEMPLATE_DIR, 'base/extension.toml.ejs'), options);
+    const extData = {
+        ...options,
+        grammarRepo: options.grammarRepo || '',
+        grammarRev: options.grammarRev || '',
+        languageName: options.languageName || 'My Language'
+    };
+    const extToml = await renderTemplate(path.join(TEMPLATE_DIR, 'base/extension.toml.ejs'), extData);
     await fs.writeFile(path.join(targetDir, 'extension.toml'), extToml);
+    const readmeData = {
+        ...extData,
+        languageId: options.languageId || 'my-language'
+    };
+    const readme = await renderTemplate(path.join(TEMPLATE_DIR, 'base/readme.md.ejs'), readmeData);
+    await fs.writeFile(path.join(targetDir, 'README.md'), readme);
     const licensePath = path.join(TEMPLATE_DIR, 'base/licenses', options.license);
     let licenseContent = await fs.readFile(licensePath, 'utf-8');
     licenseContent = licenseContent.replaceAll('{{YEAR}}', new Date().getFullYear().toString());
     licenseContent = licenseContent.replaceAll('{{AUTHOR}}', options.author);
     await fs.writeFile(path.join(targetDir, 'LICENSE'), licenseContent);
-    await generateTheme(options, targetDir);
+    if (options.types.includes('theme')) {
+        await generateTheme(options, targetDir);
+    }
+    if (options.types.includes('language')) {
+        await generateLanguage(options, targetDir);
+    }
 }
 async function generateTheme(options, targetDir) {
     const themeDir = path.join(targetDir, 'themes');
@@ -35,3 +52,33 @@ async function generateTheme(options, targetDir) {
     const themeJson = await renderTemplate(path.join(TEMPLATE_DIR, 'theme/theme.json.ejs'), themeData);
     await fs.writeFile(path.join(themeDir, `${options.id}.json`), themeJson);
 }
+async function generateLanguage(options, targetDir) {
+    const languageDir = path.join(targetDir, 'languages', options.languageId);
+    await fs.ensureDir(languageDir);
+    const data = {
+        ...options,
+        pathSuffixes: options.pathSuffixes || [],
+        lineComments: options.lineComments || ['//', '#']
+    };
+    const configToml = await renderTemplate(path.join(TEMPLATE_DIR, 'language/config.toml.ejs'), data);
+    await fs.writeFile(path.join(languageDir, 'config.toml'), configToml);
+    const queryFiles = [
+        'highlights.scm',
+        'brackets.scm',
+        'outline.scm',
+        'indents.scm',
+        'injections.scm',
+        'overrides.scm',
+        'textobjects.scm',
+        'redactions.scm',
+        'runnables.scm'
+    ];
+    for (const file of queryFiles) {
+        const templatePath = path.join(TEMPLATE_DIR, 'language', file);
+        if (await fs.pathExists(templatePath)) {
+            let content = await fs.readFile(templatePath, 'utf-8');
+            content = ejs.render(content, data);
+            await fs.writeFile(path.join(languageDir, file), content);
+        }
+    }
+}

package/dist/index.js

@@ -4,7 +4,7 @@ import * as p from '@clack/prompts';
 import color from 'picocolors';
 import { Command } from 'commander';
 import fs from 'fs-extra';
-import { promptUser, promptThemeDetails } from './prompts.js';
+import { promptUser, promptThemeDetails, promptLanguageDetails } from './prompts.js';
 import { generateExtension } from './generator.js';
 function bumpVersion(version, type) {
     const [major, minor, patch] = version.split('.').map(Number);
@@ -54,10 +54,15 @@ async function main() {
         await bumpExtensionVersion(type);
     });
     if (process.argv.length <= 2) {
-        // No command provided, run interactive mode
         const options = await promptUser();
-        const themeDetails = await promptThemeDetails();
-        Object.assign(options, themeDetails);
+        if (options.types.includes('theme')) {
+            const themeDetails = await promptThemeDetails();
+            Object.assign(options, themeDetails);
+        }
+        if (options.types.includes('language')) {
+            const languageDetails = await promptLanguageDetails();
+            Object.assign(options, languageDetails);
+        }
         const targetDir = path.join(getCallerDir(), options.id);
         await generateExtension(options, targetDir);
         p.outro(`${color.green('✓')} ${color.bold('Extension created successfully!')}\n` +

package/dist/prompts.d.ts

@@ -1,6 +1,7 @@
-import type { ExtensionOptions } from './types/index.js';
+import type { ExtensionOptions, LanguageOptions } from './types/index.js';
 export declare function promptUser(): Promise<ExtensionOptions>;
 export declare function promptThemeDetails(): Promise<{
     themeName: string;
     appearance: 'light' | 'dark' | 'both';
 }>;
+export declare function promptLanguageDetails(): Promise<Partial<LanguageOptions>>;

package/dist/prompts.js

@@ -28,7 +28,7 @@ export async function promptUser() {
         process.exit(0);
     }
     const idValue = id || idDefault;
-    const descriptionDefault = 'A Zed theme';
+    const descriptionDefault = 'A Zed extension';
     const description = await p.text({
         message: 'Description:',
         placeholder: descriptionDefault
@@ -50,7 +50,7 @@ export async function promptUser() {
         p.cancel('Cancelled.');
         process.exit(0);
     }
-    const repositoryDefault = `https://github.com/username/zed-theme.git`;
+    const repositoryDefault = `https://github.com/username/${idValue}.git`;
     const repository = await p.text({
         message: 'GitHub repository URL:',
         initialValue: repositoryDefault
@@ -77,6 +77,18 @@ export async function promptUser() {
         p.cancel('Cancelled.');
         process.exit(0);
     }
+    const extensionTypes = await p.multiselect({
+        message: 'What do you want to include in your extension?',
+        options: [
+            { value: 'theme', label: 'Theme', hint: 'Color scheme for the editor' },
+            { value: 'language', label: 'Language', hint: 'Syntax highlighting, indentation, etc.' }
+        ],
+        required: true
+    });
+    if (p.isCancel(extensionTypes)) {
+        p.cancel('Cancelled.');
+        process.exit(0);
+    }
     const options = {
         name: nameValue,
         id: idValue,
@@ -84,7 +96,7 @@ export async function promptUser() {
         author: String(author),
         repository: repositoryValue,
         license: license,
-        types: ['theme']
+        types: extensionTypes
     };
     return options;
 }
@@ -115,3 +127,18 @@ export async function promptThemeDetails() {
         appearance: appearance
     };
 }
+export async function promptLanguageDetails() {
+    const languageName = await p.text({
+        message: 'Language name:',
+        placeholder: 'My Language'
+    });
+    if (p.isCancel(languageName)) {
+        p.cancel('Cancelled.');
+        process.exit(0);
+    }
+    const result = {
+        languageName: String(languageName),
+        languageId: String(languageName).toLowerCase().replace(/\s+/g, '-')
+    };
+    return result;
+}

package/dist/templates/base/extension.toml.ejs

@@ -2,6 +2,22 @@ id = "<%= id %>"
 name = "<%= name %>"
 version = "0.0.1"
 schema_version = 1
-authors = ["<%= author %>"]
+authors = ["<%- author %>"]
 description = "<%= description %>"
 repository = "<%= repository %>"
+
+<% if (types.includes('language') && grammarRepo) { %>
+[grammars.<%= languageId %>]
+repository = "<%= grammarRepo %>"
+rev = "<%= grammarRev || 'main' %>"
+<% } else if (types.includes('language')) { %>
+# [grammars.<%= languageId %>]
+# repository = "https://github.com/user/tree-sitter-<%= languageId %>"
+# rev = "main"
+<% } %>
+
+<% if (types.includes('language')) { %>
+# [language_servers.my-lsp]
+# name = "My Language LSP"
+# languages = ["<%= languageName %>"]
+<% } %>

package/dist/templates/base/readme.md.ejs

@@ -0,0 +1,34 @@
+<%= name %>
+<%= "=".repeat(name.length) %>
+
+<%= description %>
+
+## Installation
+
+1. Open Zed
+2. Run `Extensions > Install Dev Extension`
+3. Select the folder for this extension
+
+## Development
+
+### Themes
+
+Edit `themes/<%= id %>.json` to customize colors. See [Zed Theme Documentation](https://zed.dev/docs/themes) for available tokens.
+
+### Languages
+
+Edit `languages/<%= languageId %>/config.toml`.
+
+#### Tree-sitter Grammar
+
+To add syntax highlighting, you'll need a Tree-sitter grammar:
+
+1. Find or create a grammar repo. Try [tree-sitter](https://github.com/tree-sitter/tree-sitter)
+2. Uncomment and fill in the `[grammars.<%= languageId %>]` section in `extension.toml`
+3. Edit the `.scm` files in `languages/<%= languageId %>/`
+
+See [Zed Documentation](https://zed.dev/docs/extensions/languages) for details.
+
+## Publishing
+
+Run `zedx version patch|minor|major` to bump the version, then create a GitHub release.

package/dist/templates/language/brackets.scm

@@ -0,0 +1,23 @@
+; =============================================================================
+; Bracket Matching Queries
+; =============================================================================
+; This file defines matching brackets for rainbow bracket highlighting.
+; See: https://zed.dev/docs/extensions/languages#bracket-matching
+;
+; Captures:
+;   @open  - Opening bracket
+;   @close - Closing bracket
+;
+; To exclude from rainbow brackets, add: (#set! rainbow.exclude)
+;
+; Example:
+;   ("(" @open ")" @close)
+;   ("[" @open "]" @close)
+;   ("{" @open "}" @close)
+;
+; Note: Quotes need escaping in .scm files:
+;   ("\"" @open "\"" @close)
+
+("(" @open ")" @close)
+("[" @open "]" @close)
+("{" @open "}" @close)

package/dist/templates/language/config.toml.ejs

@@ -0,0 +1,26 @@
+# name (required): The human readable name shown in the Select Language dropdown
+name = "<%= languageName %>"
+
+# grammar (required): The name of a Tree-sitter grammar (must match grammar registration in extension.toml)
+grammar = "<%= languageId %>"
+
+# path_suffixes: Array of file suffixes associated with this language (e.g., ["myl", "my"])
+# Unlike file_types in settings, this does not support glob patterns
+# path_suffixes = []
+
+# line_comments: Array of strings used to identify line comments
+# Used for editor::ToggleComments keybind (cmd-/ or ctrl-/)
+# line_comments = ["// ", "# "]
+
+# tab_size: The indentation/tab size used for this language (default is 4)
+# tab_size = 4
+
+# hard_tabs: Whether to indent with tabs (true) or spaces (false, the default)
+# hard_tabs = false
+
+# first_line_pattern: A regular expression to match files based on their first line
+# Useful for identifying files by shebang (e.g., "^#!.*\\bbash\\b" for shell scripts)
+# first_line_pattern = ""
+
+# debuggers: Array of debugger identifiers for ordering in the New Process Modal
+# debuggers = []

package/dist/templates/language/highlights.scm

@@ -0,0 +1,32 @@
+; =============================================================================
+; Syntax Highlighting Queries
+; =============================================================================
+; This file defines syntax highlighting rules using Tree-sitter queries.
+; See: https://zed.dev/docs/extensions/languages#syntax-highlighting
+;
+; Capture names (prefix with @):
+;   @string         - String literals
+;   @number         - Numeric values
+;   @comment        - Comments
+;   @keyword        - Keywords
+;   @function       - Functions
+;   @type           - Types
+;   @variable       - Variables
+;   @property       - Properties
+;   @operator       - Operators
+;   @punctuation    - Punctuation
+;   @constant       - Constants
+;   @attribute      - Attributes
+;   @tag            - Tags
+;
+; Example:
+;   (string) @string
+;   (number) @number
+;   (comment) @comment
+;
+; Learn more about Tree-sitter queries:
+;   https://tree-sitter.github.io/tree-sitter/using-parsers/queries
+
+(string) @string
+(number) @number
+(comment) @comment

package/dist/templates/language/indents.scm

@@ -0,0 +1,17 @@
+; =============================================================================
+; Auto-Indentation Queries
+; =============================================================================
+; This file defines indentation rules for automatic formatting.
+; See: https://zed.dev/docs/extensions/languages#auto-indentation
+;
+; Captures:
+;   @end    - Closing bracket/brace that ends an indented block
+;   @indent - Entire block that should increase indentation
+;
+; Example for block-based languages:
+;   (block "}" @end) @indent
+;   (function "}" @end) @indent
+;
+; Example for indentation-based languages:
+;   (list_item) @indent
+

package/dist/templates/language/injections.scm

@@ -0,0 +1,24 @@
+; =============================================================================
+; Code Injection Queries
+; =============================================================================
+; This file defines rules for embedding one language within another.
+; See: https://zed.dev/docs/extensions/languages#code-injections
+;
+; Common use cases:
+;   - SQL queries in Python strings
+;   - Code blocks in Markdown
+;   - CSS in HTML style tags
+;   - JavaScript in JSX/TSX
+;
+; Captures:
+;   @injection.language - The language identifier (e.g., "python", "javascript")
+;   @injection.content - The content to treat as a different language
+;
+; Example for Markdown code blocks:
+;   (fenced_code_block
+;     (info_string (language) @injection.language)
+;     (code_fence_content) @injection.content)
+;
+; Example for inline markdown:
+;   ((inline) @content (#set! injection.language "markdown-inline"))
+

package/dist/templates/language/outline.scm

@@ -0,0 +1,17 @@
+; =============================================================================
+; Code Outline Queries
+; =============================================================================
+; This file defines the structure shown in the code outline panel.
+; See: https://zed.dev/docs/extensions/languages#code-outlinestructure
+;
+; Captures:
+;   @name   - Display name for the outline item
+;   @item   - The entire element to show in outline
+;   @context     - Provides context for the item
+;   @context.extra - Additional contextual info
+;   @annotation   - Annotations (doc comments, decorators)
+;
+; Example:
+;   (function_definition name: (identifier) @name) @item
+;   (class_declaration name: (type_identifier) @name) @item
+

package/dist/templates/language/overrides.scm

@@ -0,0 +1,20 @@
+; =============================================================================
+; Syntax Override Queries
+; =============================================================================
+; This file defines scoped overrides for editor settings.
+; See: https://zed.dev/docs/extensions/languages#syntax-overrides
+;
+; Available overrides:
+;   word_characters           - Characters considered part of a word
+;   completion_query_characters - Characters that trigger autocomplete
+;
+; Use .inclusive suffix to make range inclusive (default is exclusive):
+;   (comment) @comment.inclusive
+;
+; Example - JavaScript strings with hyphen completion:
+;   (string) @string
+;   ; Then set in config.toml:
+;   ; [overrides.string]
+;   ; completion_query_characters = ["-"]
+
+(string) @string

package/dist/templates/language/redactions.scm

@@ -0,0 +1,16 @@
+; =============================================================================
+; Text Redaction Queries
+; =============================================================================
+; This file defines content to redact when sharing screen/collaborating.
+; See: https://zed.dev/docs/extensions/languages#text-redactions
+;
+; Redacted content is rendered in a neutral style to protect sensitive data.
+;
+; Captures:
+;   @redact - Content to be redacted
+;
+; Example:
+;   (string) @redact
+;   (number) @redact
+;   (environment_variable (string) @redact)
+

package/dist/templates/language/runnables.scm

@@ -0,0 +1,25 @@
+; =============================================================================
+; Runnable Code Detection Queries
+; =============================================================================
+; This file defines rules for detecting runnable code blocks.
+; See: https://zed.dev/docs/extensions/languages#runnable-code-detection
+;
+; Adds run buttons to the editor gutter for executable code/scripts.
+;
+; Captures:
+;   @run     - Where to place the run button
+;   @script - Also captures the script name
+;
+; Other captures (except underscore-prefixed) are exposed as:
+;   ZED_CUSTOM_<CAPTURE_NAME> environment variables
+;
+; Tags (using #set! tag):
+;   (#set! tag <tag-name>) - Additional metadata for the runnable
+;
+; Example for package.json scripts:
+;   (pair
+;     key: (string (string_content) @_name (#eq? @_name "scripts"))
+;     value: (object
+;       (pair
+;         key: (string (string_content) @run @script))))
+

package/dist/templates/language/textobjects.scm

@@ -0,0 +1,26 @@
+; =============================================================================
+; Text Object Queries
+; =============================================================================
+; This file defines text objects for Vim mode navigation.
+; See: https://zed.dev/docs/extensions/languages#text-objects
+;
+; Vim motions using these:
+;   [m / ]m      - Previous/next function (or @function.around)
+;   [M / ]M      - Previous/next class (or @class.around)
+;   af / if      - Around/inside function
+;   ac / ic      - Around/inside class
+;   gc           - Around comment
+;
+; Captures:
+;   @function.around   - Entire function definition
+;   @function.inside  - Function body (inside braces)
+;   @class.around      - Entire class definition
+;   @class.inside      - Class contents
+;   @comment.around    - Entire comment block
+;   @comment.inside    - Comment contents
+;
+; Example:
+;   (function_definition) @function.around
+;   (function_definition body: (_) @function.inside)
+;   (class_declaration) @class.around
+

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export type ExtensionType = 'theme';
+export type ExtensionType = 'theme' | 'language';
 export type License = 'Apache-2.0' | 'BSD-2-Clause' | 'BSD-3-Clause' | 'GPL-3.0' | 'LGPL-3.0' | 'MIT' | 'Zlib';
 export interface ExtensionOptions {
     name: string;
@@ -14,3 +14,15 @@ export interface ThemeOptions extends ExtensionOptions {
     themeName: string;
     appearance: 'light' | 'dark' | 'both';
 }
+export interface LanguageOptions extends ExtensionOptions {
+    languageName: string;
+    languageId: string;
+    pathSuffixes?: string[];
+    lineComments?: string[];
+    grammarRepo?: string;
+    grammarRev?: string;
+    hasLsp?: boolean;
+    lspServerName?: string;
+    lspCommand?: string;
+    lspArgs?: string[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "zedx",
-	"version": "0.2.0",
+	"version": "0.3.1",
 	"description": "Boilerplate generator for Zed Edittor extensions.",
 	"type": "module",
 	"main": "dist/index.js",