Utilities

Summary

This describes utilities modules.

In general, the way to think about utilities is to add them to points where they can be most readily re-used.

In order of precedence:

- [[pro.common-all]]
- [[Common Server|pro.]]
- [[Dendron Engine|pro.dendron-engine]]
- [[Dendron Plugin|pro.dendron-plugin]]

By Library

Common-All

  • constants (eg. name of dendron.yml file, etc)
  • time utilities
  • helpers to work with vaults and notes
  • note utilities

Common-Server

  • express.js related utilties
    • loc: server
  • files
    • loc: filesv2
  • logging
    • loc: logger
  • os related stats
    • loc: system
  • exports execa

Dendron CLI

Start anchor utilities not found

Engine

Start anchor utilities not found

Plugin

Start anchor utilities not found

Engine Test Utils

Start anchor utilities not found

Git Utils

  • NOTE: git support is a wrapper around the native git installation. we assume a minimal version of 2.20. when adding new functionality, make sure that it is available in git 2.20

  • engine-server:src/topics/git.ts

  • common-server:src/git.ts