A monorepo for building and managing Obsidian plugins using TypeScript, PNPM, and Biome.

This project is a monorepo containing multiple Obsidian plugins and shared utilities. It uses PNPM for dependency management, TypeScript for type safety, and Biome for linting and formatting. The monorepo structure allows for shared code between plugins while maintaining separate builds for each plugin.

• @doomwhite-obsidian-plugins/common: A shared utility library used by the plugins.
• @doomwhite-obsidian-plugins/plugin1: An example Obsidian plugin.

• Node.js: Version 16.20.2 or higher (recommend upgrading to the latest LTS, e.g., 20.x).
• PNPM: Version 10.6.5 (specified in packageManager).

git clone https://github.com/Doomwhite/obsidian-plugins.git doomwhite-obsidian-plugins
cd doomwhite-obsidian-plugins

Install dependencies using PNPM:

pnpm install

Build all packages in the monorepo:

pnpm build

Run the development script for a specific plugin (e.g., plugin1):

pnpm dev:plugin1

This will start the development server for plugin1 and watch for changes.

This project uses Biome for linting and formatting. Biome ensures consistent code style and catches potential issues in TypeScript and JavaScript files.

• Configuration: See biome.json in the root for linting and formatting rules.
• Formatting Rules:
  • 2-space indentation
  • Single quotes
  • Semicolons required
  • 80-character line width
• Linting Rules:
  • Recommended Biome rules enabled
  • noNonNullAssertion disabled
  • noExplicitAny set to warn

To format and lint your code:

pnpm format
pnpm lint

To check for issues without fixing them (useful in CI):

pnpm lint:check

doomwhite-obsidian-plugins/
├── packages/
│   ├── common/               # Shared utilities (@doomwhite-obsidian-plugins/common)
│   │   ├── src/
│   │   │   └── index.ts
│   │   └── package.json
│   └── plugins/
│       └── plugin1/          # Example plugin (@doomwhite-obsidian-plugins/plugin1)
│           ├── src/
│           │   └── main.ts
│           └── package.json
├── .github/
│   └── workflows/            # GitHub Actions workflows
│       ├── build.yml
│       └── lint-format.yml
├── biome.json                # Biome configuration
├── package.json
├── pnpm-lock.yaml
└── pnpm-workspace.yaml       # PNPM workspace configuration