micro-editor · jakkunight · Dec 12, 2016 · Dec 12, 2016 · Dec 12, 2016 · Dec 12, 2016
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,17 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Ignore .md files, because 2 spaces at end-of-line has meaning
+[*.md]
+trim_trailing_whitespace = false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,109 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.4.0] - 2018-10-22
+
+### Fixed
+
+- Issues with Lua's `io.popen` on some systems by using Micro's built-in `RunShellCommand` instead, [thanks to @scottbilas](https://github.com/NicolaiSoeborg/filemanager-plugin/pull/38)
+
+### Added
+
+- Adds the option `filemanager-openonstart` to allow auto-opening the file tree when Micro is started (default OFF)
+
+### Changed
+
+- Update README's option's documentation
+
+## [3.3.1] - 2018-10-03
+
+### Changed
+
+- Performance improvement by removing unnecessary refresh of the opened file, [thanks to @jackwilsdon](https://github.com/NicolaiSoeborg/filemanager-plugin/pull/37)
+
+## [3.3.0] - 2018-09-13
+
+### Added
+
+- The ability to sort folders above files, [thanks to @cbrown1](https://github.com/NicolaiSoeborg/filemanager-plugin/pull/33)
+
+### Fixed
+
+- The displayed filenames are now correctly only showing their "basename" on Windows
+
+## [3.2.0] - 2018-02-15
+
+### Added
+
+- The ability to go to parent directory with left arrow (when not minimizing). Thanks @avently
+- The ability to jump to the `..` as a "parent directory". Thanks @avently
+
+## [3.1.2] - 2018-02-07
+
+### Fixed
+
+- The minimum Micro version, which was incorrectly set to v1.4.0. Ref [issue #28](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/28)
+
+## [3.1.1] - 2018-02-04
+
+### Fixed
+
+Ref https://github.com/zyedidia/micro/issues/992 for both of these fixes.
+
+- The syntax parser not loading correctly (mostly block comments) on opened files. **Requires Micro >= v1.4.0**
+- An errant tab being inserted into the newly opened file.
+
+## [3.1.0] - 2018-01-30
+
+### Added
+
+- The ability to hide dotfiles using the `filemanager-showdotfiles` option.
+- The ability to hide files ignored in your VCS (aka `.gitignore`'d) using the `filemanager-showignored` option. Only works with Git at the moment.
+- This `CHANGELOG.md`
+
+### Fixed
+
+- A bug with the `rm` command that caused weird, undefined behaviour to contents within the same dir as the file/dir deleted.
+- Issue [#24](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/24)
+
+## [3.0.0] - 2018-01-10
+
+### Fixed
+
+- Issues [#13](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/13), [#14](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/14), [#15](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/15), [#19](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/19), [#20](https://github.com/NicolaiSoeborg/filemanager-plugin/issues/20)
+- The broken syntax highlighting
+
+### Added
+
+- Directory expansion/compression below itself for viewing more akin to a file tree.
+- The `rm` command, which deletes the file/directory under the cursor.
+- The `touch` command, which creates a file with the passed filename.
+- The `mkdir` command, which creates a directory with the passed filename.
+- An API, of sorts, for the user to rebind their keys to if they dislike the defaults.
+- An [editorconfig](http://editorconfig.org/) file.
+
+### Changed
+
+- The view that it spawns in to read-only, which requires Micro version >= 1.3.5
+- The functionality of some keybindings (when in the view) so they work safetly, or at all, with the plugin.
+- From the `enter` key to `tab` for opening/going into files/dirs (a side-effect of using the read-only setting)
+
+### Removed
+
+- The ability to use a lot of keybindings that would otherwise mess with the view, and have no benifit.
+- The pointless `.gitignore` file.
+
+[unreleased]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.4.0...HEAD
+[3.4.0]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.3.1...v3.4.0
+[3.3.1]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.3.0...v3.3.1
+[3.3.0]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.2.0...v3.3.0
+[3.2.0]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.1.2...v3.2.0
+[3.1.2]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.1.1...v3.1.2
+[3.1.1]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.1.0...v3.1.1
+[3.1.0]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v3.0.0...v3.1.0
+[3.0.0]: https://github.com/NicolaiSoeborg/filemanager-plugin/compare/v2.1.1...v3.0.0
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nicolai Søborg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,3 +1,56 @@
-# Filetree Plugin
+# Filemanager Plugin
 
-This is still a work in progress...
+A simple plugin that allows for easy navigation of a file tree.
+
+![Example picture](./example.jpg?raw=true "Example")
+
+**Installation:** run `plugin install filemanager` and restart Micro.
+
+## Basics
+
+The top line always has the current directory's path to show you where you are.\
+The `..` near the top is used to move back a directory, from your current position.
+
+All directories have a `/` added to the end of it, and are syntax-highlighted as a `special` character.\
+If the directory is expanded, there will be a `+` to the left of it. If it is collapsed there will be a `-` instead.
+
+**NOTE:** If you change files without using the plugin, it can't know what you did. The only fix is to close and open the tree.
+
+### Options
+
+| Option                       | Purpose                                                      | Default |
+| :--------------------------- | :----------------------------------------------------------- | :------ |
+| `filemanager-showdotfiles`   | Show dotfiles (hidden if false)                              | `true`  |
+| `filemanager-showignored`    | Show gitignore'd files (hidden if false)                     | `true`  |
+| `filemanager-compressparent` | Collapse the parent dir when left is pressed on a child file | `true`  |
+| `filemanager-foldersfirst`   | Sorts folders above any files                                | `true`  |
+| `filemanager-openonstart`    | Automatically open the file tree when starting Micro         | `false` |
+
+### Commands and Keybindings
+
+The keybindings below are the equivalent to Micro's defaults, and not actually set by the plugin. If you've changed any of those keybindings, then that key is used instead.
+
+If you want to [keybind](https://github.com/zyedidia/micro/blob/master/runtime/help/keybindings.md#rebinding-keys) any of the operations/commands, bind to the labeled API in the table below.
+
+| Command  | Keybinding(s)              | What it does                                                                                | API for `bindings.json`               |
+| :------- | :------------------------- | :------------------------------------------------------------------------------------------ | :------------------------------------ |
+| `tree`   | -                          | Open/close the tree                                                                         | `filemanager.toggle_tree`             |
+| -        | <kbd>Tab</kbd> & MouseLeft | Open a file, or go into the directory. Goes back a dir if on `..`                           | `filemanager.try_open_at_cursor`      |
+| -        | <kbd>→</kbd>               | Expand directory in tree listing                                                            | `filemanager.uncompress_at_cursor`    |
+| -        | <kbd>←</kbd>               | Collapse directory listing                                                                  | `filemanager.compress_at_cursor`      |
+| -        | <kbd>Shift ⬆</kbd>         | Go to the target's parent directory                                                         | `filemanager.goto_parent_dir`         |
+| -        | <kbd>Alt Shift {</kbd>     | Jump to the previous directory in the view                                                  | `filemanager.goto_next_dir`           |
+| -        | <kbd>Alt Shift }</kbd>     | Jump to the next directory in the view                                                      | `filemanager.goto_prev_dir`           |
+| `rm`     | -                          | Prompt to delete the target file/directory your cursor is on                                | `filemanager.prompt_delete_at_cursor` |
+| `rename` | -                          | Rename the file/directory your cursor is on, using the passed name                          | `filemanager.rename_at_cursor`        |
+| `touch`  | -                          | Make a new file under/into the file/directory your cursor is on, using the passed name      | `filemanager.new_file`                |
+| `mkdir`  | -                          | Make a new directory under/into the file/directory your cursor is on, using the passed name | `filemanager.new_dir`                 |
+
+#### Notes
+
+- `rename`, `touch`, and `mkdir` require a name to be passed when calling.\
+  Example: `rename newnamehere`, `touch filenamehere`, `mkdir dirnamehere`.\
+  If the passed name already exists in the current dir, it will cancel instead of overwriting (for safety).
+
+- The <kbd>Ctrl w</kbd> keybinding is to switch which buffer your cursor is on.\
+  This isn't specific to the plugin, it's just part of Micro, but many people seem to not know this.
diff --git a/example.jpg b/example.jpg