/obsidian-screwdriver

Primary LanguageTypeScriptMIT LicenseMIT

Screwdriver

The plugin for picking and putting hidden files.

screenshot

You can dump your files which are stored in the specified directory, or put dumped files into any path under your vault.

Note: Since v0.0.7, We can use properties to control this plug-in! screenshot2

How to use

Install

You can install Screwdriver ...

  • From Community Plugins
  • Via BRAT.

Prepare a command file

The command file is the file which has some directions on the frontmatter; like the following.

targets:
  - .obsidian/plugins/tagfolder
urls: []
ignores:
  - /node_modules
  - /.git
filters:
  - main\.js$
  - manifest\.json$
  - styles\.css$
comment: "'Add target directory' to add targets"
tags: []

However, we do not have to worry so much. We can make this file by Ctrl+P -> Screwdriver: Create or add local file exporting template.

Then, all we have to do is simply pick the target directory, by Ctrl+P -> Screwdriver: Add target directory.
When we choose the Plug-in or Theme, filters will be supplied automatically.

If you want to control more detail, please change the filters and ignores.

  • Ignores: files beginning with the letter set here will be omitted while dumping.
  • Filters: only the files that match with the expression set here will be dumped.

If you want to export multiple things at once, please repeat the Add target directory

Tip

If we want to fetch the file on the Internet, we can use Create or add remote file fetching template. Using this template, we can retrieve the files from the internet. It may be useful for fetching CSS Snippets from Gist.

Export files

Ctrl+P -> Export specified files and store into the active file to export files into the activefile.

---
targets:
  - .obsidian/plugins/tagfolder
urls: []
ignores:
  - /node_modules
  - /.git
filters:
  - main\.js$
  - manifest\.json$
  - styles\.css$
comment: "'Add target directory' to add targets"
tags: []
---
# .obsidian/plugins/tagfolder/main.js 
- Created :2023/7/12 9:28:27 
- Modified:2023/8/25 17:52:29 

```screwdriver:.obsidian/plugins/tagfolder/main.js:plain
/*
THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
if you want to view the source, please visit the github repository of this plugin
*/

Tip

Exported files can be modified by editing the doc.

Restore

Ctrl+P -> Restore exported files from the active file to restore files into your storage.

Important

The files are written as the filename following ``` or ```screwdriver:

If you're using Self-hosted LiveSync or remotely-save, it could be useful to synchronize your configuration between devices.