\n \n\n[](http://commitizen.github.io/cz-cli/)  \n\n\n\n\n> [!IMPORTANT] \n> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.\n\n\n\n\n
\nBe sure to ⭐ this repository on GitHub so you can keep up to date on any daily progress!\n
\n\n \n\n\n\n\n\n\n# Razorwind - Cursor Theme Extension Plugin\n\n**Razorwind - Cursor Theme Extension** creates Cursor-installable theme extensions from design tokens. Cursor is a VS Code fork and loads the same VSIX theme format ([Dracula Cursor](https://draculatheme.com/cursor) is a good reference).\n\n## Installing\n\nUsing [pnpm](http://pnpm.io):\n\n```bash\npnpm add -D @razorwind/cursor\n```\n\n\n Using npm\n\n```bash\nnpm install -D @razorwind/cursor\n```\n\n\n\n\n Using yarn\n\n```bash\nyarn add -D @razorwind/cursor\n```\n\n\n\n## Usage\n\n```ts\nimport { defineConfig } from \"@razorwind/core\";\nimport cursor, { flattenTokens } from \"@razorwind/cursor\";\n\nexport default defineConfig({\n plugins: [\n cursor({\n name: \"my-theme\",\n publisher: \"acme\",\n displayName: \"My Theme\",\n mapTheme: tokens => {\n const flat = flattenTokens(tokens);\n const color = (path: string) =>\n flat.find(t => t.path === path)?.cssValue ?? \"#000000\";\n\n return [\n {\n name: \"my-theme-dark\",\n displayName: \"My Theme Dark\",\n type: \"dark\",\n colors: {\n \"editor.background\": color(\"color.bg\"),\n \"editor.foreground\": color(\"color.fg\")\n }\n },\n {\n name: \"my-theme-light\",\n displayName: \"My Theme Light\",\n type: \"light\",\n colors: {\n \"editor.background\": color(\"color.bg\"),\n \"editor.foreground\": color(\"color.fg\")\n }\n }\n ];\n }\n })\n ]\n});\n```\n\nGenerated package (under `cursor-extension/` by default):\n\n- `themes/*.json` — VS Code–compatible theme documents from `mapTheme`\n- `package.json` — extension manifest + `contributes.themes` + `package-vsix` script\n- `.vscodeignore`, `README.md`\n- `INSTALL.md` — Cursor VSIX install steps\n- `scripts/` — VSIX packaging helpers (`buildCursorPackage`, `vsixPackageShim`)\n\n### Options\n\n| Option | Default | Description |\n| ---------------- | --------------------- | ----------------------------------------------------------------- |\n| `name` | _(required)_ | Unscoped extension id |\n| `publisher` | _(required)_ | Extension publisher id |\n| `mapTheme` | _(required)_ | `(tokens) =>` theme, theme array, or theme record |\n| `outputPath` | `\"cursor-extension\"` | Output directory for the extension package |\n| `displayName` | title-cased `name` | Extension / Color Theme display name |\n| `version` | `\"0.0.1\"` | Extension version (no prerelease tags) |\n| `includeScripts` | `true` | Emit packaging `scripts/` + `package.json` script entries |\n| `extensionName` | `name` | Unscoped name used by the VSIX shim / `dist/.vsix` |\n| `installGuide` | _(generated)_ | Override body for generated `INSTALL.md` |\n\n`mapTheme` return shapes: a single `CursorTheme`, an array, or a `Record`. Theme `type` is `light` | `dark` | `hc` | `hcLight` (maps to `uiTheme` in `contributes.themes`).\n\n### Install in Cursor\n\nAfter generation, from the output directory:\n\n```bash\npnpm package-vsix\n```\n\nThen in Cursor: Command Palette → **Extensions: Install from VSIX...** → select `./dist/.vsix` → **Preferences: Color Theme**. See generated `INSTALL.md` for the full steps.\n\n## Development\n\n### Building\n\nRun `nx build cursor` to build the library.\n\n### Running unit tests\n\nRun `nx test cursor` to execute the unit tests via [Vitest](https://vitest.dev/).\n\n### Running unit tests\n\nRun `nx test vsce` to execute the unit tests via [Vitest](https://vitest.dev/).\n\n\n\n\n\n\n## Storm Workspaces\n\nStorm workspaces are built using\nNx, a set of extensible dev tools\nfor monorepos, which helps you develop like Google, Facebook, and Microsoft.\nBuilding on top of Nx, the Open System provides a set of tools and patterns that\nhelp you scale your monorepo to many teams while keeping the codebase\nmaintainable.\n\n
\n \n\n## Roadmap\n\nSee the [open issues](https://github.com/storm-software/razorwind/issues) for\na list of proposed features (and known issues).\n\n- [Top Feature Requests](https://github.com/storm-software/razorwind/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)\n (Add your votes using the 👍 reaction)\n- [Top Bugs](https://github.com/storm-software/razorwind/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)\n (Add your votes using the 👍 reaction)\n- [Newest Bugs](https://github.com/storm-software/razorwind/issues?q=is%3Aopen+is%3Aissue+label%3Abug)\n\n
\n \n\n## Support\n\nReach out to the maintainer at one of the following places:\n\n- [Contact](https://stormsoftware.com/contact)\n- [GitHub discussions](https://github.com/storm-software/razorwind/discussions)\n- \n\n
\n \n\n## License\n\nThis project is licensed under the **Apache License 2.0**. Feel free to edit and\ndistribute this template as you like.\n\nSee [LICENSE](LICENSE) for more information.\n\n
\n \n\n## Changelog\n\nThis project adheres to\n[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along\nwith the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)\nfile\n\n
\n \n\n## Contributing\n\nFirst off, thanks for taking the time to contribute! Contributions are what\nmakes the open-source community such an amazing place to learn, inspire, and\ncreate. Any contributions you make will benefit everybody else and are **greatly\nappreciated**.\n\nPlease try to create bug reports that are:\n\n- _Reproducible._ Include steps to reproduce the problem.\n- _Specific._ Include as much detail as possible: which version, what\n environment, etc.\n- _Unique._ Do not duplicate existing opened issues.\n- _Scoped to a Single Bug._ One bug per report.\n\nPlease adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).\n\nYou can use\n[markdownlint-cli](https://github.com/storm-software/razorwind/markdownlint-cli)\nto check for common markdown style inconsistency.\n\n
\n\n\n\nThis project follows the\n[all-contributors](https://github.com/all-contributors/all-contributors)\nspecification. Contributions of any kind welcome!\n\n
\n \n\nStorm Software is an open source software development organization and creator\nof Acidic, StormStack and StormCloud.\n\nOur mission is to make software development more accessible. Our ideal future is\none where anyone can create software without years of prior development\nexperience serving as a barrier to entry. We hope to achieve this via LLMs,\nGenerative AI, and intuitive, high-level data modeling/programming languages.\n\nJoin us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,\nreceive release notifications, ask questions, and get involved.\n\nIf this sounds interesting, and you would like to help us in creating the next\ngeneration of development tools, please reach out on our\n[website](https://stormsoftware.com/contact) or join our\n[Slack channel](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)!\n\n \n\n
![\"Razorwind\"](\"https://public.storm-cdn.com/razorwind/media/banner-1280x427-dark.gif\")
\n![\"Patrick](\"https://avatars.githubusercontent.com/u/99053093?v=4?s=100\")
![\"Tyler](\"https://avatars.githubusercontent.com/u/7265547?v=4?s=100\")
![\"Stormie\"/](\"https://avatars.githubusercontent.com/u/149802440?v=4?s=100\")
![\"All](\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\"){kind=logo}
\n Add your contributions\n \n ![\"Storm](\"https://public.storm-cdn.com/storm-software/media/banner-1280x320-dark.webp\")
\n![\"Storm](\"https://public.storm-cdn.com/storm-software/icons/circle-dark.webp\"){kind=icon}
![\"Visit](\"https://public.storm-cdn.com/misc/text/visit-us-dark.png\")