Nil's monorepo

This repo will be my sandbox to try different tools and libraries for my own learning experience. Packages will be published to npmjs with @nil- scope.

Details listed in this README are things I applied to this monorepo and probably in some of its workspaces.

---

Workspaces

Workspace	Changelog	Deployment
projects/doc	Changelog	@nil-/doc
projects/3d	Changelog	@nil-/3d
projects/gate	Changelog	@nil-/gate

---

Currently uses:

• pnpm
• turborepo
• changeset

---

Scripts

command	purpose
pnpm build	build all "servers"
pnpm package	generate publishable packages
pnpm clean	remove all generated files
pnpm dev:3d	spawn @nil-/3d web server
pnpm dev:doc	spawn @nil-/doc web server
pnpm dev:gate	spawn @nil-/gate web server
pnpm test:unit	run unit tests
pnpm format	apply prettier for the whole repo
pnpm check	check svelte-check for all workspaces
pnpm lint	check prettier and eslint
pnpm graph <command>	generate graphs/<command>.png for script dependency graph
pnpm commit:vercel	commit staged files with a message to force deployment in vercel

---

Workflow

• push changes to remote
• github action .github/workflows/publish.yml will create MR for version bump if necessary
• merge version bump MR when ready for release
• Vercel should deploy only when there is a new release

---

Fallback Page

There are multiple ways to do this but the easiest for me is to simply add a page to capture the routes: /.../[...rest]/+page.ts

import { redirect } from "@sveltejs/kit";
export const load = () => {
    throw redirect(303, "/1-Motivation");
};

A better approach would probably be to use sveltekit's hooks.

---

Peer Workspace Dependency

Depending on peer workspace is done by the following:

• "@nil-/doc": "workspace:^"
• package.json contains:

{
    "publishConfig": {
        "directory": "package",
        "linkDirectory": true
    }
}

---

Peer Dependencies

Some of the library projects has peerDependencies that are also necessary for documentation.

Due to this, i have added the following configuration to .npmrc

auto-install-peers=true
strict-peer-dependencies=true

As a side effect, pnpm update -r does not automatically update those packages, but instead creates another entries for dependencies.

For now, removing these dependencies would be a manual task until I find a better appraoch.

---

mdsvex

For documentation, I am using mdsvex to be able to write the pages in markdown and write any interactive portion in svelte.

svelte-check fails when seeing markdown inside svelte file as they are not valid svelte syntax.

Because of this, svelte files with markdown are now using .mdsvelte extension to intentionally skip them in prettier, eslint and svelte-check.

In svelte.config.js, these information is set:

{
    preprocess: [mdsvex({ extensions: ["+page.svelte", "+page.mdsvelte"] })],
    extensions: [".svelte", ".mdsvelte"],
}

+page.mdsvelte routes are added to @nil-/doc by adding the following:

const { data, current, navigate } = sveltekit(
    import.meta.glob(["./**/+page.svelte", "./**/+page.mdsvelte"])
);

commit message and changeset tags

For consistency commit messages and changesets should follow these rules:

[<workspace>][<purpose>] <message>

key	description	example
workspace	shorthand workspace name	mono / doc / 3d / gate
purpose	more info below
message	clear description of the change

Purpose

value	description
break	(major) breaking changes
new	(minor) new behavior / feature
patch	(patch) refactoring or minor code changes
fix	(patch) bug fixes
docu	(vercel deployment) documentation changes

break / new / patch / fix will not be used yet for released versions until v1.0