Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
109 lines (80 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

109 lines (80 loc) · 2.67 KB

Contributin to Svench

Installation

git clone
cd svench

Svench

cd packages/svench
pnpm install
pnpm dev # watch & rebuild

# watch & rebuild only some parts
#
# targets: app, theme, rollup (rollup plugin), util-esm, prism
#
pnpm dev -- --configTarget app,theme

Run (the few) tests:

pnpm test
pnpm test -- --watch
pnpm test -- --help # see all of Zoar's (the test runner) options

Sub projects

Svench is composed from multiple parts what have to work together...

In Node

  • lib/rollup-plugin.js The plugin for Rollup

  • lib/svenchify.js The Svenchify util -- that injects the Rollup plugin into an existing config from "the outside", without needing to edit the project's config (and risk breaking it for some users)

  • lib/preprocessor.js Svench does some static analysis of Svench components to extract View names, sources, etc. when possible (i.e. when views are not dynamic). This needs to be a preprocessor, because we need to see the Svelte code (i.e. not the compiled JS). Also, it needs to be the last preprocessor in the chain (so that it doesn't see the input Markdown of Mdsvex, for example).

In the browser

  • src/index.js The Svench lib itself (the Svench component, the start util, etc.)

  • src/app The components composing (the default) Svench's UI: top bar, menu, view boxes, etc. This part is packaged separately because Svench's UI is intended to be "pluggable" -- it is conceived so that some of its components or its whole could be replaced by the user for customization.

  • themes CSS of the default theme, and the default markdown theme (used in Mdsvex pages, copied from Github). There published both in .css (e.g. themes/default.css), and .css.js "self contained" form.

  • src/app/prism.js A prebuilt version of Prism (syntax highlighter) that works well with Svench, including a selection of plugin (like Svelte highlighting) and embedded CSS.

Docs

cd docs
pnpm install
pnpx svench

Examples

Vite

cd examples/vite-default-svelte-template
pnpm install
# with cli:
pnpx svench

Snowpack

cd examples/snowpack-csa
pnpm install
# "manual" setup:
pnpm svench:plugin
# start with cli:
pnpm svench:cli
# or run cli directly:
pnpx svench

Rollup (from sveltejs/template)

cd examples/svelte-template
pnpm install
# "manual" setup with Nollup (default):
pnpm svench:plugin
# "manual" setup with Rollup:
pnpm svench:plugin:rollup
# start with cli:
pnpm svench:cli
# or run cli directly:
pnpx svench

Rollup (legacy example)

cd examples/rollup
pnpm install
pnpm svench # Rollup + rollup-plugin-hot
# or
pnpm svench:nollup # Nollup