Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crewdevio/Snel
A Cybernetical tool for svelte applications on deno
https://github.com/crewdevio/Snel
compiler deno snel svelte svelte3 sveltejs trex typescript
Last synced: 4 days ago
JSON representation
A Cybernetical tool for svelte applications on deno
- Host: GitHub
- URL: https://github.com/crewdevio/Snel
- Owner: crewdevio
- License: mit
- Created: 2021-01-16T02:02:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T18:18:02.000Z (9 months ago)
- Last Synced: 2024-10-30T00:32:02.451Z (5 days ago)
- Topics: compiler, deno, snel, svelte, svelte3, sveltejs, trex, typescript
- Language: TypeScript
- Homepage: https://crewdevio.mod.land/projects/Snel
- Size: 2.35 MB
- Stars: 316
- Watchers: 14
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - Snel
README
Snel 🦕
A Cybernetical tool for svelte applications on deno in deno (Snel = fast in Nederlands)
## What is Snel?
It is a `tool/framework` to compile .svelte component to javascript files to create web application using deno, vite and svelte
## Main features
- simple setup
- quick compilation
- hot reloading
- [import maps](https://github.com/WICG/import-maps) support (WIP)
- support for scss and less out of the box (WIP)
- support for typescript
- [SSG](docs/ssg.md) (WIP)
- SSR (WIP)
## What do I need to start using Snel?
the only thing you need is to run the installation command.
```console
deno install -A -n snel https://deno.land/x/snel/install.ts
```
## how to create a project with Snel?
after running the installation script you just have to run the create command:
```console
snel create [project name]
```
then you just have to enter the created project and start the development server
```console
cd ./[project name]
deno task start
```
this starts your application on a development server in the port you entered in the configuration
## Using svelte core libraries
to use svelte core libraries such as transition, store, motion etc. must be called using the following syntax:
```javascript
import { cubicOut } from "svelte/easing";
import { tweened } from "svelte/motion";
import { onMount } from "svelte";
```
`svelte` tells the compiler that svelte core resources are being accessed.
## Using import maps
You can use import maps to reference the dependencies you use, to use import maps from bes have an `import_map.json` file with the following structure:
```json
{
"imports": {
"[package name]": "[package url]"
}
}
```
In order for the compiler to know that you are using import maps, you need to import the dependencies as follows:
```javascript
import moment from "moment";
import axios from "axios";
```
> **note**: you can use import maps inside svelte components
## Snel config file
snel uses a configuration file to define different things, like the development server port or add different plugins, this file can be named as `snel.config.js` or `snel.config.ts`.
`example: snel.config.js`
```javascript
export default {
port: 3000, // development server port
mode: "dom", // type project "dom" | "ssg"
plugins: [], // plugins must be compatible with rollup deno
extendsImportMap: [
// extends import map using externas import maps
"https://denopkg.com/crewdevio/Snel-carbon@main/components.map.json",
],
};
```
config options:
- port (number): port number for development server
- mode (string): type project "dom" | "ssg"
- plugins (Plugin[ ]): plugins must be compatible with [rollup deno](https://deno.land/x/drollup)
- extendsImportMap (string[ ]): extends from externas import maps
if you want to use `snel.config.ts` you can import `snelConfig` interface to provide type checking:
`example: snel.config.ts`
```typescript
import type { snelConfig } from "https://deno.land/x/snel/mod.ts";
export default {
...
};
```
## Manage import maps dependencies using [trex](https://github.com/crewdevio/Trex)
if you don't have an import map.json file you can create it using the `trex install` command, trex is mainly focused on handling dependencies for `deno` but this doesn't prevent you from being able to use it to handle your dependencies for `snel/svelte`. to install any dependency you just have to use the [custom command](https://github.com/crewdevio/Trex#adding-custom-packages) from trex:
```console
trex --custom axios=https://cdn.skypack.dev/axios
```
this will install axios and it will make it accessible in the import map file:
```json
{
"imports": {
"axios": "https://cdn.skypack.dev/axios"
}
}
```
> **note**: You should know that your dependencies must be compatible with [es modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import) and with the browser, if you refer to some import maps package and it is not found by the compiler, it will not be transformed, so an error will appear in your browser.
we recommend these sites for you to install your dependencies
- [skypack.dev](https://www.skypack.dev/)
- [esm.sh](https://esm.sh/)
- [jsdelivr.com](https://www.jsdelivr.com/)
## Typescript, Sass and Less support
snel supports typescript out the box, so you can import typescript files into `.svelte` components without specifying the use of typescript within the component.
`App.svelte`
```html
import { PI } from "./pi.ts";
PI is = {PI}
h1 {
color: #ff3e00;
}
```
`pi.ts`
```typescript
export const PI: number = Math.PI;
```
Something important to know is that if you are going to import from typescript files without specifying the use of typescript within the component, you can only import non-types elements, example:
- types
- interfaces
in case you want to use the typescript inside the components, you just have to specify it in the `lang` attribute:
```html
import { PI } from "./pi.ts";
const message: string = "hello world";
interface User {
name: string;
passworld: string;
}
let user: User = { name: "jhon", passworld: "1234" };
```
to import types and interfaces into components these must be specified using the following syntax:
```html
import type { .... } from "./types.ts";
```
and you should only import types using this syntax and not combine imports with other elements.
```html
// bad
import type { UserInterface, myFunction } from "./user.ts";
// good
import type { UserInterface } from "./user.ts";
import { myFunction } from "./user.ts";
```
> **note**: typescript support within components is not stable and compilation errors in hot reloading may appear.
in the same way you can use the syntax of sass and less inside the components to define the styles.
```html
/* .... */
/* .... */
```
> **note**: for now importing external styles is not available for css, sass and less.
## Import components and files
when you create a project with snel you will notice that the components are imported as follows:
`example`
```javascript
// App.svelte
import Home from "@/components/Home.svelte";
```
`@/` It is equivalent to `./`, Similarly, if you need to access any component or file that is inside the src folder, you can use the following syntax:
`example`
```javascript
// src/Users.ts
export default class Users {
...
}
```
```javascript
// src/components/views/content/User.svelte
import Users from "~/Users.ts";
```
this would be equivalent to:
```javascript
import Users from "../../../Users.ts";
```
summary:
- `@/`
- equivalent to `./`
- `~/`
- equivalent to `[current work directory]/src/`
- `$/`
- equivalent to `[current work directory]/`
this syntax can be used in javascript, typescript files and components.
> **note**: you can change the behavior by rewriting the pattern inside the import_map.json file, although be careful when doing this.
## Deploy SPA app
If you want to have a simple workflow to deploy your SPA application, you can use this.
`deploy`
```yml
name: Build and Deploy
on:
push:
branches:
- main
jobs:
build:
runs-on: windows-latest
steps:
- name: Checkout 🛎️
uses: actions/[email protected]
- name: Install Deno
uses: denolib/setup-deno@v2
with:
deno-version: v1.x
- name: Build
run: |
deno run --allow-run --allow-read https://deno.land/x/snel/install.ts
trex run build
- name: Upload Artifacts 🔺
uses: actions/upload-artifact@v1
with:
name: site
path: dist
deploy:
needs: [build]
runs-on: ubuntu-latest
steps:
- name: Checkout 🛎️
uses: actions/[email protected]
- name: Download Artifacts 🔻
uses: actions/download-artifact@v1
with:
name: site
- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
branch: deploy
folder: "site"
clean-exclude: |
vercel.json
manifest.json
```
this compiles the application every time it is pushed to the `main` branch, and uploads the compiled files to the `deploy` branch, which could be deployed in hosts such as `vercel` or `netlify`.
If you are using the snel client router and you are going to deploy vercel or netlify you must add the respective configuration files to avoid having 404 errors.
`for vercel: vercel.json`
```json
{
"routes": [
{ "handle": "filesystem" },
{ "src": "/.*", "dest": "/index.html" }
]
}
```
`for netlify: _redirects`
```console
/* /index.html 200
```
to avoid this files was removed in each deploy, you can ignore specific files:
```yml
....
- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
branch: deploy
folder: "site"
clean-exclude: |
vercel.json # <- ignore vercel.json and manifest.json file
manifest.json
```
for github pages you can use this trick:
create a `404.html` file:
```html
....
sessionStorage.redirect = location.href;
```
and in your `index.html` add this:
```html
....
body:before {
content: attr(message);
}
.....
(() => {
const redirect = sessionStorage.redirect;
delete sessionStorage.redirect;
if (redirect && redirect !== location.href) {
history.replaceState(null, null, redirect);
// REMOVE THIS - just showing the redirect route in the UI
document.body.setAttribute(
"message",
"This page was redirected by 404.html, from the route: " + redirect
);
} else {
// REMOVE THIS - just showing the redirect route in the UI
document.body.setAttribute(
"message",
"This page was loaded directly from the index.html file"
);
}
})();
```
## Hot Reloading
Snel provides hot reload capability, it compiles and updates the application when changes are applied to it
`example`
