Obsidian/file-hider
0
0
Fork 0
Code Issues Activity

Update the README to not be the template.

Browse source
This commit is contained in:
Oliver Akins 2022-05-27 00:13:38 -06:00
parent 8286693cde
commit 8df2576b25
No known key found for this signature in database
GPG key ID: 3C2014AF9457AF99
1 changed files with 24 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

89
README.md
View file

@ -1,73 +1,32 @@
# Obsidian Sample Plugin # File Hider
This is a sample plugin for Obsidian (https://obsidian.md). This is a plugin for [Obsidian](https://obsidian.md) that allows hiding specific
files and folders from the file explorer.
This project uses Typescript to provide type checking and documentation. ## How to Use
The repo depends on the latest plugin API (obsidian.d.ts) in Typescript Definition format, which contains TSDoc comments describing what it does. Right Click on any file or folder that you want to hide, and click `Hide Folder`
or `Hide File`. This will hide the file by default.
**Note:** The Obsidian API is still in early alpha and is subject to change at any time! ### Showing Hidden Files/Folders
You can toggle the visibility status of the files and folders by running the
`File Hider: Toggle Visibility` command.
This sample plugin demonstrates some of the basic functionality the plugin API can do. ### Removing File/Folder's Hidden Status
- 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.
## First time developing plugins? #### Right Click on Shown File
If you right click on a file that is set to be hidden, when it is shown in the
list, you will see an `Unhide File` option, clicking that will remove it from
the list of hidden files and keep it visible once hidden files are no longer
visible.
Quick starting guide for new plugin devs: #### File/Folder List
- Open Obsidian's settings
- 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. - Go to the `File Hider` tab
- Make a copy of this repo as a template with the "Use this template" button (login to GitHub if you don't see it). - Click on either `Manage File List` or `Manage Folder List` to open a list of all hidden files/folders.
- Clone your repo to a local development folder. For convenience, you can place this folder in your `.obsidian/plugins/your-plugin-name` folder. - Click on the `X` button of the file/folder you no longer want hidden.
- 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\`
## API Documentation ### Ribbon Icon
If you want an icon in the ribbon sidebar, I would recommend using
See https://github.com/obsidianmd/obsidian-api [Customizable Sidebar](https://github.com/phibr0/obsidian-customizable-sidebar)
and adding the `File Hider: Toggle Visibility` command.