Skip to content
This repository was archived by the owner on Jun 14, 2023. It is now read-only.
This repository was archived by the owner on Jun 14, 2023. It is now read-only.

Will a cookiecutter template help developers? #32

@anselmwang

Description

@anselmwang

Hi, @marcusolsson

Thanks for creating this awesome document. Now I enjoy obsidian plugin development a lot!

During development, I find it is tedious to start a new plugin because some duplication work

  • create directory with plugin name
  • use plugin name to update the plugin class in main.ts
  • fill plugin in manifest.json and package.json

Therefore, I create a cookiecutter template for obsidian plugin development.
By simply running cookiecutter https://github.com/anselmwang/cookiecutter-obsidian-plugin, the cookiecutter tool will ask developers some questions (author, project name, etc.) and generate a project with everything ready. According to my investigation, this is the only cookiecutter template for obsidian till now.

May I know if the template is worth to be mentioned in the document? No matter what the answer is, I am happy to hear your feedback.

If the answer is yes, I am thinking add it to the "Introduction" -> "Unofficial resources by community members:" part or update the Step 1 and Step2 of the "Create your first plugin".

Below is a snapshot of how the template works. Most of the time I can rely on the default value.

c:\GitRoot>cookiecutter https://github.com/anselmwang/cookiecutter-obsidian-plugin
full_name [Yu Wang]:
email [anselmwang@gmail.com]:
author_url [https://github.com/anselmwang]:
project_name_snake [test_template]: key_sequence_shortcut
project_name_kebab [key-sequence-shortcut]:
project_name [Key Sequence Shortcut]:
project_name_pascal [KeySequenceShortcut]:
project_short_description [Refreshingly simple static site generator.]:  Execute obsidian commands with short key sequences. For example, 'tp' for 'Toggle Preview' and 'tb' for 'Toggle Sidebar'. Easier to remember.
version [1.0.1]:
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions