Skip to content

Commit

Permalink
feat: 🎸 add svelte pug mixins (#38)
Browse files Browse the repository at this point in the history
* test: πŸ’ add test for transforming only whats between <template>

* refactor: πŸ’‘ add a warning if using onBefore() with svelte v3

* Release v2.9.1

* init

* adding svelte-preprocess, typescript, sass, pug

* add preprocess to client.svelte and server.svelte

* rewrote about from html to pug

* added tsconfig.json and started using ts

* remove index.svelte markup to pug

* feat: 🎸 add svelte pug mixins

* refactor: πŸ’‘ sapper ts + pug example

* chore: πŸ€– remove unimportant tests
  • Loading branch information
kaisermann authored May 29, 2019
1 parent ed62006 commit 543ab75
Show file tree
Hide file tree
Showing 29 changed files with 5,808 additions and 8 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,13 @@ Current supported out-of-the-box preprocessors are `SCSS`, `Stylus`, `Less`, `Co
<!-- Or -->

<style type="text/stylus">
$color= red
$color = red
div
color: $color;
</style>
```
#### Limitations
##### `typescript`
Since `typescript` is not officially supported by `svelte` for its template language, `svelte-preprocess` only type checks code between the `<script></script>` tag.
## Usage
### Auto Preprocessing
Expand Down Expand Up @@ -281,3 +275,23 @@ export default {
}
...
```
### Limitations
#### `typescript`
Since `typescript` is not officially supported by `svelte` for its template language, `svelte-preprocess` only type checks code between the `<script></script>` tag.
#### `pug`
Some of Svelte's template syntax is invalid in `pug`. `svelte-preprocess` provides some pug mixins to represent svelte's `{#...}{/...}` blocks: `+if()`, `+else()`, `+elseif()`, `+each()`, `+await()`, `+then()`, `+catch()`, `+debug()`.
```pug
ul
+if('posts && posts.length > 1')
+each('posts as post')
li
a(rel="prefetch" href="blog/{post.slug}") {post.title}
+else()
span No posts :c
```
1 change: 1 addition & 0 deletions examples/sapper-rollup/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__sapper__
88 changes: 88 additions & 0 deletions examples/sapper-rollup/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# sapper-template

The default [Sapper](/~https://github.com/sveltejs/sapper) template, with branches for Rollup and webpack. To clone it and get started:

```bash
# for Rollup
npx degit sveltejs/sapper-template#rollup my-app
# for webpack
npx degit sveltejs/sapper-template#webpack my-app
cd my-app
npm install # or yarn!
npm run dev
```

Open up [localhost:3000](http://localhost:3000) and start clicking around.

Consult [sapper.svelte.dev](https://sapper.svelte.dev) for help getting started.


## Structure

Sapper expects to find two directories in the root of your project β€” `src` and `static`.


### src

The [src](src) directory contains the entry points for your app β€” `client.js`, `server.js` and (optionally) a `service-worker.js` β€” along with a `template.html` file and a `routes` directory.


#### src/routes

This is the heart of your Sapper app. There are two kinds of routes β€” *pages*, and *server routes*.

**Pages** are Svelte components written in `.svelte` files. When a user first visits the application, they will be served a server-rendered version of the route in question, plus some JavaScript that 'hydrates' the page and initialises a client-side router. From that point forward, navigating to other pages is handled entirely on the client for a fast, app-like feel. (Sapper will preload and cache the code for these subsequent pages, so that navigation is instantaneous.)

**Server routes** are modules written in `.js` files, that export functions corresponding to HTTP methods. Each function receives Express `request` and `response` objects as arguments, plus a `next` function. This is useful for creating a JSON API, for example.

There are three simple rules for naming the files that define your routes:

* A file called `src/routes/about.svelte` corresponds to the `/about` route. A file called `src/routes/blog/[slug].svelte` corresponds to the `/blog/:slug` route, in which case `params.slug` is available to the route
* The file `src/routes/index.svelte` (or `src/routes/index.js`) corresponds to the root of your app. `src/routes/about/index.svelte` is treated the same as `src/routes/about.svelte`.
* Files and directories with a leading underscore do *not* create routes. This allows you to colocate helper modules and components with the routes that depend on them β€” for example you could have a file called `src/routes/_helpers/datetime.js` and it would *not* create a `/_helpers/datetime` route


### static

The [static](static) directory contains any static assets that should be available. These are served using [sirv](/~https://github.com/lukeed/sirv).

In your [service-worker.js](app/service-worker.js) file, you can import these as `files` from the generated manifest...

```js
import { files } from '@sapper/service-worker';
```

...so that you can cache them (though you can choose not to, for example if you don't want to cache very large files).


## Bundler config

Sapper uses Rollup or webpack to provide code-splitting and dynamic imports, as well as compiling your Svelte components. With webpack, it also provides hot module reloading. As long as you don't do anything daft, you can edit the configuration files to add whatever plugins you'd like.


## Production mode and deployment

To start a production version of your app, run `npm run build && npm start`. This will disable live reloading, and activate the appropriate bundler plugins.

You can deploy your application to any environment that supports Node 8 or above. As an example, to deploy to [Now](https://zeit.co/now), run these commands:

```bash
npm install -g now
now
```


## Using external components with webpack

When using Svelte components installed from npm, such as [@sveltejs/svelte-virtual-list](/~https://github.com/sveltejs/svelte-virtual-list), Svelte needs the original component source (rather than any precompiled JavaScript that ships with the component). This allows the component to be rendered server-side, and also keeps your client-side app smaller.

Because of that, it's essential that webpack doesn't treat the package as an *external dependency*. You can either modify the `externals` option under `server` in [webpack.config.js](webpack.config.js), or simply install the package to `devDependencies` rather than `dependencies`, which will cause it to get bundled (and therefore compiled) with your app:

```bash
npm install -D @sveltejs/svelte-virtual-list
```


## Bugs and feedback

Sapper is in early development, and may have the odd rough edge here and there. Please be vocal over on the [Sapper issue tracker](/~https://github.com/sveltejs/sapper/issues).
4 changes: 4 additions & 0 deletions examples/sapper-rollup/cypress.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"baseUrl": "http://localhost:3000",
"video": false
}
Loading

0 comments on commit 543ab75

Please sign in to comment.