Complying with Plugin Review Guidelines

This commit is contained in:
Daniel Stirba 2023-02-18 13:55:35 +11:00
parent 81faf97f8a
commit 7ca735748d
7 changed files with 16 additions and 16 deletions

View file

@ -14,7 +14,7 @@ import { dwarfFamilyNames } from "lists/dwarvenFamilyNames";
import * as FCG from "fantasy-content-generator"; import * as FCG from "fantasy-content-generator";
import { generateCityName } from "generators/city"; import { generateCityName } from "generators/city";
import { generateLoot } from "generators/loot"; import { generateLoot } from "generators/loot";
import MyPlugin from "main"; import FantasyPlugin from "main";
import { generateInn } from "generators/inn"; import { generateInn } from "generators/inn";
import { generatePathfinderName } from "generators/Pathfinder/pathfinderName"; import { generatePathfinderName } from "generators/Pathfinder/pathfinderName";
import { ISettlementDomainObject } from "fantasy-content-generator/dist/interfaces"; import { ISettlementDomainObject } from "fantasy-content-generator/dist/interfaces";
@ -36,8 +36,8 @@ let genSettings = {
export class GeneratorModal extends Modal { export class GeneratorModal extends Modal {
result: string | Error; result: string | Error;
onSubmit: (result: string | Error) => void; onSubmit: (result: string | Error) => void;
plugin: MyPlugin; plugin: FantasyPlugin;
constructor(app: App, onSubmit: (result: string | Error) => void, plugin: MyPlugin) { constructor(app: App, onSubmit: (result: string | Error) => void, plugin: FantasyPlugin) {
super(app); super(app);
this.onSubmit = onSubmit; this.onSubmit = onSubmit;
this.plugin = plugin; this.plugin = plugin;

View file

@ -7,7 +7,7 @@ import { elfFamilyNames } from "lists/elvenFamilyNames";
import { familyNameList } from "lists/humanFamilyNames"; import { familyNameList } from "lists/humanFamilyNames";
import { titleLastNames } from "lists/titleLastNames"; import { titleLastNames } from "lists/titleLastNames";
import * as FCG from "fantasy-content-generator"; import * as FCG from "fantasy-content-generator";
import MyPlugin from "main"; import FantasyPlugin from "main";
import { Editor, EditorPosition, EditorSuggest, EditorSuggestContext, EditorSuggestTriggerInfo, MarkdownView } from "obsidian"; import { Editor, EditorPosition, EditorSuggest, EditorSuggestContext, EditorSuggestTriggerInfo, MarkdownView } from "obsidian";
import { generatorAirships } from "generators/airship"; import { generatorAirships } from "generators/airship";
import { generatorDrinks } from "generators/drink"; import { generatorDrinks } from "generators/drink";
@ -34,7 +34,7 @@ export class InlineGeneratorSuggester extends EditorSuggest<string> {
private getCompletions: () => string[]; // function to retrieve completions private getCompletions: () => string[]; // function to retrieve completions
startChar: EditorPosition startChar: EditorPosition
endChar: EditorPosition endChar: EditorPosition
plugin: MyPlugin plugin: FantasyPlugin
//An object storing all the Generator functions used by the particular selection //An object storing all the Generator functions used by the particular selection
private generators: Generators = { private generators: Generators = {
@ -155,7 +155,7 @@ export class InlineGeneratorSuggester extends EditorSuggest<string> {
"Gen-PlotStoryHooks": () => generatePlotHook(), "Gen-PlotStoryHooks": () => generatePlotHook(),
} }
constructor(getCompletions: () => string[], plugin: MyPlugin) { constructor(getCompletions: () => string[], plugin: FantasyPlugin) {
super(app); super(app);
this.getCompletions = getCompletions; this.getCompletions = getCompletions;
this.plugin = plugin; this.plugin = plugin;

View file

@ -1,12 +1,12 @@
import { GeneratorModal } from 'editor/GeneratorModal'; import { GeneratorModal } from 'editor/GeneratorModal';
import { MarkdownView, Notice, Plugin } from 'obsidian'; import { MarkdownView, Notice, Plugin } from 'obsidian';
import { InlineGeneratorSuggester } from "editor/InlineGenerator"; import { InlineGeneratorSuggester } from "editor/InlineGenerator";
import { MyPluginSettings, possibleOptions } from 'settings/Datatypes'; import { FantasyPluginSettings, possibleOptions } from 'settings/Datatypes';
import { DEFAULT_SETTINGS } from 'settings/DefaultSetting'; import { DEFAULT_SETTINGS } from 'settings/DefaultSetting';
import { SettingTab } from 'settings/SettingsTab'; import { SettingTab } from 'settings/SettingsTab';
export default class MyPlugin extends Plugin { export default class FantasyPlugin extends Plugin {
settings: MyPluginSettings; settings: FantasyPluginSettings;
//Function used to return the array of options for the suggester. //Function used to return the array of options for the suggester.
getOptionsForSuggest(): string[] { getOptionsForSuggest(): string[] {

View file

@ -3,7 +3,7 @@
"name": "Fantasy Content Generator", "name": "Fantasy Content Generator",
"version": "1.2.0", "version": "1.2.0",
"minAppVersion": "0.15.0", "minAppVersion": "0.15.0",
"description": "A Fantasy Content Generator for Obsidian", "description": "A Fantasy Content Generator for Obsidian for All Your TTRPG / World Building Needs",
"author": "Obsidian", "author": "Obsidian",
"authorUrl": "https://obsidian.md", "authorUrl": "https://obsidian.md",
"fundingUrl": "https://obsidian.md/pricing", "fundingUrl": "https://obsidian.md/pricing",

View file

@ -162,7 +162,7 @@ export type innGeneratorSettings = {
} }
// the interface that uses all // the interface that uses all
export interface MyPluginSettings { export interface FantasyPluginSettings {
enableCurrency: boolean; enableCurrency: boolean;
citySettings: cityGeneratorSetting; citySettings: cityGeneratorSetting;
currencyTypes: currency[]; currencyTypes: currency[];

View file

@ -1,7 +1,7 @@
import { MyPluginSettings } from "./Datatypes"; import { FantasyPluginSettings } from "./Datatypes";
//The Default Settings for the Plugin. //The Default Settings for the Plugin.
export const DEFAULT_SETTINGS: MyPluginSettings = { export const DEFAULT_SETTINGS: FantasyPluginSettings = {
enableCurrency: false, enableCurrency: false,
citySettings: { citySettings: {
prefixArray: ["camp", "castle", "east", "edge", "ever", "great", "mount", "new", "north", "red", "rose", "south", "west"], prefixArray: ["camp", "castle", "east", "edge", "ever", "great", "mount", "new", "north", "red", "rose", "south", "west"],

View file

@ -1,11 +1,11 @@
import MyPlugin from "main"; import FantasyPlugin from "main";
import { PluginSettingTab, App, Setting } from "obsidian"; import { PluginSettingTab, App, Setting } from "obsidian";
import { DEFAULT_SETTINGS } from "./DefaultSetting"; import { DEFAULT_SETTINGS } from "./DefaultSetting";
export class SettingTab extends PluginSettingTab { export class SettingTab extends PluginSettingTab {
plugin: MyPlugin; plugin: FantasyPlugin;
constructor(app: App, plugin: MyPlugin) { constructor(app: App, plugin: FantasyPlugin) {
super(app, plugin); super(app, plugin);
this.plugin = plugin; this.plugin = plugin;
} }