From 3dfaf7ef3da66b6ec38e315115bac4ac441506bc Mon Sep 17 00:00:00 2001 From: Oleg Date: Sat, 27 Aug 2022 13:58:19 +0300 Subject: [PATCH] update readme --- README.md | 79 ++++++++--------------------------------------- main.ts | 2 ++ package-lock.json | 4 +-- 3 files changed, 17 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index b8f865d..46e0fe0 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,20 @@ -# Obsidian Sample Plugin - -This is a sample plugin for Obsidian (https://obsidian.md). - -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. +# Obsidian Bulk Rename Plugin **Note:** The Obsidian API is still in early alpha and is subject to change at any time! -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. +# Introduction -## First time developing plugins? - -Quick starting guide for new plugin devs: - -- 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. - -## 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\` +This plugin was developed to cover my initial needs and rename a bunch of files +and update their reference in code base respectively. +So now you can rename a bunch of files from the directory +and all imports also will be updated in a code-base -## API Documentation +# How to use? + +- **folder location** - Files from which folder you need to rename +- **Symbols in existing files** - the symbols/characters that we have in the files in that particular directory +- **Replacement Symbols** - a new symbols that will be pasted instead +- **Files within the folder** - this is for information purpose + -See https://github.com/obsidianmd/obsidian-api diff --git a/main.ts b/main.ts index fca68d8..b6b87c3 100644 --- a/main.ts +++ b/main.ts @@ -130,6 +130,7 @@ class BulkRenameSettingsTab extends PluginSettingTab { .setName('Files within the folder') .setDesc(`Total Files: ${this.plugin.settings.fileNames.length}`) .addTextArea((text) => { + text.setPlaceholder('Here you will see files under folder location'); existingFilesTextArea = text.inputEl; const value = getRenderedFileNames(this.plugin); text.setValue(value); @@ -139,6 +140,7 @@ class BulkRenameSettingsTab extends PluginSettingTab { text.inputEl.addClass('templater_cmd'); }) .addTextArea((text) => { + text.setPlaceholder('How filenames will looks like after replacement(click preview first)'); replacedPreviewTextArea = text.inputEl; const value = getRenderedFileNamesReplaced(this.plugin); text.setValue(value); diff --git a/package-lock.json b/package-lock.json index f8408a1..2ca7f8d 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "obsidian-bulk-rename", - "version": "1.0.0", + "version": "0.0.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "obsidian-bulk-rename", - "version": "1.0.0", + "version": "0.0.1", "license": "MIT", "dependencies": { "@popperjs/core": "^2.11.2"