feat: counter library example

dummdidumm · dummdidumm · commit 726910115ee9 · 2023-02-20T15:51:40.000+01:00
diff --git a/examples/counter-library/.gitignore b/examples/counter-library/.gitignore
@@ -0,0 +1,10 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
diff --git a/examples/counter-library/.npmrc b/examples/counter-library/.npmrc
@@ -0,0 +1 @@
+engine-strict=true
diff --git a/examples/counter-library/.prettierignore b/examples/counter-library/.prettierignore
@@ -0,0 +1,13 @@
+.DS_Store
+node_modules
+/build
+/.svelte-kit
+/package
+.env
+.env.*
+!.env.example
+
+# Ignore files for PNPM, NPM and YARN
+pnpm-lock.yaml
+package-lock.json
+yarn.lock
diff --git a/examples/counter-library/.prettierrc b/examples/counter-library/.prettierrc
@@ -0,0 +1,9 @@
+{
+	"useTabs": true,
+	"singleQuote": true,
+	"trailingComma": "none",
+	"printWidth": 100,
+	"plugins": ["prettier-plugin-svelte"],
+	"pluginSearchDirs": ["."],
+	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
+}
diff --git a/examples/counter-library/README.md b/examples/counter-library/README.md
@@ -0,0 +1,41 @@
+# Counter Library
+
+A Svelte library created with [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+
+## Developing
+
+Install dependencies with `npm install` (or `pnpm install` or `yarn`), and start a development server:
+
+```bash
+npm run dev
+```
+
+Develop your library within `src/lib`. Reexport everything that should be publicly available from `src/lib/index.js`. Preview/showcase your work within `src/routes`. In this example, there's one Counter component.
+
+## Building
+
+To prepare the library for release, run
+
+```bash
+npm run package
+```
+
+This will output everything that's inside `src/lib` into the `dist` folder, transforming TypeScript to JavaScript and creating type definitions. To publish the library to npm, run
+
+```bash
+npm publish
+```
+
+The result would be available for others as
+
+```svelte
+<script>
+	import { Counter } from 'your-library';
+</script>
+
+<Counter />
+```
+
+## More info
+
+Read the [packaging docs](https://kit.svelte.dev/docs/packaging) for more info on how to create a Svelte library.
diff --git a/examples/counter-library/package.json b/examples/counter-library/package.json
@@ -0,0 +1,40 @@
+{
+	"name": "counter-library",
+	"version": "0.0.1",
+	"scripts": {
+		"dev": "vite dev",
+		"build": "vite build && npm run package",
+		"preview": "vite preview",
+		"package": "svelte-kit sync && svelte-package && publint",
+		"prepublishOnly": "npm run package && publint",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"lint": "prettier --plugin-search-dir . --check .",
+		"format": "prettier --plugin-search-dir . --write ."
+	},
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"svelte": "./dist/index.js"
+		}
+	},
+	"peerDependencies": {
+		"svelte": "^3.54.0"
+	},
+	"devDependencies": {
+		"@sveltejs/adapter-auto": "^2.0.0",
+		"@sveltejs/kit": "^1.5.0",
+		"@sveltejs/package": "^2.0.0",
+		"prettier": "^2.8.0",
+		"prettier-plugin-svelte": "^2.8.1",
+		"publint": "^0.1.9",
+		"svelte": "^3.54.0",
+		"svelte-check": "^3.0.1",
+		"tslib": "^2.4.1",
+		"typescript": "^4.9.3",
+		"vite": "^4.0.0"
+	},
+	"svelte": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"type": "module"
+}
diff --git a/examples/counter-library/src/app.d.ts b/examples/counter-library/src/app.d.ts
@@ -0,0 +1,12 @@
+// See https://kit.svelte.dev/docs/types#app
+// for information about these interfaces
+declare global {
+	namespace App {
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface Platform {}
+	}
+}
+
+export {};
diff --git a/examples/counter-library/src/app.html b/examples/counter-library/src/app.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<link rel="icon" href="%sveltekit.assets%/favicon.png" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		%sveltekit.head%
+	</head>
+	<body>
+		<div>%sveltekit.body%</div>
+	</body>
+</html>
diff --git a/examples/counter-library/src/lib/Counter.svelte b/examples/counter-library/src/lib/Counter.svelte
@@ -0,0 +1,21 @@
+<script lang="ts">
+	import { createEventDispatcher } from "svelte";
+
+    export let count = 0;
+
+    const dispatch = createEventDispatcher<{ change: number }>();
+
+    function increment() {
+        count++;
+        dispatch('change', count);
+    }
+    
+    function decrement() {
+        count--;
+        dispatch('change', count);
+    }
+</script>
+
+<slot {count}><p>The count is {count}</p></slot>
+<button on:click={increment}>Increment</button>
+<button on:click={decrement}>Decrement</button>
diff --git a/examples/counter-library/src/lib/index.js b/examples/counter-library/src/lib/index.js
@@ -0,0 +1,2 @@
+// Reexport your entry components here
+export { default as Counter } from './Counter.svelte';
diff --git a/examples/counter-library/src/routes/+page.svelte b/examples/counter-library/src/routes/+page.svelte
@@ -0,0 +1,52 @@
+<script>
+	import Counter from '$lib/Counter.svelte';
+</script>
+
+<main>
+	<h1>Counter Library</h1>
+
+	<p>A library example using @sveltejs/package with a preview of the work using SvelteKit</p>
+
+	<p>Visit <a href="https://kit.svelte.dev">kit.svelte.dev</a> to read the documentation</p>
+
+	<div class="example">
+		<h2>Simple counter</h2>
+		<Counter />
+	</div>
+
+	<div class="example">
+		<h2>Custom start value</h2>
+		<Counter count={10} />
+	</div>
+
+	<div class="example">
+		<h2>Listening to the change event</h2>
+		<Counter on:change={(e) => alert('The count is ' + e.detail)} />
+	</div>
+
+	<div class="example">
+		<h2>Custom slot</h2>
+		<Counter let:count>
+			<p class="purple">The count is {count}</p>
+		</Counter>
+	</div>
+</main>
+
+<style>
+	main {
+		max-width: 600px;
+		margin: 0 auto;
+		padding: 1em;
+	}
+
+	.example {
+		border: 1px solid #ccc;
+		padding: 1em;
+		margin: 1em 0;
+	}
+
+	.purple {
+		color: purple;
+		font-weight: bold;
+	}
+</style>
diff --git a/examples/counter-library/static/favicon.png b/examples/counter-library/static/favicon.png
diff --git a/examples/counter-library/svelte.config.js b/examples/counter-library/svelte.config.js
@@ -0,0 +1,15 @@
+import adapter from '@sveltejs/adapter-auto';
+import { vitePreprocess } from '@sveltejs/kit/vite';
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+	// Consult https://kit.svelte.dev/docs/integrations#preprocessors
+	// for more information about preprocessors
+	preprocess: vitePreprocess(),
+
+	kit: {
+		adapter: adapter()
+	}
+};
+
+export default config;
diff --git a/examples/counter-library/tsconfig.json b/examples/counter-library/tsconfig.json
@@ -0,0 +1,17 @@
+{
+	"extends": "./.svelte-kit/tsconfig.json",
+	"compilerOptions": {
+		"allowJs": true,
+		"checkJs": true,
+		"esModuleInterop": true,
+		"forceConsistentCasingInFileNames": true,
+		"resolveJsonModule": true,
+		"skipLibCheck": true,
+		"sourceMap": true,
+		"strict": true
+	}
+	// Path aliases are handled by https://kit.svelte.dev/docs/configuration#alias
+	//
+	// If you want to overwrite includes/excludes, make sure to copy over the relevant includes/excludes
+	// from the referenced tsconfig.json - TypeScript does not merge them in
+}
diff --git a/examples/counter-library/vite.config.ts b/examples/counter-library/vite.config.ts
@@ -0,0 +1,6 @@
+import { sveltekit } from '@sveltejs/kit/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+	plugins: [sveltekit()]
+});
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// Reexport your entry components here`
	`2`	`+export { default as Counter } from './Counter.svelte';`