create-sveltex

[!IMPORTANT] The create-sveltex package will be deprecated in the future in favor of a community adder / add-on for the official Svelte CLI (see #12), as soon as such add-ons are supported (and I find the time to do it).

create-sveltex is a Node.js package intended to be run with pnpm dlx, bunx, npx, or yarn dlx to create a new SvelTeX project. It should not be used to add SvelTeX to an existing project.

Creating a project

pnpm dlx create-sveltex # If using PNPM
bunx     create-sveltex # If using Bun
npx      create-sveltex # If using NPM
yarn dlx create-sveltex # If using Yarn

...and follow the prompts.

Supported tools

Always included:

• TypeScript, for type-checking.

Pick one:

• Preferred package manager: PNPM, Bun, NPM, or Yarn.

Optional:

• Prettier, for code formatting.
• ESLint, for linting.
• Playwright, for end-to-end testing.
• Vitest, for unit testing.
• TailwindCSS, for utility-first CSS.
• Husky, for Git hooks. Includes lint-staged pre-commit git hook.
• Commitlint, for commit message linting. Adds a commit-msg git hook if Husky is also selected.
• .vscode folder with some helpful workspace settings.

Acknowledgments

create-sveltex is inspired by create-svelte, from which it borrows some code for the template files.

create-sveltex is powered by Plop, a great tool for code generation which uses Inquirer.js for prompts and Handlebars for templating.