zedx 0.3.0 → 0.3.1

package/dist/generator.js

@@ -13,8 +13,20 @@ 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());
@@ -43,7 +55,12 @@ async function generateTheme(options, targetDir) {
 async function generateLanguage(options, targetDir) {
     const languageDir = path.join(targetDir, 'languages', options.languageId);
     await fs.ensureDir(languageDir);
-    const configToml = await renderTemplate(path.join(TEMPLATE_DIR, 'language/config.toml.ejs'), options);
+    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',
@@ -60,7 +77,7 @@ async function generateLanguage(options, targetDir) {
         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, options);
+            content = ejs.render(content, data);
             await fs.writeFile(path.join(languageDir, file), content);
         }
     }

package/dist/prompts.js

@@ -138,12 +138,7 @@ export async function promptLanguageDetails() {
     }
     const result = {
         languageName: String(languageName),
-        languageId: String(languageName).toLowerCase().replace(/\s+/g, '-'),
-        pathSuffixes: [],
-        lineComments: [],
-        grammarRepo: '',
-        grammarRev: '',
-        hasLsp: false
+        languageId: String(languageName).toLowerCase().replace(/\s+/g, '-')
     };
     return result;
 }

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

@@ -9,12 +9,15 @@ repository = "<%= repository %>"
 <% if (types.includes('language') && grammarRepo) { %>
 [grammars.<%= languageId %>]
 repository = "<%= grammarRepo %>"
-rev = "<%= grammarRev %>"
+rev = "<%= grammarRev || 'main' %>"
+<% } else if (types.includes('language')) { %>
+# [grammars.<%= languageId %>]
+# repository = "https://github.com/user/tree-sitter-<%= languageId %>"
+# rev = "main"
 <% } %>
-<% if (hasLsp && lspServerName) { %>
-[language_servers.<%= lspServerName %>]
-name = "<%= lspServerName %>"
-languages = ["<%= languageName %>"]
 
-[languages."<%= languageName %>"]
+<% 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/config.toml.ejs

@@ -1,29 +1,26 @@
-<%= languageName %>
-<%= "=".repeat(languageName.length) %>
-
-; name (required): The human readable name shown in the Select Language dropdown
+# 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 (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 = <%- pathSuffixes.length > 0 ? JSON.stringify(pathSuffixes) : '[""]' %>
+# 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 = <%- lineComments.length > 0 ? JSON.stringify(lineComments) : '[""]' %>
+# 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
+# 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
+# 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 = ""
+# 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 = []
+# debuggers: Array of debugger identifiers for ordering in the New Process Modal
+# debuggers = []

package/dist/types/index.d.ts

@@ -17,11 +17,11 @@ export interface ThemeOptions extends ExtensionOptions {
 export interface LanguageOptions extends ExtensionOptions {
     languageName: string;
     languageId: string;
-    pathSuffixes: string[];
-    lineComments: string[];
-    grammarRepo: string;
-    grammarRev: string;
-    hasLsp: boolean;
+    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.3.0",
+	"version": "0.3.1",
 	"description": "Boilerplate generator for Zed Edittor extensions.",
 	"type": "module",
 	"main": "dist/index.js",