https://github.com/ebullient/sandbox-customjs
CustomJS scripts for my Obsidian vaults
https://github.com/ebullient/sandbox-customjs
Last synced: 11 months ago
JSON representation
CustomJS scripts for my Obsidian vaults
- Host: GitHub
- URL: https://github.com/ebullient/sandbox-customjs
- Owner: ebullient
- License: mit
- Created: 2024-10-23T17:27:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-13T14:59:06.000Z (12 months ago)
- Last Synced: 2025-07-24T20:56:35.258Z (11 months ago)
- Language: TypeScript
- Size: 438 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sandbox: CustomJS + JS Engine
These are the scripts I use in my vault(s) to replace Dataview
I have two vaults: AllTheThings (actually, just most of the things) and Campaign Notes (TTRPG stuff).
I converted my CustomJS scripts to TypeScript, which brings some caveats to keep CustomJS happy.
## Building
```console
pnpm install
# Just build
npm run build
# Push built files to repositories
npm run push
# Build and watch for changes (and push those changes to repositories)
npm run dev
# Lint / Clean up files
npm run lint
```
## Pushing files to repositories
I have two repos, and not all of these scripts go to both places.
I use a json file, `.dev-target.tson` to determine what files to copy where. It contains something like the following:
```json
{
"_utils.ts": [
"/path/to/AllTheThings/assets/customjs/",
"/path/to/campaign-notes/assets/customjs/"
],
}
```
For each file in there, I define 1..n places it should get pushed. Works for me, you may think it's ridiculous. ;)
The scripts that achieve this are in `build/`
## Repository structure
### AllTheThings
```
├ assets/
│ ├ customjs/
│ └ templates/
├ chronicles/
│ ├ yyyy/
│ │ ├ yyyy-mm-dd.md
│ │ ├ yyyy-mm-dd_week.md
│ │ ├ yyyy-mm_month_.md
│ │ └ yyyy.md
│ └ ...
├ demesne (areas)
└ quests (projects)
```
For PARA-esque areas and projects (with funner names), I fall back to a Franklin-Covey-ish prioritization scheme: urgent and important are first; not-urgent and not-important are last. The frontmatter looks like this:
```yaml
---
aliases: ["Note Alias"]
type: quest
important: yes
urgent: no
status: active
role: owner
---
```
I prompt for important, urgent, status, and role on creation.
### Campaign Notes
```
├ assets/
│ ├ customjs/
│ └ templates/
├ heist/
│ ├ calendar/
│ │ ├ yyyy-harptosMonth-dd.md
│ │ └ ...
│ ├ characters/ (pc notes)
│ ├ encounters/ (encounter notes: e.g. multi-session events, story threads)
│ ├ sessions/
│ │ └ nnn-session-title.md
│ ├ tables/
│ │ └ random generator tables
│ ├ waterdeep/
│ │ ├ calendar/ (events and holidays)
│ │ ├ groups/ (notes for groups and factions)
│ │ ├ npcs/ (notes for npcs)
│ │ ├ places/ (notes for locations, which may include npcs)
│ │ └ ...
│ ├ all-summaries.md
│ ├ all-timeline.md
│ ├ grouped-timeline.md
│ ├ heist.md
│ └ ...
└ ...
```
I use deeply nested tags in my notes. I have templater prompts to work through selecting tags from the right scope for all known tags, etc.
I use a *LOT* of events in my notes (session notes and others).
- I use with Calendarium span tag (never front-matter).
- I have an emoji key that I use to code event descriptions:
My events look like this:
```html
...
```
## Development
For build commands, architecture overview, and development guidance, see [CLAUDE.md](CLAUDE.md).
This file is primarily written for Claude Code (AI assistant) but contains useful information for human contributors as well, including:
- Build and development commands
- Project architecture overview
- Integration points between components
## Scripts
The Templater templates that work with these scripts are in the templates directory
**Common**
- [_utils.ts](src/_utils.ts) - general utility functions
- [cmd-missing.ts](src/cmd-task-cleanup.ts) - CustomJS command; evaluate contents of vault, and update a note to list missing links and unreferenced files
**AllTheThings**
- [activity.ts](src/activity.ts) - activity charts, created by counting occurence of tags
- [cmd-all-tasks.ts](src/cmd-all-tasks.ts) - CustomJS command; create/update a note that embeds `Tasks` sections from some notes
- [cmd-task-cleanup.ts](src/cmd-task-cleanup.ts) - CustomJS command; evaluate contents of vault. Find tasks completed earlier than this month, and remove their task status (✔️ or 〰️)
- [dated.ts](src/dated.ts) - Working with dated notes: daily notes for time blocking, weekly notes for planning, monthly for goals/reflection, years for "dates to remember"
- [priority.ts](src/priority.ts) - Functions for working with PARA-esque Projects and Areas, including working with role/priority/status/etc.
- [tasks.ts](src/tasks.ts) - Functions for working with tasks (specifically, finding the tasks in a file, or collecting a list of tasks completed in a given week)
- [templater.ts](src/templater.ts) - Functions that augment templater templates (choosing values for prompts, transporting text
**Campaign Notes**
- [campaign.ts](src/activity.ts) - Campaign-specific utility functions
- [cmd-heist-summaries.ts](src/cmd-heist-summaries.ts) - CustomJS command; merges the summary sections from all heist session notes into one note
- [cmd-tag-lists.ts](src/cmd-tag-lists.ts) - CustomJS command; evaluate contents of vault. Find all notes with a certain tag, and create a rollable table with a row for each note (dice roller w/o dataview)
- [cmd-timeline.ts](src/cmd-timeline.ts) - CustomJS command; Use the Calendarium API to find all events for a particular calendar. Update the contents of two notes: all-timeline (all events in chronological order), and grouped-timeline (all events grouped by faction or group, as determined by an emoji in the event title)
- [reference.ts](src/reference.ts) - utility functions to find and create cross-referencing lists or tables for different types (locations, npcs, areas, factions)