Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mnaoumov/generator-obsidian-plugin

Yeoman generator for Obsidian Plugin Bootstrap
https://github.com/mnaoumov/generator-obsidian-plugin

Last synced: 2 months ago
JSON representation

Yeoman generator for Obsidian Plugin Bootstrap

Host: GitHub
URL: https://github.com/mnaoumov/generator-obsidian-plugin
Owner: mnaoumov
License: mit
Created: 2024-01-17T01:11:01.000Z (11 months ago)
Default Branch: master
Last Pushed: 2024-09-18T05:24:20.000Z (3 months ago)
Last Synced: 2024-10-01T09:41:46.496Z (3 months ago)
Language: TypeScript
Size: 1.17 MB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# generator-obsidian-plugin [![](https://badge.fury.io/js/generator-obsidian-plugin.svg)](https://npmjs.org/package/generator-obsidian-plugin)

> Obsidian Plugin Bootstrap

## Installation

For template generator to be fully working it requires [Node.js](https://nodejs.org/) v18 or higher.

First, install [Yeoman](http://yeoman.io) and generator-obsidian-plugin using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-obsidian-plugin
```

Then generate your new project:

```bash
yo obsidian-plugin
```

## Features of this template

- Enables [unofficial](https://github.com/Fevol/obsidian-typings/) TypeScript typings to the internal [Obsidian](https://obsidian.md/) API.
- Code style is forced via [`ESLint`](https://eslint.org/).
- Spell checking is forced via [`CSpell`](https://cspell.org/).
- Uses CLI commands and code helpers from [Obsidian Dev Utils](https://github.com/mnaoumov/obsidian-dev-utils).

### NPM Commands

The package offers several NPM commands to facilitate common development tasks:

#### Build Production Version

```bash
npm run build
```

Compiles the production version of your plugin into the `dist/build` folder.

#### Build Development Version

```bash
npm run dev
```

Compiles the development version of your plugin into the `dist/dev` folder. The `OBSIDIAN_CONFIG_DIR` can be set either as an environment variable or specified in a `.env` file (e.g., `path/to/my/vault/.obsidian`). The command automatically copies the compiled plugin to the specified Obsidian configuration directory and triggers the [Hot Reload] plugin, if it is enabled. If the [Hot Reload] plugin is not installed, it will be installed automatically, and you will need to enable it manually.

#### Lint Code

```bash
npm run lint
```

Lints your code, enforcing a code convention to minimize common errors.

#### Lint and Fix Code

```bash
npm run lint:fix
```

Lints your code and automatically applies fixes where possible.

#### Spellcheck Code

```bash
npm run spellcheck
```

Checks your code for spelling errors.

#### Version Management

```bash
npm run version
```

Runs build checks before updating the version and releases if all checks pass. The `` can be `major`, `minor`, `patch`, `beta`, or a specific version like `x.y.z[-suffix]`.

## Support

## License