mirror of
https://github.com/nolanlawson/pinafore
synced 2024-12-12 18:28:03 +01:00
55 lines
2.7 KiB
Markdown
55 lines
2.7 KiB
Markdown
|
# Architecture
|
||
|
|
|
||
|
|
This document describes some things about the codebase that are worth knowing if you're trying to contribute.
|
||
|
|
Basically think of it as a "lay of the land" as well as "weird unusual stuff that may surprise you."
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Pinafore uses [SvelteJS](https://svelte.technology) and [SapperJS](https://sapper.svelte.technology). Most of it is a fairly typical Svelte/Sapper project, but there
|
||
|
|
are some quirks, which are described below. This list of quirks is non-exhaustive.
|
||
|
|
|
||
|
|
## Prebuild process
|
||
|
|
|
||
|
|
The `template.html` is itself templated. The "template template" has some inline scripts, CSS, and SVGs
|
||
|
|
injected into it during the build process. SCSS is used for global CSS and themed CSS, but inside of the
|
||
|
|
components themselves, it's just vanilla CSS because I couldn't figure out how to get Svelte to run a SCSS
|
||
|
|
preprocessor.
|
||
|
|
|
||
|
|
## Lots of small files
|
||
|
|
|
||
|
|
Highly modular, highly functional, lots of single-function files. Tends to help with tree-shaking and
|
||
|
|
code-splitting, as well as avoiding circular dependencies.
|
||
|
|
|
||
|
|
## emoji-picker-element is loaded as a third-party bundle
|
||
|
|
|
||
|
|
`emoji-picker-element` uses Svelte 3, whereas we use Svelte 2. So it's just imported
|
||
|
|
as a bundled custom element, not as a Svelte component.
|
||
|
|
|
||
|
|
## Some third-party code is bundled
|
||
|
|
|
||
|
|
For various reasons, `a11y-dialog`, `autosize`, and `timeago` are forked and bundled into the source code.
|
||
|
|
This was either because something needed to be tweaked or fixed, or I was trimming unused code and didn't
|
||
|
|
see much value in contributing it back, because it was too Pinafore-specific.
|
||
|
|
|
||
|
|
## Every Sapper page is "duplicated"
|
||
|
|
|
||
|
|
To get a nice animation on the nav bar when you switch columns, every page is lazy-loaded as `LazyPage.html`.
|
||
|
|
This "lazy page" is merely delayed a few frames to let the animation run. Therefore there is a duplication
|
||
|
|
between `src/routes` and `src/routes/_pages`. The "lazy page" is in the former, and the actual page is in the
|
||
|
|
latter. One imports the other.
|
||
|
|
|
||
|
|
## There are multiple stores
|
||
|
|
|
||
|
|
Originally I conceived of separating out the virtual list into a separate npm package, so I gave it its
|
||
|
|
own Svelte store (`virtualListStore.js`). This never happened, but it still has its own store. This is useful
|
||
|
|
anyway, because each store has its state maintained in an LRU cache that allows us to keep the scroll position
|
||
|
|
in the virtual list e.g. when the user hits the back button.
|
||
|
|
|
||
|
|
Also, the main `store.js` store is explicitly
|
||
|
|
loaded by every component that uses it. So there's no `store` inheritance; every component just declares
|
||
|
|
whatever store it uses. The main `store.js` is the primary one.
|
||
|
|
|
||
|
|
## There is a global event bus
|
||
|
|
|
||
|
|
It's in `eventBus.js`. This is useful for some stuff that is hard to do with standard Svelte or DOM events.
|