litestar-vite 0.12.1__tar.gz → 0.13.0__tar.gz

{litestar_vite-0.12.1 → litestar_vite-0.13.0}/.gitignore

@@ -166,3 +166,4 @@ cython_debug/
 .vscode
 
 node_modules
+.aider*

{litestar_vite-0.12.1 → litestar_vite-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: litestar-vite
-Version: 0.12.1
+Version: 0.13.0
 Summary: Vite plugin for Litestar
 Project-URL: Changelog, https://cofin.github.io/litestar-vite/latest/changelog
 Project-URL: Discord, https://discord.gg/X3FJqy8d2j

{litestar_vite-0.12.1 → litestar_vite-0.13.0}/pyproject.toml

@@ -25,7 +25,7 @@ license = { text = "MIT" }
 name = "litestar-vite"
 readme = "README.md"
 requires-python = ">=3.8"
-version = "0.12.1"
+version = "0.13.0"
 
 [project.urls]
 Changelog = "https://cofin.github.io/litestar-vite/latest/changelog"
@@ -42,19 +42,12 @@ nodeenv = ["nodeenv"]
 build-backend = "hatchling.build"
 requires = ["hatchling"]
 
-[tool.hatch.build]
-dev-mode-dirs = ["src/py", "."]
-
-
 [tool.hatch.build.targets.sdist]
-exclude = [".github", "docs"]
-packages = ["src/py/litestar_vite", "src/py/tests"]
-include = ["src/py/*","src/js/*"]
-skip-excluded-dirs = false
+exclude = ["/.github", "/docs"]
+include = ["src/py/*","src/js/*","tools/*"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/py/litestar_vite"]
-sources = ["src/py"]
 
 [dependency-groups]
 dev = [ {include-group = "build"}, { include-group = "linting" }, { include-group = "test" }, { include-group = "docs" }  ]
@@ -90,7 +83,7 @@ test = [
 allow_dirty = true
 commit = true
 commit_args = "--no-verify"
-current_version = "0.12.1"
+current_version = "0.13.0"
 ignore_missing_files = false
 ignore_missing_version = false
 message = "chore(release): bump to v{new_version}"
@@ -341,7 +334,7 @@ venv = ".venv"
 
 [tool.mypy]
 disallow_untyped_defs = false
-files = ["src/py/litestar_vite", "src/py/tests"]
+files = ["src/py/litestar_vite", "src/py/tests", "tools"]
 follow_imports = "normal"          # "silent" for not following
 ignore_missing_imports = true
 pretty = true
@@ -349,12 +342,6 @@ show_column_numbers = true
 warn_no_return = false
 warn_unused_ignores = true
 
-[[tool.mypy.overrides]]
-ignore_missing_imports = true
-module = [
-  "awaitlet",
-]
-
 [[tool.mypy.overrides]]
 disable_error_code = "attr-defined"
 disallow_untyped_decorators = false
@@ -362,7 +349,7 @@ module = "tests.*"
 
 [tool.codespell]
 ignore-words-list = "selectin"
-skip = 'pdm.lock,examples/inertia/package-lock.json,examples/inertia/public/assets/*.js'
+skip = 'uv.lock,examples/inertia/package-lock.json,examples/inertia/public/assets/*.js'
 
 [tool.git-cliff.changelog]
 body = """

litestar_vite-0.13.0/src/js/LICENSE

@@ -0,0 +1,45 @@
+The MIT License (MIT)
+
+Copyright (c) 2021, 2022, 2023 Litestar Org.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+Code adapted from:
+
+The MIT License (MIT)
+
+Copyright (c) Taylor Otwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

litestar_vite-0.13.0/src/js/Makefile

@@ -0,0 +1,66 @@
+SHELL := /bin/bash
+# =============================================================================
+# Variables
+# =============================================================================
+
+.DEFAULT_GOAL:=help
+.ONESHELL:
+NODE_MODULES_EXISTS		=	$(shell python3 -c "if __import__('pathlib').Path('node_modules').exists(): print('yes')")
+
+.EXPORT_ALL_VARIABLES:
+
+ifndef VERBOSE
+.SILENT:
+endif
+
+
+.PHONY: help
+help: 		   										## Display this help text for Makefile
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+.PHONY: upgrade
+upgrade:       										## Upgrade all dependencies to the latest stable versions
+	@echo "=> Updating all dependencies"
+	@npm upgrade --latest
+	@echo "=> Dependencies Updated"
+	# @pre-commit autoupdate
+	# @echo "=> Updated Pre-commit"
+
+# =============================================================================
+# Developer Utils
+# =============================================================================
+install:											## Install the project and
+	@if [ "$(NODE_MODULES_EXISTS)" ]; then echo "=> Removing existing node modules"; fi
+	@if [ "$(NODE_MODULES_EXISTS)" ]; then $(MAKE) destroy-node_modules; fi
+	@echo "=> Installing all dependencies"
+	@npm ci install --silent
+	@echo "=> Install complete! Note: If you want to re-install re-run 'make install'"
+
+destroy-node_modules: 											## Destroy the node environment
+	@rm -rf node_modules
+# =============================================================================
+# Tests, Linting, Coverage, Build
+# =============================================================================
+.PHONY: lint
+lint: 												## Runs pre-commit hooks; includes ruff linting, codespell, black
+	@echo "=> Running pre-commit process"
+	@pre-commit run --all-files
+	@echo "=> Pre-commit complete"
+
+.PHONY: test
+test:  												## Run the tests
+	@echo "=> Running test cases"
+	@npm run test
+	@echo "=> Tests complete"
+
+.PHONY: build
+build:
+	@echo "=> Building package..."
+	@npm run build
+	@echo "=> Package build complete..."
+
+.PHONY: publish
+publish: test build
+	@echo "=> Publishing package..."
+	@npm publish
+	@echo "=> Package publish complete..."

litestar_vite-0.13.0/src/js/NOTICE

@@ -0,0 +1,25 @@
+# NOTICE
+
+Code adapted from:
+
+The MIT License (MIT)
+
+Copyright (c) Taylor Otwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

litestar_vite-0.13.0/src/js/README.md

@@ -0,0 +1,15 @@
+# Litestar Vite Plugin
+
+**Notice** This is experimental software
+
+## What is this?
+
+This is a library for Litestar and Vite that makes integration between the the two easier.
+
+For details on usage, use the `litestar-vite` [plugin](https://github.com/cofin/litestar-vite)
+
+## Credit
+
+The team at Laravel have done an incredible job at making it easier to use common JS/TS frameworks with the framework.
+
+This plugin is more than a little inspired by the worker here [Laravel's Vite Integration](https://github.com/laravel/vite-plugin)

litestar_vite-0.13.0/src/js/src/dev-server-index.html

@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+<html>
+    <head>
+        <meta charset="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+
+        <title>Litestar Vite</title>
+
+        <!-- Fonts -->
+        <link
+            href="https://fonts.googleapis.com/css2?family=Nunito:wght@400;600;700&display=swap"
+            rel="stylesheet"
+        />
+
+        <script src="https://cdn.tailwindcss.com"></script>
+    </head>
+    <body class="antialiased">
+        <div
+            class="relative flex min-h-screen flex-col justify-center overflow-hidden bg-gray-100 text-gray-600 dark:text-gray-400 dark:bg-gray-900 py-6 sm:py-12"
+        >
+            <div
+                class="relative bg-white dark:bg-gray-800 px-6 pt-10 pb-8 shadow-xl ring-1 ring-gray-900/5 sm:mx-auto sm:max-w-xl sm:rounded-lg sm:px-10"
+            >
+                <div class="mx-auto">
+                    <div class="flex items-center justify-center space-x-6">
+                        <a href="https://litestar.dev">
+                            <svg
+                                viewBox="0 52 410 250"
+                                xmlns="http://www.w3.org/2000/svg"
+                                class="h-16 w-auto"
+                            >
+                                <defs>
+                                    <clipPath id="9eb7762d41">
+                                        <path
+                                            d="M 15.933594 105 L 328 105 L 328 259 L 15.933594 259 Z M 15.933594 105 "
+                                            clip-rule="nonzero"
+                                        />
+                                    </clipPath>
+                                    <clipPath id="183d3cc178">
+                                        <path
+                                            d="M 142 78.769531 L 359.433594 78.769531 L 359.433594 296.269531 L 142 296.269531 Z M 142 78.769531 "
+                                            clip-rule="nonzero"
+                                        />
+                                    </clipPath>
+                                </defs>
+                                <g clip-path="url(#9eb7762d41)">
+                                    <path
+                                        fill="#edb641"
+                                        d="M 147.625 240.3125 C 161.5 233.984375 173.554688 227.011719 183.425781 220.550781 C 202.304688 208.203125 226.4375 185.242188 227.761719 183.410156 L 218.917969 177.503906 L 211.257812 172.386719 L 235.503906 171.441406 L 243.296875 171.136719 L 245.414062 163.640625 L 252.007812 140.304688 L 260.402344 163.054688 L 263.097656 170.363281 L 270.890625 170.058594 L 295.136719 169.113281 L 276.078125 184.117188 L 269.953125 188.9375 L 272.652344 196.25 L 281.046875 218.996094 L 260.871094 205.523438 L 254.390625 201.195312 L 248.265625 206.015625 L 229.207031 221.023438 L 232.480469 209.425781 L 235.796875 197.691406 L 236.207031 196.234375 C 213.003906 213.585938 180.546875 230.304688 161.140625 236.488281 C 156.6875 237.90625 152.183594 239.179688 147.625 240.3125 Z M 101.992188 258.078125 C 136.382812 256.734375 177.355469 248 217.675781 222.363281 L 209.90625 249.867188 L 254.910156 214.4375 L 302.539062 246.246094 L 282.71875 192.539062 L 327.71875 157.109375 L 270.46875 159.34375 L 250.648438 105.636719 L 235.085938 160.726562 L 177.835938 162.964844 L 210.980469 185.097656 C 189.164062 204.921875 134.445312 247.195312 61.957031 250.03125 C 47.300781 250.601562 31.914062 249.558594 15.933594 246.394531 C 15.933594 246.394531 52.011719 260.035156 101.992188 258.078125 "
+                                        fill-opacity="1"
+                                        fill-rule="nonzero"
+                                    />
+                                </g>
+                                <g clip-path="url(#183d3cc178)">
+                                    <path
+                                        fill="#edb641"
+                                        d="M 250.789062 78.96875 C 190.78125 78.96875 142.140625 127.570312 142.140625 187.519531 C 142.140625 198.875 143.886719 209.816406 147.121094 220.101562 C 151.847656 217.75 156.363281 215.316406 160.660156 212.84375 C 158.394531 204.789062 157.183594 196.296875 157.183594 187.519531 C 157.183594 135.871094 199.089844 93.996094 250.789062 93.996094 C 302.484375 93.996094 344.390625 135.871094 344.390625 187.519531 C 344.390625 239.171875 302.484375 281.042969 250.789062 281.042969 C 222.75 281.042969 197.597656 268.722656 180.441406 249.210938 C 175.453125 251.152344 170.402344 252.917969 165.289062 254.511719 C 185.183594 279.816406 216.082031 296.070312 250.789062 296.070312 C 310.792969 296.070312 359.433594 247.472656 359.433594 187.519531 C 359.433594 127.570312 310.792969 78.96875 250.789062 78.96875 "
+                                        fill-opacity="1"
+                                        fill-rule="nonzero"
+                                    />
+                                </g>
+                                <path
+                                    fill="#edb641"
+                                    d="M 92.292969 173.023438 L 98.289062 191.460938 L 117.691406 191.460938 L 101.992188 202.855469 L 107.988281 221.292969 L 92.292969 209.898438 L 76.59375 221.292969 L 82.589844 202.855469 L 66.894531 191.460938 L 86.296875 191.460938 L 92.292969 173.023438 "
+                                    fill-opacity="1"
+                                    fill-rule="nonzero"
+                                />
+                                <path
+                                    fill="#edb641"
+                                    d="M 120.214844 112.25 L 125.390625 128.167969 L 142.140625 128.167969 L 128.589844 138 L 133.765625 153.917969 L 120.214844 144.082031 L 106.664062 153.917969 L 111.839844 138 L 98.289062 128.167969 L 115.039062 128.167969 L 120.214844 112.25 "
+                                    fill-opacity="1"
+                                    fill-rule="nonzero"
+                                />
+                                <path
+                                    fill="#edb641"
+                                    d="M 34.695312 209.136719 L 37.71875 218.421875 L 47.492188 218.421875 L 39.585938 224.160156 L 42.605469 233.449219 L 34.695312 227.707031 L 26.792969 233.449219 L 29.8125 224.160156 L 21.90625 218.421875 L 31.679688 218.421875 L 34.695312 209.136719 "
+                                    fill-opacity="1"
+                                    fill-rule="nonzero"
+                                />
+                            </svg>
+                        </a>
+                        <svg
+                            xmlns="http://www.w3.org/2000/svg"
+                            class="h-6 w-6 text-gray-500"
+                            fill="none"
+                            viewBox="0 0 24 24"
+                            stroke="currentColor"
+                            stroke-width="2"
+                        >
+                            <path
+                                stroke-linecap="round"
+                                stroke-linejoin="round"
+                                d="M12 4v16m8-8H4"
+                            />
+                        </svg>
+                        <a href="https://vitejs.dev">
+                            <svg
+                                viewBox="0 0 410 404"
+                                fill="none"
+                                xmlns="http://www.w3.org/2000/svg"
+                                class="h-16 w-auto"
+                            >
+                                <path
+                                    d="M399.641 59.5246L215.643 388.545C211.844 395.338 202.084 395.378 198.228 388.618L10.5817 59.5563C6.38087 52.1896 12.6802 43.2665 21.0281 44.7586L205.223 77.6824C206.398 77.8924 207.601 77.8904 208.776 77.6763L389.119 44.8058C397.439 43.2894 403.768 52.1434 399.641 59.5246Z"
+                                    fill="url(#paint0_linear)"
+                                />
+                                <path
+                                    d="M292.965 1.5744L156.801 28.2552C154.563 28.6937 152.906 30.5903 152.771 32.8664L144.395 174.33C144.198 177.662 147.258 180.248 150.51 179.498L188.42 170.749C191.967 169.931 195.172 173.055 194.443 176.622L183.18 231.775C182.422 235.487 185.907 238.661 189.532 237.56L212.947 230.446C216.577 229.344 220.065 232.527 219.297 236.242L201.398 322.875C200.278 328.294 207.486 331.249 210.492 326.603L212.5 323.5L323.454 102.072C325.312 98.3645 322.108 94.137 318.036 94.9228L279.014 102.454C275.347 103.161 272.227 99.746 273.262 96.1583L298.731 7.86689C299.767 4.27314 296.636 0.855181 292.965 1.5744Z"
+                                    fill="url(#paint1_linear)"
+                                />
+                                <defs>
+                                    <linearGradient
+                                        id="paint0_linear"
+                                        x1="6.00017"
+                                        y1="32.9999"
+                                        x2="235"
+                                        y2="344"
+                                        gradientUnits="userSpaceOnUse"
+                                    >
+                                        <stop stop-color="#41D1FF" />
+                                        <stop offset="1" stop-color="#BD34FE" />
+                                    </linearGradient>
+                                    <linearGradient
+                                        id="paint1_linear"
+                                        x1="194.651"
+                                        y1="8.81818"
+                                        x2="236.076"
+                                        y2="292.989"
+                                        gradientUnits="userSpaceOnUse"
+                                    >
+                                        <stop stop-color="#FFEA83" />
+                                        <stop
+                                            offset="0.0833333"
+                                            stop-color="#FFDD35"
+                                        />
+                                        <stop offset="1" stop-color="#FFA800" />
+                                    </linearGradient>
+                                </defs>
+                            </svg>
+                        </a>
+                    </div>
+                    <div class="divide-y divide-gray-300 dark:divide-gray-700">
+                        <div class="py-8 text-base leading-7">
+                            <p>
+                                This is the Vite development server that
+                                provides Hot Module Replacement for your
+                                Litestar application.
+                            </p>
+                            <p class="mt-6">
+                                To access your Litestar application, you will
+                                need to run a local development server.
+                            </p>
+                        </div>
+                        <div class="pt-8 text-base leading-7">
+                            <p>
+                                Your Litestar application's configured
+                                <code
+                                    class="text-sm font-bold text-gray-900 dark:text-gray-100"
+                                    >APP_URL</code
+                                >
+                                is:<br />
+                                <a
+                                    href="{{ APP_URL }}"
+                                    class="font-semibold text-red-500 hover:text-red-600"
+                                    >{{ APP_URL }}</a
+                                >
+                            </p>
+                            <p class="mt-6">
+                                Want more information on Litestar's Vite
+                                integration?
+                            </p>
+                            <p>
+                                <a
+                                    href="https://litestar.dev/docs/vite"
+                                    class="font-semibold text-red-500 hover:text-red-600"
+                                    >Read the docs &rarr;</a
+                                >
+                            </p>
+                        </div>
+                    </div>
+                </div>
+            </div>
+        </div>
+    </body>
+</html>