repository·main·Indexed 19 days ago
https://github.com/jycouet/kitqlA collection of standalone libraries and Vite plugins designed to accelerate WebApp development. KitQL includes specialized packages such as @kitql/sveltekit, @kitql/helpers, @kitql/handles, and @kitql/eslint-config, as well as Vite plugins like vite-plugin-kit-routes, vite-plugin-watch-and-run, and vite-plugin-stripper. It features a modular architecture allowing developers to install only the specific tools they need, including a kitql-lint tool that orchestrates eslint, prettier, oxlint, and oxfmt.
@kitql/handles package is part of the KitQL ecosystem. KitQL is not a single monolithic library, but rather a collection of standalone libraries designed to work together. @kitql/handles provides specific functionality related to 'Handles' within this ecosystem.vite-plugin-stripper is a Vite plugin designed to strip specific content from your code during the build process. It is part of the KitQL ecosystem, which is a collection of standalone libraries rather than a single monolithic framework.The kitql-lint tool orchestrates four optional tools. By default, it runs eslint and prettier. You can customize the toolset using the -t flag.
Available Tools:
eslint: Linter (handles Svelte rules, pnpm catalog rules, and custom rules).prettier: Formatter (supports all file types, including .svelte).oxlint: A faster Rust-based linter that covers most JS/TS rules.oxfmt: A faster Rust-based formatter (Note: does not support .svelte files yet).Tool Selection Patterns:
eslint + prettier.oxlint and oxfmt.oxlint, tsgolint, oxfmt, eslint, and prettier. When using this combo, enable oxlint integration in your ESLint config to prevent duplicate work on .ts/.js files.oxfmt is included in your toolset, prettier automatically restricts its scope to **/*.svelte files, leaving all other file types to oxfmt.# Default (eslint + prettier)
kitql-lint
# Recommended for Svelte (full oxc + svelte support)
kitql-lint -t oxlint,tsgolint,oxfmt,eslint,prettier
# Pure oxc (no .svelte support)
kitql-lint -t oxlint,tsgolint,oxfmtThe watch property can be configured in several ways to target specific files or directories:
path.resolve to ensure the pattern matches against the absolute path.path.resolve with a relative path to watch files outside the current project root (e.g., in a monorepo).watch that is called with the filepath, allowing for custom logic to determine if a file should trigger the command.// Watch all TypeScript files in the project
{
watch: path.resolve('**/*.ts')
}
// Watch a specific file outside the project root
{
watch: path.resolve('../../README.md')
}import.meta.env.SSR constant. By wrapping code in if (import.meta.env.SSR) { ... }, the client-side tree-shaker can drop the block during build. vite-plugin-stripper automates this wrapping for decorator-based code (e.g., Remult's @BackendMethod or @Entity server-only callbacks) so you don't have to manually wrap every method.You can install vite-plugin-watch-and-run via npm. This plugin is designed to work with Vite to provide watch-and-run capabilities.
npm install vite-plugin-watch-and-run@kitql/sveltekit package, including usage guides and API references, can be found at the official KitQL documentation site.To enable the plugin, import kitRoutes from vite-plugin-kit-routes and add it to the plugins array in your vite.config.js (or equivalent configuration file).
import { sveltekit } from '@sveltejs/kit/vite'
import { kitRoutes } from 'vite-plugin-kit-routes'
/** @type {import('vite').UserConfig} */
export default config = {
plugins: [
sveltekit(),
// ✅ Add the plugin
kitRoutes(),
],
}Install vite-plugin-stripper as a development dependency to automate the removal of server-only code (like decorators) from your client-side browser bundle.
npm i -D vite-plugin-stripper