zedx 0.1.0 → 0.2.0

package/README.md

@@ -1,6 +1,6 @@
 # zedx
 
-Boilerplate generator for Zed extensions.
+Boilerplate generator for [Zed Editor](https://zed.dev/) extensions.
 
 ## Installation
 
@@ -16,9 +16,9 @@ zedx
 
 # Bump extension version
 # Run inside extension dir
-zedx bump patch   # 1.2.3 → 1.2.4
-zedx bump minor   # 1.2.3 → 1.3.0
-zedx bump major   # 1.2.3 → 2.0.0
+zedx version patch   # 1.2.3 → 1.2.4
+zedx version minor   # 1.2.3 → 1.3.0
+zedx version major   # 1.2.3 → 2.0.0
 ```
 
 ### Supported extension types:

package/dist/generator.d.ts

@@ -1,2 +1,2 @@
-import type { ExtensionOptions } from "./types/index.js";
+import type { ExtensionOptions } from './types/index.js';
 export declare function generateExtension(options: ExtensionOptions, targetDir: string): Promise<void>;

package/dist/generator.js

@@ -1,37 +1,37 @@
-import fs from "fs-extra";
-import path from "path";
-import { fileURLToPath } from "url";
-import ejs from "ejs";
+import fs from 'fs-extra';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import ejs from 'ejs';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
-const isDev = __dirname.includes("/src/");
-const PROJECT_ROOT = isDev ? path.join(__dirname, "..") : __dirname;
-const TEMPLATE_DIR = path.join(PROJECT_ROOT, "templates");
+const isDev = __dirname.includes('/src/');
+const PROJECT_ROOT = isDev ? path.join(__dirname, '..') : __dirname;
+const TEMPLATE_DIR = path.join(PROJECT_ROOT, 'templates');
 async function renderTemplate(templatePath, data) {
-    const template = await fs.readFile(templatePath, "utf-8");
+    const template = await fs.readFile(templatePath, 'utf-8');
     return ejs.render(template, data);
 }
 export async function generateExtension(options, targetDir) {
     await fs.ensureDir(targetDir);
-    const extToml = await renderTemplate(path.join(TEMPLATE_DIR, "base/extension.toml.ejs"), options);
-    await fs.writeFile(path.join(targetDir, "extension.toml"), extToml);
-    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);
+    const extToml = await renderTemplate(path.join(TEMPLATE_DIR, 'base/extension.toml.ejs'), options);
+    await fs.writeFile(path.join(targetDir, 'extension.toml'), extToml);
+    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);
 }
 async function generateTheme(options, targetDir) {
-    const themeDir = path.join(targetDir, "themes");
+    const themeDir = path.join(targetDir, 'themes');
     await fs.ensureDir(themeDir);
-    const appearance = options.appearance || "dark";
-    const appearances = appearance === "both" ? ["dark", "light"] : [appearance];
+    const appearance = options.appearance || 'dark';
+    const appearances = appearance === 'both' ? ['dark', 'light'] : [appearance];
     const themeData = {
         ...options,
-        themeName: options.themeName || "My Theme",
-        appearances,
+        themeName: options.themeName || 'My Theme',
+        appearances
     };
-    const themeJson = await renderTemplate(path.join(TEMPLATE_DIR, "theme/theme.json.ejs"), themeData);
+    const themeJson = await renderTemplate(path.join(TEMPLATE_DIR, 'theme/theme.json.ejs'), themeData);
     await fs.writeFile(path.join(themeDir, `${options.id}.json`), themeJson);
 }

package/dist/index.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/dist/index.js

@@ -1,18 +1,19 @@
-import path from "path";
-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 { generateExtension } from "./generator.js";
+#!/usr/bin/env node
+import path from 'path';
+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 { generateExtension } from './generator.js';
 function bumpVersion(version, type) {
-    const [major, minor, patch] = version.split(".").map(Number);
+    const [major, minor, patch] = version.split('.').map(Number);
     switch (type) {
-        case "major":
+        case 'major':
             return `${major + 1}.0.0`;
-        case "minor":
+        case 'minor':
             return `${major}.${minor + 1}.0`;
-        case "patch":
+        case 'patch':
             return `${major}.${minor}.${patch + 1}`;
     }
 }
@@ -21,15 +22,15 @@ function getCallerDir() {
 }
 async function bumpExtensionVersion(type) {
     const callerDir = getCallerDir();
-    const tomlPath = path.join(callerDir, "extension.toml");
+    const tomlPath = path.join(callerDir, 'extension.toml');
     if (!(await fs.pathExists(tomlPath))) {
-        p.log.error(color.red("No extension.toml found in current directory."));
+        p.log.error(color.red('No extension.toml found in current directory.'));
         process.exit(1);
     }
-    const content = await fs.readFile(tomlPath, "utf-8");
+    const content = await fs.readFile(tomlPath, 'utf-8');
     const versionMatch = content.match(/version\s*=\s*"(\d+\.\d+\.\d+)"/);
     if (!versionMatch) {
-        p.log.error(color.red("Could not find version in extension.toml"));
+        p.log.error(color.red('Could not find version in extension.toml'));
         process.exit(1);
     }
     const currentVersion = versionMatch[1];
@@ -40,14 +41,14 @@ async function bumpExtensionVersion(type) {
 }
 async function main() {
     const program = new Command();
-    program.name("zedx").description("Boilerplate generator for Zed extensions");
+    program.name('zedx').description('Boilerplate generator for Zed Editor extensions.');
     program
-        .command("bump")
-        .description("Bump the version of the extension")
-        .argument("<type>", "Version bump type: major, minor, or patch")
+        .command('version')
+        .description('Bump the version of the extension')
+        .argument('<type>', 'Version bump type: major, minor, or patch')
         .action(async (type) => {
-        if (!["major", "minor", "patch"].includes(type)) {
-            p.log.error(color.red("Invalid bump type. Use: major, minor, or patch"));
+        if (!['major', 'minor', 'patch'].includes(type)) {
+            p.log.error(color.red('Invalid bump type. Use: major, minor, or patch'));
             process.exit(1);
         }
         await bumpExtensionVersion(type);
@@ -59,11 +60,14 @@ async function main() {
         Object.assign(options, themeDetails);
         const targetDir = path.join(getCallerDir(), options.id);
         await generateExtension(options, targetDir);
-        // Final success message
-        p.outro(`${color.green("✓")} ${color.bold("Extension created successfully!")}\n\n` +
-            `Location: ${color.yellow(targetDir)}\n`);
-        p.note(`Open Zed and install theme as dev extension: Extensions > Install Dev Extension`, "Next steps");
-        p.outro(`More info: ${color.underline(color.yellow("https://zed.dev/docs/extensions/developing-extensions"))}`);
+        p.outro(`${color.green('✓')} ${color.bold('Extension created successfully!')}\n` +
+            `${color.gray('─'.repeat(40))}\n` +
+            `${color.dim('Location:')} ${color.cyan(targetDir)}`);
+        p.outro(`${color.yellow('⚡')} ${color.bold('Next steps')}\n\n` +
+            `  ${color.gray('1.')} Open Zed\n` +
+            `  ${color.gray('2.')} ${color.white('Extensions > Install Dev Extension')}\n` +
+            `  ${color.gray('3.')} Select ${color.cyan(options.id)} folder\n\n` +
+            `${color.dim('Learn more:')} ${color.underline(color.blue('https://zed.dev/docs/extensions/developing-extensions'))}`);
         return;
     }
     program.parse(process.argv);

package/dist/prompts.d.ts

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

package/dist/prompts.js

@@ -1,79 +1,80 @@
-import * as p from "@clack/prompts";
-import color from "picocolors";
+import * as p from '@clack/prompts';
+import color from 'picocolors';
 export async function promptUser() {
-    p.intro(color.bgBlue(" zedx "));
-    const nameDefault = "my-zed-extension";
+    p.intro(`${color.bgBlue(color.bold(' zedx '))} ${color.blue('Boilerplate generator for Zed Editor extensions.')}`);
+    const nameDefault = 'my-zed-extension';
     const name = await p.text({
-        message: "Project name:",
-        placeholder: nameDefault,
+        message: 'Project name:',
+        placeholder: nameDefault
     });
     if (p.isCancel(name)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     const nameValue = name || nameDefault;
-    const idDefault = nameValue.toLowerCase().replace(/\s+/g, "-");
+    const idDefault = nameValue.toLowerCase().replace(/\s+/g, '-');
     const id = await p.text({
-        message: "Extension ID:",
+        message: 'Extension ID:',
         placeholder: idDefault,
         validate: (value) => {
-            if (value && value.includes(" "))
-                return "ID cannot contain spaces";
+            if (value && value.includes(' '))
+                return 'ID cannot contain spaces';
             if (value && value !== value.toLowerCase())
-                return "ID must be lowercase";
-        },
+                return 'ID must be lowercase';
+        }
     });
     if (p.isCancel(id)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     const idValue = id || idDefault;
-    const descriptionDefault = "A Zed theme";
+    const descriptionDefault = 'A Zed theme';
     const description = await p.text({
-        message: "Description:",
-        placeholder: descriptionDefault,
+        message: 'Description:',
+        placeholder: descriptionDefault
     });
     if (p.isCancel(description)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     const descriptionValue = description || descriptionDefault;
     const author = await p.text({
-        message: "Author name:",
+        message: 'Author name:',
+        placeholder: 'name <username@example.com>',
         validate: (value) => {
             if (!value || value.length === 0)
-                return "Author is required";
-        },
+                return 'Author is required';
+        }
     });
     if (p.isCancel(author)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
-    const repositoryDefault = `https://github.com/${author ?? ""}/zed-theme.git`;
+    const repositoryDefault = `https://github.com/username/zed-theme.git`;
     const repository = await p.text({
-        message: "GitHub repository URL:",
-        initialValue: repositoryDefault,
+        message: 'GitHub repository URL:',
+        initialValue: repositoryDefault
     });
     if (p.isCancel(repository)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     const repositoryValue = repository || repositoryDefault;
     const license = await p.select({
-        message: "License:",
+        message: 'License:',
         options: [
-            { value: "Apache-2.0", label: "Apache 2.0" },
-            { value: "BSD-2-Clause", label: "BSD 2-Clause" },
-            { value: "BSD-3-Clause", label: "BSD 3-Clause" },
-            { value: "GPL-3.0", label: "GNU GPLv3" },
-            { value: "LGPL-3.0", label: "GNU LGPLv3" },
-            { value: "MIT", label: "MIT" },
-            { value: "Zlib", label: "zlib" },
+            { value: 'Apache-2.0', label: 'Apache 2.0' },
+            { value: 'BSD-2-Clause', label: 'BSD 2-Clause' },
+            { value: 'BSD-3-Clause', label: 'BSD 3-Clause' },
+            { value: 'GPL-3.0', label: 'GNU GPLv3' },
+            { value: 'LGPL-3.0', label: 'GNU LGPLv3' },
+            { value: 'MIT', label: 'MIT' },
+            { value: 'Zlib', label: 'zlib' }
         ],
-        initialValue: "MIT",
+        initialValue: 'MIT'
     });
     if (p.isCancel(license)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     const options = {
@@ -83,34 +84,34 @@ export async function promptUser() {
         author: String(author),
         repository: repositoryValue,
         license: license,
-        types: ["theme"],
+        types: ['theme']
     };
     return options;
 }
 export async function promptThemeDetails() {
     const themeName = await p.text({
-        message: "Theme name:",
-        placeholder: "My Theme",
+        message: 'Theme name:',
+        placeholder: 'My Theme'
     });
     if (p.isCancel(themeName)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     const appearance = await p.select({
-        message: "Appearance:",
+        message: 'Appearance:',
         options: [
-            { value: "dark", label: "Dark" },
-            { value: "light", label: "Light" },
-            { value: "both", label: "Both (Dark & Light)" },
+            { value: 'dark', label: 'Dark' },
+            { value: 'light', label: 'Light' },
+            { value: 'both', label: 'Both (Dark & Light)' }
         ],
-        initialValue: "dark",
+        initialValue: 'dark'
     });
     if (p.isCancel(appearance)) {
-        p.cancel("Cancelled.");
+        p.cancel('Cancelled.');
         process.exit(0);
     }
     return {
         themeName: String(themeName),
-        appearance: appearance,
+        appearance: appearance
     };
 }

package/package.json

@@ -1,53 +1,53 @@
 {
-  "name": "zedx",
-  "version": "0.1.0",
-  "description": "Boilerplate generator for Zed extensions",
-  "type": "module",
-  "main": "dist/index.js",
-  "bin": {
-    "zedx": "dist/index.js"
-  },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc && cp -r src/templates dist/",
-    "start": "node dist/index.js",
-    "dev": "tsx src/index.ts"
-  },
-  "keywords": [
-    "zed",
-    "zed-editor",
-    "extension",
-    "boilerplate",
-    "scaffold"
-  ],
-  "author": "Taha Nejad <taha@noiserandom.com>",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/tahayvr/zedx.git"
-  },
-  "homepage": "https://github.com/tahayvr/zedx#readme",
-  "license": "Apache-2.0",
-  "publishConfig": {
-    "access": "public"
-  },
-  "engines": {
-    "node": ">=18"
-  },
-  "devDependencies": {
-    "@types/ejs": "^3.1.5",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^25.2.3",
-    "tsx": "^4.21.0",
-    "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "@clack/prompts": "^0.10.1",
-    "commander": "^14.0.3",
-    "ejs": "^4.0.1",
-    "fs-extra": "^11.3.3",
-    "picocolors": "^1.1.1"
-  },
-  "packageManager": "pnpm@10.30.0+sha512.2b5753de015d480eeb88f5b5b61e0051f05b4301808a82ec8b840c9d2adf7748eb352c83f5c1593ca703ff1017295bc3fdd3119abb9686efc96b9fcb18200937"
+	"name": "zedx",
+	"version": "0.2.0",
+	"description": "Boilerplate generator for Zed Edittor extensions.",
+	"type": "module",
+	"main": "dist/index.js",
+	"bin": {
+		"zedx": "dist/index.js"
+	},
+	"files": [
+		"dist"
+	],
+	"scripts": {
+		"build": "tsc && cp -r src/templates dist/",
+		"start": "node dist/index.js",
+		"dev": "tsx src/index.ts"
+	},
+	"keywords": [
+		"zed",
+		"zed-editor",
+		"extension",
+		"boilerplate",
+		"scaffold"
+	],
+	"author": "Taha Nejad <taha@noiserandom.com>",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/tahayvr/zedx.git"
+	},
+	"homepage": "https://github.com/tahayvr/zedx#readme",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"access": "public"
+	},
+	"engines": {
+		"node": ">=18"
+	},
+	"devDependencies": {
+		"@types/ejs": "^3.1.5",
+		"@types/fs-extra": "^11.0.4",
+		"@types/node": "^25.2.3",
+		"tsx": "^4.21.0",
+		"typescript": "^5.9.3"
+	},
+	"dependencies": {
+		"@clack/prompts": "^0.10.1",
+		"commander": "^14.0.3",
+		"ejs": "^4.0.1",
+		"fs-extra": "^11.3.3",
+		"picocolors": "^1.1.1"
+	},
+	"packageManager": "pnpm@10.30.0+sha512.2b5753de015d480eeb88f5b5b61e0051f05b4301808a82ec8b840c9d2adf7748eb352c83f5c1593ca703ff1017295bc3fdd3119abb9686efc96b9fcb18200937"
 }