replacing entire plugin with obsidian-dictionary making it a new starting point.

Author: arpitbbhayani

LICENSE

@@ -1,57 +1,89 @@
-## Obsidian Sample Plugin
+<img align="right" width="550" src="https://media.discordapp.net/attachments/796853434397360128/847198380878069771/Screen_Shot_2021-05-26_at_12.43.43_PM.png?width=736&height=676">
 
-This is a sample plugin for Obsidian (https://obsidian.md).
+# Obsidian Dictionary Plugin [![GitHub tag (Latest by date)](https://img.shields.io/github/v/tag/phibr0/obsidian-dictionary)](https://github.com/phibr0/obsidian-dictionary/releases) ![GitHub all releases](https://img.shields.io/github/downloads/phibr0/obsidian-dictionary/total)
 
-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.
+This Plugin adds a Dictionary to the [Obsidian](https://obsidian.md) Note-Taking tool.
 
-**Note:** The Obsidian API is still in early alpha and is subject to change at any time!
+## Usage
 
-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.
+Open the *Command Palette* (default: `ctrl` + `p`), search for *Open Dictionary View* and run the command. You will see that a new View appears in the right Sidebar of Obsidian. You can set your default Language in Obsidian's Settings under *Plugin Options* > *Obsidian Dictionary* > *Default Language*.
 
-### First time developing plugins?
+## Supported Languages
 
-Quick starting guide for new plugin devs:
+The following Languages are currently supported:
 
-- 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.
+| Language             | Synonym Popover | Sidebar Lookup (Offline Support) | UI Translated? |
+|:-------------------- |:---------------:|:--------------:|:-----------:|
+| English (US)         |        🗸        |       🗸  (🗸)       |🗸|
+| English (UK)         |                 |       🗸 (🗸)       ||
+| Hindi                |                 |       🗸        ||
+| Spanish              |        🗸        |       🗸        ||
+| French               |        🗸        |       🗸        ||
+| Japanese             |                 |       🗸        ||
+| Russian              |                 |       🗸        ||
+| German               |        🗸        |       🗸        |🗸|
+| Italian              |        🗸        |       🗸        ||
+| Korean               |                 |       🗸        ||
+| Brazilian Portuguese |                 |       🗸        ||
+| Arabic               |                 |       🗸        ||
+| Turkish              |                 |       🗸        | |
+| Chinese | | 🗸 (🗸) | 🗸 |
 
-### Releasing new releases
+## Offline Dictionary
 
-- 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.
-- Publish the release.
+As of Release 2.13.0 this Plugin has experimental offline Support for English and Chinese. The offline Dictionary is pretty big (about 35 megabytes), which is why it's not bundled with this Plugin by default. It will download the neccessary files **when you are using it for the first time**. That means your first look-up still requires an internet connection.
 
-### Adding your plugin to the community plugin list
+## Privacy
 
-- 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.
+This Plugin relies on third-party [API's](https://en.wikipedia.org/wiki/API) to find Definitions, Synonyms, etc. You can select from a Range of API’s and choose which one to trust, the Plugin will not make requests to API’s you didn’t allow it to. To find more Information about the different API’s click the “More Info“ Button in the Settings.
 
-### How to use
+If you explicitly activate the **Advanced Synonym Search**, there will be one additional API Call to analyze the *whole* Sentence the selected Word appears in. This will make the suggested Synonyms more accurate based on the context.
 
-- Clone this repo.
-- `npm i` or `yarn` to install dependencies
-- `npm run dev` to start compilation in watch mode.
+Even though this Plugin is fully Open-Source and thus can be looked over by anyone, the third-party API’s might not be.
 
-### Manually installing the plugin
+## How to make this Plugin better
 
-- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/your-plugin-id/`.
+### Translations
 
-### API Documentation
+If you want to help and translate this Plugin to new languages, see [locales](https://github.com/phibr0/obsidian-dictionary/tree/master/src/l10n/locale).
 
-See https://github.com/obsidianmd/obsidian-api
+### New API's
+
+This Plugin is meant to be easily extensible! If you want to add a new API for a new (or already supported) Language see: [API Manager](src/apiManager.ts).
+
+You will need to create a new class for the new API, which implements [DefinitionProvider](src/api/types.ts) or [SynonymProvider](src/api/types.ts) (or both).
+
+If the Language you are working with doesn't exist yet, add it to the `LANGUAGES` in [_constants.ts](src/_constants.ts).
+
+After that, add the API to the respective List in the [API Manager](src/apiManager.ts) and finally open a Pull Request here on GitHub.
+This will automatically make it selectable in the Settings.
+
+> Special Thanks to [@mgmeyers](https://github.com/mgmeyers) for already making this Plugin a lot better!
+
+## Variables
+
+You can edit the Note Template for your local Dictionary in the Settings. Here is a List of Variables you can use:
+
+- `{{notice}}` → "Autogenerated by Obsidian Dictionary" (Localized)
+- `{{word}}` → The Word the File is created for
+- `{{pronunciationHeader}}` → "Pronunciations" (Localized)
+- `{{meaningHeader}}` → Same as above, but for "Meanings" (Localized)
+- `{{phoneticList}}` → A List of all phonetics the Plugin found.
+- `{{meanings}}` → Same as above, but for meanings the Plugin found.
+
+Localized means, that the Text changes based on Obsidians internal Language.
+
+## How to install
+
+1. Go to **Community Plugins** in your [Obsidian](https://www.obsidian.md) Settings and **disable** Safe Mode
+2. Click on **Browse** and search for “Obsidian Dictionary”
+3. Click install
+4. Toggle the Plugin on in the **Community Plugins** Tab
+
+## Support me
+
+If you find this Plugin helpful, consider supporting me:
+
+<a href="https://www.buymeacoffee.com/phibr0"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=phibr0&button_colour=5F7FFF&font_colour=ffffff&font_family=Inter&outline_colour=000000&coffee_colour=FFDD00"></a>
+
+> This Plugin relies on the [Free Dictionary API](https://dictionaryapi.dev/) by [meetDeveloper](https://github.com/meetDeveloper). He is providing this API to the public for free and needs help from the community. [**More Information**](https://github.com/meetDeveloper/freeDictionaryAPI#important-note)

README.md

@@ -14,10 +14,29 @@
     "@rollup/plugin-commonjs": "^18.0.0",
     "@rollup/plugin-node-resolve": "^11.2.1",
     "@rollup/plugin-typescript": "^8.2.1",
+    "@tsconfig/svelte": "^1.0.13",
     "@types/node": "^14.14.37",
-    "obsidian": "^0.12.0",
+    "@typescript-eslint/eslint-plugin": "^4.25.0",
+    "@typescript-eslint/parser": "^4.25.0",
+    "eslint": "^7.27.0",
     "rollup": "^2.32.1",
+    "rollup-plugin-svelte": "^7.1.0",
+    "sass": "^1.34.0",
+    "scss": "^0.2.4",
+    "svelte": "^3.40.3",
+    "svelte-check": "^1.4.0",
+    "svelte-preprocess": "^4.7.0",
     "tslib": "^2.2.0",
-    "typescript": "^4.2.4"
+    "typescript": "^4.3.2",
+    "typescript-eslint": "^0.0.1-alpha.0"
+  },
+  "moduleFileExtensions": [
+    "js",
+    "ts",
+    "svelte"
+  ],
+  "dependencies": {
+    "match-casing": "^2.0.0",
+    "obsidian": "^0.12.5"
   }
 }

dictionary.json

@@ -1,30 +1,38 @@
-import typescript from '@rollup/plugin-typescript';
-import {nodeResolve} from '@rollup/plugin-node-resolve';
-import commonjs from '@rollup/plugin-commonjs';
+import svelte from "rollup-plugin-svelte";
+import commonjs from "@rollup/plugin-commonjs";
+import resolve from "@rollup/plugin-node-resolve";
+import autoPreprocess from "svelte-preprocess";
+import typescript from "@rollup/plugin-typescript";
 
+// eslint-disable-next-line no-undef
 const isProd = (process.env.BUILD === 'production');
 
 const banner = 
 `/*
 THIS IS A GENERATED/BUNDLED FILE BY ROLLUP
-if you want to view the source visit the plugins github repository
+if you want to view the source visit the plugins github repository (https://github.com/phibr0/obsidian-dictionary)
 */
 `;
 
 export default {
-  input: 'main.ts',
-  output: {
-    dir: '.',
-    sourcemap: 'inline',
-    sourcemapExcludeSources: isProd,
-    format: 'cjs',
-    exports: 'default',
-    banner,
-  },
-  external: ['obsidian'],
-  plugins: [
-    typescript(),
-    nodeResolve({browser: true}),
-    commonjs(),
-  ]
+    input: "src/main.ts",
+    output: {
+        dir: '.',
+        sourcemap: isProd ? 'none' : 'inline',
+        format: 'cjs',
+        exports: 'default',
+        banner,
+    },
+    external: ["obsidian"],
+    plugins: [
+        svelte({
+            emitCss: false,
+            preprocess: autoPreprocess(),
+        }),
+        typescript(),
+        resolve({
+            browser: true,
+        }),
+        commonjs(),
+    ],
 };

package.json

@@ -0,0 +1,78 @@
+import type { DictionaryCache, DictionarySettings } from "src/types";
+import t from 'src/l10n/helpers';
+
+export const VIEW_TYPE = 'dictionary-view';
+export const VIEW_DISPLAY_TEXT = t('Dictionary');
+export const VIEW_ICON = 'quote-glyph';
+
+export const LANGUAGES = {
+    "en_US": "English (US)",
+    "hi": "हिन्दी (Hindi)",
+    "es": "Español (Spanish)",
+    "fr": "Français (French)",
+    "ja": "日本語 (Japanese)",
+    "ru": "Русский (Russian)",
+    "en_GB": "English (UK)",
+    "de": "Deutsch (German)",
+    "it": "Italiano (Italian)",
+    "ko": "한국어 (Korean)",
+    "pt_BR": "Português do Brasil (Brazilian Portuguese)",
+    "ar": "اَلْعَرَبِيَّةُ‎ (Arabic)",
+    "tr": "Türkçe (Turkish)",
+    "cn": "中国人 (Chinese)"
+}
+
+export const RFC = {
+    "en_US": "en-US",
+    "hi": "hi",
+    "es": "es",
+    "fr": "fr",
+    "ja": "ja",
+    "ru": "ru",
+    "en_GB": "en-GB",
+    "de": "de",
+    "it": "it",
+    "ko": "ko",
+    "pt_BR": "pt-BR",
+    "ar": "ar",
+    "tr": "tr",
+    "cn": "zh"
+}
+
+
+export const DEFAULT_CACHE: DictionaryCache = {
+    cachedDefinitions: [],
+    cachedSynonyms: [],
+}
+
+export const DEFAULT_SETTINGS: DictionarySettings = {
+    defaultLanguage: "en_US",
+    shouldShowSynonymPopover: true,
+    shouldShowCustomContextMenu: false,
+    definitionApiName: "Free Dictionary API",
+    synonymApiName: "Free Dictionary API",
+    partOfSpeechApiName: "Systran API",
+    advancedSynonymAnalysis: false,
+    useCaching: false,
+    folder: '',
+    capitalizedFileName: true,
+    prefix: "",
+    suffix: " ({{lang}})",
+    template: `---
+# {{notice}}
+aliases: ["{{word}}"]
+---
+
+# {{word}}
+
+## {{pronunciationHeader}}
+
+{{phoneticList}}
+
+## {{meaningHeader}}
+
+{{meanings}}
+`,
+    languageSpecificSubFolders: false
+}
+