acode-pluginx

CLI to scaffold a new Acode plugin project (JS/TS) with optional SCSS support. It also allows to add codemirror types for better autocompletion.

Requirements

• Node.js 18+ (recommended)
• One of: npm, pnpm, yarn, or bun

Install / run

You can run it without installing globally:

npx acode-pluginx <projectName> <pluginId> [options]

If you are developing this repo locally, you can run it from the project folder:

npx . <projectName> <pluginId> [options]

Quick examples

Create a TypeScript plugin using Bun and SCSS:

npx acode-pluginx myPlugin com.plugin.acode --ts --use-bun --scss

Create a JavaScript plugin using pnpm (no prompts for package manager):

npx acode-pluginx myPlugin com.plugin.acode --js --use-pnpm

Create inside the current directory (will warn if it’s not empty):

npx acode-pluginx . com.plugin.acode --ts --use-npm

Options

• --ts: Generate a TypeScript plugin project
• --js: Generate a JavaScript plugin project
• --scss: Include src/style.scss
• --use-bun: Use Bun in the generated project
• --use-pnpm: Use pnpm in the generated project
• --use-npm: Use npm in the generated project
• --use-yarn: Use Yarn in the generated project
• --cm-types: (Experimental) Generate codemirror packages types

Notes:

• Don’t pass both --ts and --js (it will error).
• If you don’t pass a package-manager flag, you’ll be prompted to choose one.

What it generates

In the new project folder, the CLI creates:

• src/main.ts or src/main.js (plugin entry)
• plugin.json (plugin metadata)
• esbuild.config.mjs (build + dev server + zip pack hook)
• pack-zip.js (creates dist.zip)
• tsconfig.json (when using TypeScript)
• icon.png (default icon)
• src/style.scss (only when --scss is used)

After generating a project

From the printed “Next steps”, you’ll typically do:

cd <projectName>
<packageManager> install
<packageManager> dev

License

ISC