feat: initial plugin

Author: aalexmmaldonado

.gitignore

@@ -7,6 +7,7 @@
 
 # npm
 node_modules
+package-lock.json
 
 # Don't include the compiled main.js file in the repo.
 # They should be uploaded to GitHub releases instead.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022, Alex Maldonado
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,73 +1,21 @@
-# Obsidian Sample Plugin
+# Obsidian BibTeX Adder
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+Add BibTeX entries from DOIs using the [Crossref REST API](https://www.crossref.org/documentation/retrieve-metadata/rest-api/).
 
-This project uses Typescript to provide type checking and documentation.
-The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does.
+## Usage
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+Ideally, this plugin should be paired with the [Citation](https://github.com/hans/obsidian-citation-plugin) plugin when an external reference manage (e.g., Mendeley, EndNote, Zotero, etc.) is not being used.
+This plugin essentially acts as a reference importer by providing an simple way to add BibTeX entries from DOIs.
 
-This sample plugin demonstrates some of the basic functionality the plugin API can do.
-- Changes the default font color to red using `styles.css`.
-- Adds a ribbon icon, which shows a Notice when clicked.
-- Adds a command "Open Sample Modal" which opens a Modal.
-- Adds a plugin setting tab to the settings page.
-- Registers a global click event and output 'click' to the console.
-- Registers a global interval which logs 'setInterval' to the console.
+- Adds a command, ``"Add BibTeX entry from DOI"``, that prompts the user for a DOI and proceeds to lookup and add the BibTeX entry.
 
-## First time developing plugins?
+## Installation
 
-Quick starting guide for new plugin devs:
+- Clone this repo (``git clone github.com/aalexmmaldonado/obsidian-bibtex-adder``).
+- `npm i` or `yarn` to install dependencies.
+- `npm run dev` to compile.
+- Copy `main.js` and `manifest.json` into your vault in `.obsidian/plugins/obsidian-bibtex-adder`.
 
-- Check if [someone already developed a plugin for what you want](https://obsidian.md/plugins)! There might be an existing plugin similar enough that you can partner up with.
-- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it).
-- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder.
-- Install NodeJS, then run `npm i` in the command line under your repo folder.
-- Run `npm run dev` to compile your plugin from `main.ts` to `main.js`.
-- Make changes to `main.ts` (or create new `.ts` files). Those changes should be automatically compiled into `main.js`.
-- Reload Obsidian to load the new version of your plugin.
-- Enable plugin in settings window.
-- For updates to the Obsidian API run `npm update` in the command line under your repo folder.
+## License
 
-## Releasing new releases
-
-- Update your `manifest.json` with your new version number, such as `1.0.1`, and the minimum Obsidian version required for your latest release.
-- Update your `versions.json` file with `"new-plugin-version": "minimum-obsidian-version"` so older versions of Obsidian can download an older version of your plugin that's compatible.
-- Create new GitHub release using your new version number as the "Tag version". Use the exact version number, don't include a prefix `v`. See here for an example: https://github.com/obsidianmd/obsidian-sample-plugin/releases
-- Upload the files `manifest.json`, `main.js`, `styles.css` as binary attachments. Note: The manifest.json file must be in two places, first the root path of your repository and also in the release.
-- Publish the release.
-
-> You can simplify the version bump process by running `npm version patch`, `npm version minor` or `npm version major` after updating `minAppVersion` manually in `manifest.json`.
-> The command will bump version in `manifest.json` and `package.json`, and add the entry for the new version to `versions.json`
-
-## Adding your plugin to the community plugin list
-
-- Check https://github.com/obsidianmd/obsidian-releases/blob/master/plugin-review.md
-- Publish an initial version.
-- Make sure you have a `README.md` file in the root of your repo.
-- Make a pull request at https://github.com/obsidianmd/obsidian-releases to add your plugin.
-
-## How to use
-
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
-
-## Manually installing the plugin
-
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
-
-## Improve code quality with eslint (optional)
-- [ESLint](https://eslint.org/) is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code. 
-- To use eslint with this project, make sure to install eslint from terminal:
-  - `npm install -g eslint`
-- To use eslint to analyze this project use this command:
-  - `eslint main.ts`
-  - eslint will then create a report with suggestions for code improvement by file and line number.
-- If your source code is in a folder, such as `src`, you can use eslint with this command to analyze all files in that folder:
-  - `eslint .\src\`
-
-
-## API Documentation
-
-See https://github.com/obsidianmd/obsidian-api
+Distributed under the MIT License. See `LICENSE` for more information.

esbuild.config.mjs

@@ -15,7 +15,7 @@ esbuild.build({
 	banner: {
 		js: banner,
 	},
-	entryPoints: ['main.ts'],
+	entryPoints: ['src/main.ts'],
 	bundle: true,
 	external: [
 		'obsidian',

main.ts

@@ -1,10 +1,10 @@
 {
-	"id": "obsidian-sample-plugin",
-	"name": "Sample Plugin",
-	"version": "1.0.1",
+	"id": "obsidian-bibtex-adder",
+	"name": "BibTeX Adder",
+	"version": "0.0.1",
 	"minAppVersion": "0.12.0",
-	"description": "This is a sample plugin for Obsidian. This plugin demonstrates some of the capabilities of the Obsidian API.",
-	"author": "Obsidian",
-	"authorUrl": "https://obsidian.md",
+	"description": "Add BibTeX entries from DOIs using the Crossref REST API.",
+	"author": "Alex Maldonado",
+	"authorUrl": "https://aalexmmaldonado.com",
 	"isDesktopOnly": false
 }

manifest.json

@@ -1,15 +1,15 @@
 {
-	"name": "obsidian-sample-plugin",
-	"version": "1.0.1",
-	"description": "This is a sample plugin for Obsidian (https://obsidian.md)",
+	"name": "obsidian-bibtex-adder",
+	"version": "0.0.1",
+	"description": "Add BibTeX entries from DOIs using the Crossref REST API.",
 	"main": "main.js",
 	"scripts": {
 		"dev": "node esbuild.config.mjs",
 		"build": "tsc -noEmit -skipLibCheck && node esbuild.config.mjs production",
 		"version": "node version-bump.mjs && git add manifest.json versions.json"
 	},
 	"keywords": [],
-	"author": "",
+	"author": "Alex Maldonado",
 	"license": "MIT",
 	"devDependencies": {
 		"@types/node": "^16.11.6",
@@ -20,5 +20,8 @@
 		"obsidian": "latest",
 		"tslib": "2.4.0",
 		"typescript": "4.7.4"
+	},
+	"dependencies": {
+		"axios": "^0.27.2"
 	}
 }

package.json

@@ -0,0 +1,44 @@
+import { Plugin } from 'obsidian';
+
+import { BibtexAdderPluginSettings, BIBTEX_ADDER_DEFAULT_SETTINGS, BibtexAdderSettingTab } from './settings';
+import { BibtexAdderModal } from './modal';
+
+
+export default class BibtexAdderPlugin extends Plugin {
+  settings: BibtexAdderPluginSettings;
+
+  async onload() {
+    await this.loadSettings();
+
+    // This creates an icon in the left ribbon.
+    if (this.settings.addRibbonAction) {
+      const ribbonIconEl = this.addRibbonIcon('paper-plane', 'Add BibTeX from DOI', (evt: MouseEvent) => {
+        // Called when the user clicks the icon.
+        new BibtexAdderModal(this.app, this.settings).open();
+      });
+    }
+
+    // for settings
+    this.addSettingTab(new BibtexAdderSettingTab(this.app, this));
+
+    // Command that creates a note from DOI information.
+    this.addCommand({
+      id: "add-bibtex-modal",
+      name: "Add BibTeX entry from DOI",
+      callback: () => {
+        new BibtexAdderModal(this.app, this.settings).open();
+      },
+    });
+  }
+
+  async loadSettings() {
+    this.settings = Object.assign(
+      {}, BIBTEX_ADDER_DEFAULT_SETTINGS, await this.loadData()
+    );
+  }
+
+  async saveSettings() {
+    await this.saveData(this.settings);
+  }
+
+}