Svelte/SvelteKitの好きなところ5選

SvelteKitを業務で使って半年以上になるので私が気に入っているところを紹介したいと思います。
Svelte/SvelteKitいいじゃん！使ってみたい！って思ってもらえると嬉しいです。
対象読者はNext.jsやNuxt、それらに類するフレームワークを知っている、扱ったことがある程度の方です。

## そもそもSvelteってなに？
一応知らない方にも説明しておきます。
SvelteはReactやVue.jsに代表されるようなWebフロントエンドにおけるUIライブラリです。
Svelte自体は知ってる、聞いたことあるという方も多いのではないでしょうか？
この記事ではReactやVue.jsとの違いなどには触れませんので興味のある方は調べてみて下さい。

https://svelte.jp

## SvelteKitとは
SvelteKitはNext.jsやNuxtのようなWebアプリケーションを作成するフレームワークです。
こちらに関してもNext.jsやNuxtとの違いは特に触れません。
あえて触れるとするなら、SvelteKitはSvelteと同じコミュニティに管理されていることが前者との大きな違いです。
それによる恩恵は後ほど書きたいと思います。

https://kit.svelte.jp

# 1.TypeScriptの型補完が気持ち良い

https://svelte.jp/blog/zero-config-type-safety

公式のブログで詳しく語られているので詳細を知りたい方は上記を参照ください。
この記事ではざっくりこの機能の素晴らしさを書きたいと思います。
まずこの機能を語る上で説明しなくてはいけないことがあります。それはSvelteKitのルーティングに関してです。
SvelteKitのルーティングはファイルシステムベースのルーティングを採用していますが一見変わったルールがあります。
それはファイルの命名にルールが存在することです。
例えば`/about`というパスのルーティングを作成する場合以下のようなディレクトリとファイルになります。

```
/about
    - +page.server.ts
    - +page.svelte
```
このように`+page`から始まるファイルを作成し、`.server`ではサーバーで処理されるロジックを、`.svelte`はページのテンプレートを記述します。
Twitterを眺めているとこの仕様には賛否あるようですがルールがあることによって今回説明する機能が成り立っていると考えると個人的には良い判断だったのではないかと思います。

<blockquote class="twitter-tweet"><p lang="en" dir="ltr">how <a href="https://twitter.com/Rich_Harris?ref_src=twsrc%5Etfw">@Rich_Harris</a> went from &quot;about.svelte&quot; to &quot;/about/+page.svelte&quot; in <a href="https://twitter.com/sveltejs?ref_src=twsrc%5Etfw">@sveltejs</a> kit 1.0 is beyond incomprehensible<br><br>literally sending devs back to nextjs</p>&mdash; sam mueller (@samuel_mueller) <a href="https://twitter.com/samuel_mueller/status/1655842375837843457?ref_src=twsrc%5Etfw">May 9, 2023</a></blockquote> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

※当時の議論
https://github.com/sveltejs/kit/discussions/5748#discussioncomment-3282732

さて、話がそれてしまいましたが`+page.server.ts`では次のようなコードが書かれているとします。

```ts:+page.server.ts
export const load = () => {
  return {
    title: 'demo app'
  }
}
```

ページがSSRされる際やCSRでページ遷移する際にこのload関数が実行されます。
ちなみにCSRで遷移する際はHTTP APIとしてload関数が実行されサーバーで処理された結果をクライアントが受け取ります。
実行された結果は`+page.svelte`のpropsとして渡されます。

```svelte:+page.svelte
<script lang="ts">
  export let data
</script>

<h1>{ data.title }</h1>
```

サーバーのload関数の結果は`export let data`ですべて受け取れる仕様になっています。
このときVisual Studio Codeでこの変数をハイライトすると次のようにサーバーの結果の型が補完されていることがわかります。

![スクリーンショット 2023-05-28 0.25.02.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/89213/064fface-cc15-13e5-534c-24b6e42db416.png)


つまり、本来ネットワーク越しで受け渡しされるデータにも関わらずTypeScriptの型として扱うことができるということです。これってすごくないですか？


# 2.Streaming with Promiseがイケてる

先程の`+page.server.ts`の以下のように書き換えます。

```ts:+page.server.ts
export const load = () => {
  return {
    title: 'demo app',
    streamed: {
      defered: new Promise<string>((resolve) => {
        setTimeout(() => {
          resolve('Defered!!');
        }, 5000);
      })
    }
  }
}
```

`streamed`オブジェクトを追加し、その中のプロパティはPromiseを返すコードになっています。
これを使って`+page.svelte`も書き換えてみましょう。

```svelte:+page.svelte
<script lang="ts">
  export let data
</script>

<h1>{ data.title }</h1>

{#await data.streamed.defered}
  <p>Waiting.</p>
{:then value} 
  <p>{ value }</p>
{/await}
```

Promiseで返されているのでSvelteのテンプレート構文`{#await}`を利用してPromiseが解決されたら展開されるといったコードになります。
このコードでは、画面描画の5秒後に`Waiting.`から`Defered!`に切り替わります。

![hukn6-06h9n.gif](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/89213/25737a91-33d9-a4c4-da94-185409825c61.gif)


使い方は簡単ですよね？

※もちろんvalueの型もIDEでわかります。
![スクリーンショット 2023-05-28 0.35.34.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/89213/a223249d-9763-9d14-ee8f-4af74cf04c98.png)


この機能により、例えば画面描画時には不要なコンポーネントをmount後にHTTP APIからfetchしてデータ取得して展開する、といったいわゆる遅延表示処理の手間が一気に減ります。
また、コンポーネントごとにfetchするといったロジックが散らばること無く、遅延する処理も全てサーバー側に集約することになります。

このStreamingの機能についてはSvelteKit 1.8から実装されています。

https://svelte.jp/blog/streaming-snapshots-sveltekit

# 3.CSRでも全部aタグでOK
Svelteはコンパイラ、なんてことを聞いたことがあるかもしれません。ReactやVue.jsとは異なりライブラリのランタイムコードはクライアントにダウンロードされることはなく、ビルド時に純粋なJavaScriptとして展開される仕組みになっています。これをコンパイラだと呼ぶわけですがその恩恵は至る所に見られます。
その中でもSvelteKitではクライアントサイドでのルーティングでページ遷移をする際にHTMLの`a`タグ要素で書くだけで実現してくれます。
特別なカスタムエレメントタグやコンポーネントを使う必要はありません。

CSRではなくリロードによる通常のブラウザ遷移をしたい場合は`a`タグにデータ属性`data-sveltekit-reload`をつけるだけです。
あるいは`rel="external"`を指定することでも同様の効果になります。

純粋なHTMLだけでSPAのページ遷移を制御できる仕組みって良いですよね。

その他にも事前に次に見せたいページのデータをロードさせておくこともできたり柔軟な設計が可能です。

https://kit.svelte.jp/docs/link-options

# 4.アプリケーションが最新バージョンになっているかチェックできる仕組みがある
SvelteKitではクライアント側で動いているアプリケーションが最新であるかどうかをチェックする関数が用意されています。

https://kit.svelte.jp/docs/modules#$app-stores-updated

SSRとSPAのアプリではよくありがちな、サーバー側に新たにデプロイされたバーションとクライアント側で動いているアプリケーションのバージョンが異なることで、クライアントに意図した挙動を提供できないといったケースがあるかと思います。

その場合SvelteKitでは次のように対応できます。

```svelte:+layout.svelte
<script lang="ts">
  import { updated } from '$app/stores'
</script>

<div data-sveltekit-reload={$updated ? '' : 'off'}>
  <slot />
</div>
```

こうすることによってサーバー側に新しいバージョンのアプリが検知された場合は`a`リンクはすべてリロードになります。リロードになれば新しいJavaScriptファイルがダウンロードされるのでクライアント側も最新の状態になりますよね。
自前で作るにはちょっとめんどくさい仕組みが予め用意されているのはありがたいなと思います。

# 5.svelte-checkで安全に開発ができる
svelte-checkはSvelteKitに同梱されているCLIで利用するライブラリです。
主に以下の診断が可能です。
- 未使用のCSS
- アクセシビリティのヒント
- JavaScript/TypeScriptのコンパイルエラー

https://www.npmjs.com/package/svelte-check

SvelteKitでは`npm run check`コマンドで実行することができるので、CI環境等で利用することでプルリクエストのブロック等に活用できます。
Svelte Language Toolsが利用されているため、Visual Studio CodeのSvelte for VS Codeのプラグインを導入していればsvelte-checkと同等の機能をIDEの機能として利用できます。

最初にSvelteとSvelteKitが同じコミュニティにより管理されていると説明しましたが、それによる恩恵が強いと言える場面はまさにこのsvelte-checkだと感じています。
というのも、このsvelte-checkはSvelteKit独自の機能に対しても働きます。

例えば先程`a`タグの例で紹介しましたが、`a`タグが次のページの先読みを有効にしたり無効にしたりする機能があります。

```html
<div data-sveltekit-preload-data>
  <a href="/about" >About</a>
</div>
```

これは現在のSvelteKitでの書き方ですが、過去には以下のような書き方でした。

```html
<div data-sveltekit-prefetch>
  <a href="/about" >About</a>
</div>
```

この状態で現行バーションのsvelte-checkを実行すると以下のエラーが表示されます。

```
Error: Argument of type '{ "data-sveltekit-prefetch": boolean; }' is not assignable to parameter of type 'HTMLProps<"div", HTMLAttributes<any>>'.
  Object literal may only specify known properties, and '"data-sveltekit-prefetch"' does not exist in type 'HTMLProps<"div", HTMLAttributes<any>>'. (ts)

<div data-sveltekit-prefetch>
  <a href="/about" >About</a>
```

このように型定義に存在しないアトリビュートであることを教えてくれます。
では現行バーションで動くように変更し、IDEでマウスホバーしてみます。

![スクリーンショット 2023-05-28 1.40.51.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/89213/02910ff9-a88d-a297-1335-53e5e9d1028d.png)

なんとアトリビュートに関する説明を表示してくれます！これはまさに同じコミュニティならではという連携ぶりかと思います。


# おまけ

おまけはちょっとポエムっぽいんですが、私がSvelteが好きな側面として、そもそもReact（というよりJSX）が苦手だったということがあるかと思います。個人的なイメージなんですが、ReactはJavaScriptの世界でHTMLを掌握するといった感じに見えてしまいちょっと苦手意識があったんですが、Svelteはその逆で[HTMLがもしインタラクティブになったとしたらどんなDSLになるか](https://zenn.dev/ryoppippi/articles/8addfe62eb4d3e#javascript%E3%81%AF%E3%82%A4%E3%83%99%E3%83%B3%E3%83%88%E9%A7%86%E5%8B%95%E3%80%81ui%E3%81%AF%E7%8A%B6%E6%85%8B%E9%A7%86%E5%8B%95-%5Bjavascript-is-event-driven%3B-ui-is-state-driven%5D)、といった発想が出発点となっているのでHTMLを拡張した世界と捉えられるかなと思います。クライアントサイドのルーティングを`a`タグで行える点なども、まさにHTMLそのものを使っていて良いなと思っています。

私が普段使ってない機能がまだまだ多く、SvelteKitはプログレッシブエンハンスメントなどにも力を入れていてJavaScriptが動かない環境でも適切に表示できるようにする仕組みなども備えています。そのへんはこの記事で紹介できていないので気になった方はドキュメントを一読いただくことをおすすめします。

この記事を読んでSvelte/SvelteKitいいなと思ったらぜひ触ってみてください！新規採用する際の比較検討の対象に加えたり、実際に採用される例が増えてくれると嬉しいです！

また、すでにSvelteを使っている方はぜひコメント等で好きな機能や活用シーンなんかを教えてくれると嬉しいです！（別途記事を書いてくださるともっと嬉しいです！）