ObsidianScripts 📜

This is the name I use to identify the very first scripts I have written to inflate Obsidian. They are written in JS, and can be opened using the ObsidianScripts.code-workspace file.

It's a good version to work with, but I'm now afraid of modifying them and break something as they are not protected by tests. This is where Obsinflate comes into the game.

I keep them here as I slowly but surely move them into the Obsinflate framework.

Obsinflate 🎈

TypeScript framework that allows building extension scripts for the following Obsidian plugins :

• Dataview
• User Plugins
• Quick Add

Highlights

The benefits of this framework are

• having a fully tested code, to easely maintain it,
• having a fully typed code, to easely read it.

The framework is implemented following the TDD method. The tests are then the specs 🔥.

🔎 NOTE : In the whole documentation, I call inflates all the scripts implemented using this framework.

Documentation

• Development Workflow
  • Setting up
  • Building and bundling
  • Inflating
  • Testing and debugging
  • Deploying
• Working with Obisidian API
  • Jest considerations
  • Webpack considerations
  • Module functions considerations
• Usages
  • Configuring inflates into Obsidian
• Contributing
  • Coding rules
  • Commit message format