create-svelte-library-template 0.0.1

package/README.md

@@ -0,0 +1,33 @@
+# create-svelte-library-template
+
+A CLI to scaffold a pure Svelte component library powered by Svelte 5, Vite, and Storybook.
+
+## Quick Start
+
+You can now easily create a new Svelte component library project using `pnpm create`:
+
+```bash
+pnpm create svelte-library-template <project-name>
+```
+
+Alternatively, you can use `npx`, `yarn`, or `bun`:
+
+```bash
+npx create-svelte-library-template <project-name>
+yarn create svelte-library-template <project-name>
+bun create svelte-library-template <project-name>
+```
+
+If you don't specify a project name, it will default to `svelte-library`.
+
+## What's included?
+
+The generated project comes pre-configured with:
+- **Svelte 5**
+- **Storybook 8** for component-driven development
+- **TypeScript** out-of-the-box
+- **Prettier** and **Publint** for code quality and package validation
+
+## License
+
+Apache-2.0

package/bin/index.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+// 1. Get the target directory name (e.g., my-app)
+const targetDir = process.argv[2] || 'svelte-library';
+const cwd = process.cwd();
+const root = path.join(cwd, targetDir);
+
+console.log(`\n🚀 Creating project: ${targetDir}...`);
+
+// 2. Create the target directory
+fs.mkdirSync(root, { recursive: true });
+
+// 3. Get the template directory path
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const templateDir = path.resolve(__dirname, '../template');
+
+// 4. Recursively copy template files to the target directory
+const copyRecursive = (src, dest) => {
+  const stats = fs.statSync(src);
+  if (stats.isDirectory()) {
+    fs.mkdirSync(dest, { recursive: true });
+    for (const file of fs.readdirSync(src)) {
+      copyRecursive(path.join(src, file), path.join(dest, file));
+    }
+  } else {
+    fs.copyFileSync(src, dest);
+  }
+};
+copyRecursive(templateDir, root);
+
+// 5. Modify the name field in the target project's package.json
+const pkgPath = path.join(root, 'package.json');
+const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+pkg.name = targetDir; // Dynamically replace with the user's input name
+fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2));
+
+// 6. Rename _gitignore to .gitignore
+const gitignorePath = path.join(root, '_gitignore');
+if (fs.existsSync(gitignorePath)) {
+  fs.renameSync(gitignorePath, path.join(root, '.gitignore'));
+}
+
+console.log(`\n✅ Created successfully! Run the following commands to start developing:\n`);
+console.log(`  cd ${targetDir}`);
+console.log(`  pnpm install`);
+console.log(`  pnpm run storybook\n`);

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "create-svelte-library-template",
+  "version": "0.0.1",
+  "description": "A CLI to scaffold a pure Svelte component library",
+  "bin": {
+    "create-svelte-library-template": "./bin/index.js"
+  },
+  "files": [
+    "bin",
+    "template"
+  ],
+  "type": "module"
+}
+

package/template/.prettierignore

@@ -0,0 +1,9 @@
+# Package Managers
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+bun.lock
+bun.lockb
+
+# Miscellaneous
+/static/

package/template/.svelte-kit/__package__/components/button.svelte

@@ -0,0 +1,4 @@
+<script lang="ts">
+</script>
+
+<button>Button</button>

package/template/.svelte-kit/__package__/components/button.svelte.d.ts

@@ -0,0 +1,18 @@
+interface $$__sveltets_2_IsomorphicComponent<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any, Exports = {}, Bindings = string> {
+    new (options: import('svelte').ComponentConstructorOptions<Props>): import('svelte').SvelteComponent<Props, Events, Slots> & {
+        $$bindings?: Bindings;
+    } & Exports;
+    (internal: unknown, props: {
+        $$events?: Events;
+        $$slots?: Slots;
+    }): Exports & {
+        $set?: any;
+        $on?: any;
+    };
+    z_$$bindings?: Bindings;
+}
+declare const Button: $$__sveltets_2_IsomorphicComponent<Record<string, never>, {
+    [evt: string]: CustomEvent<any>;
+}, {}, {}, string>;
+type Button = InstanceType<typeof Button>;
+export default Button;

package/template/.svelte-kit/__package__/index.d.ts

@@ -0,0 +1 @@
+export { default as Button } from './components/button.svelte';

package/template/.svelte-kit/__package__/index.js

@@ -0,0 +1,2 @@
+// Reexport your entry components here
+export { default as Button } from './components/button.svelte';

package/template/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["svelte.svelte-vscode", "esbenp.prettier-vscode"]
+}

package/template/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/template/README.md

@@ -0,0 +1,68 @@
+# Svelte Library Template (Svelte Component Library Template)
+
+A minimal, ready-to-use Svelte component library template powered by Svelte 5 and Vite. This template comes pre-configured with a streamlined project structure, TypeScript, and Storybook for component-driven development.
+
+## Features
+
+- **Svelte 5**: Utilizing the latest Svelte features.
+- **Storybook 8**: Pre-configured for component development, documentation, and testing.
+- **Minimal Structure**: Clean, intuitive architecture designed specifically for library authors.
+- **TypeScript Ready**: Full static typing support out-of-the-box.
+- **pnpm**: Fast, disk space efficient package manager.
+- **Linting & Formatting**: Prettier and Publint included for code quality and package validation.
+
+## Project Structure
+
+```text
+.
+├── src/
+│   ├── lib/          # Your library code goes here (components, utilities)
+│   └── routes/       # Optional SvelteKit routes for testing/previewing
+├── .storybook/       # Storybook configuration
+├── dist/             # Compiled library output (after build)
+└── package.json      # Scripts and dependencies
+```
+
+## Getting Started
+
+1. **Install dependencies** (recommended to use `pnpm` as configured):
+   ```bash
+   pnpm install
+   ```
+
+2. **Start Storybook** to develop your components in isolation:
+   ```bash
+   pnpm run storybook
+   ```
+
+3. **Start the local dev server** (if you are using `src/routes` for testing):
+   ```bash
+   pnpm run dev
+   ```
+
+## Available Scripts
+
+- `pnpm run storybook`: Starts the Storybook server on port 6006.
+- `pnpm run build-storybook`: Builds a static version of Storybook.
+- `pnpm run build`: Packages the library into the `dist` folder, ready for publishing, and runs `publint`.
+- `pnpm run check`: Runs Svelte and TypeScript checks.
+- `pnpm run lint`: Checks formatting with Prettier.
+- `pnpm run format`: Auto-formats code using Prettier.
+
+## Building and Publishing
+
+When your components are ready, build the package:
+
+```bash
+pnpm run build
+```
+
+This will create a `dist` directory with your compiled Svelte components and TypeScript definitions. You can then publish your library to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+This project is licensed under the [Apache License 2.0](./LICENSE).

package/template/_gitignore

@@ -0,0 +1,28 @@
+node_modules
+
+# Output
+.output
+.vercel
+.netlify
+.wrangler
+/.svelte-kit
+/build
+/dist
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
+
+*storybook.log
+storybook-static
+.storybook

package/template/dist/components/button.svelte

@@ -0,0 +1,4 @@
+<script lang="ts">
+</script>
+
+<button>Button</button>

package/template/dist/components/button.svelte.d.ts

@@ -0,0 +1,18 @@
+interface $$__sveltets_2_IsomorphicComponent<Props extends Record<string, any> = any, Events extends Record<string, any> = any, Slots extends Record<string, any> = any, Exports = {}, Bindings = string> {
+    new (options: import('svelte').ComponentConstructorOptions<Props>): import('svelte').SvelteComponent<Props, Events, Slots> & {
+        $$bindings?: Bindings;
+    } & Exports;
+    (internal: unknown, props: {
+        $$events?: Events;
+        $$slots?: Slots;
+    }): Exports & {
+        $set?: any;
+        $on?: any;
+    };
+    z_$$bindings?: Bindings;
+}
+declare const Button: $$__sveltets_2_IsomorphicComponent<Record<string, never>, {
+    [evt: string]: CustomEvent<any>;
+}, {}, {}, string>;
+type Button = InstanceType<typeof Button>;
+export default Button;

package/template/dist/index.d.ts

@@ -0,0 +1 @@
+export { default as Button } from './components/button.svelte';

package/template/dist/index.js

@@ -0,0 +1,2 @@
+// Reexport your entry components here
+export { default as Button } from './components/button.svelte';

package/template/package.json

@@ -0,0 +1,58 @@
+{
+	"name": "svelte-library-template",
+	"version": "0.0.1",
+	"scripts": {
+		"build": "svelte-package && publint",
+		"check": "svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-check --tsconfig ./tsconfig.json --watch",
+		"lint": "prettier --check .",
+		"format": "prettier --write .",
+		"storybook": "storybook dev -p 6006",
+		"build-storybook": "storybook build"
+	},
+	"files": [
+		"dist",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"sideEffects": [
+		"**/*.css"
+	],
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js"
+		}
+	},
+	"peerDependencies": {
+		"svelte": "^5.0.0"
+	},
+	"devDependencies": {
+		"@sveltejs/package": "^2.5.8",
+		"@sveltejs/vite-plugin-svelte": "^7.1.2",
+		"prettier": "^3.8.3",
+		"prettier-plugin-svelte": "^4.1.0",
+		"publint": "^0.3.21",
+		"svelte": "^5.56.1",
+		"svelte-check": "^4.6.0",
+		"typescript": "^6.0.3",
+		"vite": "^8.0.16",
+		"storybook": "^10.6.0",
+		"@storybook/svelte-vite": "^10.6.0",
+		"@storybook/addon-svelte-csf": "latest",
+		"@chromatic-com/storybook": "latest",
+		"@storybook/addon-vitest": "^10.6.0",
+		"@storybook/addon-a11y": "^10.6.0",
+		"@storybook/addon-docs": "^10.6.0",
+		"vitest": "latest",
+		"playwright": "latest",
+		"@vitest/browser-playwright": "latest",
+		"@vitest/coverage-v8": "latest"
+	},
+	"keywords": [
+		"svelte"
+	]
+}