Initial commit

futureprogrammer360 · futureprogrammer360 · commit 89f4548869c1 · 2021-11-21T19:36:26.000-08:00
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,2 @@
+.gitattributes  export-ignore
+demo            export-ignore
diff --git a/Default (Linux).sublime-keymap b/Default (Linux).sublime-keymap
@@ -0,0 +1,6 @@
+// [
+//     {
+//         "keys": ["alt+w"],
+//         "command": "wrap"
+//     },
+// ]
diff --git a/Default (OSX).sublime-keymap b/Default (OSX).sublime-keymap
@@ -0,0 +1,6 @@
+// [
+//     {
+//         "keys": ["alt+w"],
+//         "command": "wrap"
+//     },
+// ]
diff --git a/Default (Windows).sublime-keymap b/Default (Windows).sublime-keymap
@@ -0,0 +1,6 @@
+// [
+//     {
+//         "keys": ["alt+w"],
+//         "command": "wrap"
+//     },
+// ]
diff --git a/Default.sublime-commands b/Default.sublime-commands
@@ -0,0 +1,29 @@
+[
+    {
+        "caption": "Wrap: Wrap",
+        "command": "wrap"
+    },
+    {
+        "caption": "Preferences: Wrap Key Bindings",
+        "command": "edit_settings",
+        "args": {
+          "base_file": "${packages}/Wrap/Default (${platform}).sublime-keymap",
+          "default": "[\n\t$0\n]\n"
+        }
+    },
+    {
+        "caption": "Preferences: Wrap",
+        "command": "edit_settings",
+        "args": {
+          "base_file": "${packages}/Wrap/Wrap.sublime-settings",
+          "default": "{\n\t$0\n}\n"
+        }
+    },
+    {
+        "caption": "Wrap: Open Readme",
+        "command": "open_file",
+        "args": {
+          "file": "${packages}/Wrap/README.md"
+        }
+    }
+]
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 futureprogrammer360
+
+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
@@ -0,0 +1,50 @@
+# 🤖 Wrap
+
+[Wrap](https://github.com/futureprogrammer360/Wrap) is a simple but useful [Sublime Text](https://www.sublimetext.com/) plugin that wraps the selected text (or text under cursor) with brackets (example: pass as argument into function/method, pass as index/key into array/list).
+
+## 🎬 Demonstration
+
+<img src="demo/demo.gif" alt="Wrap: Wrap" width="750"></img>
+
+## 💻 Installation
+
+The easiest way to install Wrap is through [Package Control](https://packagecontrol.io/packages/Wrap). After it is enabled inside Sublime Text, open the command palette and find **Package Control: Install Package** and press `ENTER`. Then, find **Wrap** in the list. Press `ENTER` again, and this plugin is installed!
+
+## 📈 Usage
+
+This plugin includes the command `wrap`, which can be run in the command palette as `Wrap: Wrap`.
+
+Running the `Wrap: Wrap` command, the text selected or under cursor will be wrapped by brackets (bracket type can be customized). A placeholder will be inserted before the starting bracket and become selected.
+
+Example:
+
+* Original code: `x` (`x` is selected or under cursor)
+* After `Wrap: Wrap`: `abc(x)` (`abc` selected)
+
+## ⚙ Customization
+
+The Wrap plugin can be customized to your requirements.
+
+### 🔧 Preferences
+
+The type of brackets used by `Wrap` can be customized via the command `Preferences: Wrap`.
+
+Simply change the `bracket_type` to your preference.
+
+### ⌨ Keybindings
+
+Keybindings can be created for the `wrap` command.
+
+* Run the `Preferences: Wrap Key Bindings` command in the command palette.
+* Add your keybindings!
+
+Below is an example of the keybinding file:
+
+```json
+[
+    {
+        "keys": ["alt+w"],
+        "command": "wrap"
+    }
+]
+```
diff --git a/Wrap.sublime-settings b/Wrap.sublime-settings
@@ -0,0 +1,4 @@
+{
+    // Type of brackets to use (examples: (), [], {})
+    "bracket_type": "()"
+}
diff --git a/demo/demo.gif b/demo/demo.gif
diff --git a/messages.json b/messages.json
@@ -0,0 +1,3 @@
+{
+    "install": "messages/install.txt"
+}
diff --git a/messages/install.txt b/messages/install.txt
@@ -0,0 +1,46 @@
+===================================================================
+__    __
+/ / /\ \ \_ __ __ _ _ __
+\ \/  \/ / '__/ _` | '_ \
+ \  /\  /| | | (_| | |_) |
+  \/  \/ |_|  \__,_| .__/
+                   |_|
+
+===================================================================
+
+Hey there!
+
+Thank you for installing Wrap, a simple but powerful tool that will help you write programs faster.
+
+-------------------------------------------------------------------
+
+How to use Wrap to code faster:
+
+Running the `Wrap: Wrap` command, the text selected or under cursor will be wrapped by brackets (customizable), and a placeholder will be placed before the starting bracket and be selected.
+
+Example:
+- Original code: x (x selected or under cursor)
+- After `Wrap: Wrap`: abc(x) (abc selected)
+
+-------------------------------------------------------------------
+
+How to customize Wrap:
+
+To change the type of brackets used by Wrap, run the `Preferences: Wrap` command in the command palette.
+
+To add and customize keybindings, run the `Preferences: Wrap Key Bindings` command in the command palette.
+Below is an example keybinding file:
+****************************************************
+[
+    {
+        "keys": ["alt+w"],
+        "command": "wrap"
+    },
+]
+****************************************************
+
+-------------------------------------------------------------------
+
+To learn more about this plugin, check out the README.md file via the `Wrap: Open Readme` command in command palette.
+
+GitHub homepage: https://github.com/futureprogrammer360/Wrap
diff --git a/wrap.py b/wrap.py
@@ -0,0 +1,25 @@
+import sublime
+import sublime_plugin
+
+
+class WrapCommand(sublime_plugin.TextCommand):
+    def run(self, edit):
+        settings = sublime.load_settings("Wrap.sublime-settings")
+        a, b = settings.get("bracket_type", "()")
+
+        region = self.view.sel()[0]
+
+        # Cursor on empty line
+        if self.view.substr(self.view.word(region)).strip() == "":
+            self.view.run_command("insert_snippet", {"contents": "${1:abc}" + a + "$0" + b})
+            return
+
+        # No selection
+        if region.empty():
+            # Do nothing if selection has no alphanumeric character
+            if not any(char.isalnum() for char in self.view.substr(self.view.word(region))):
+                return
+            self.view.run_command("find_under_expand")  # Select text under cursor
+
+        # Wrap selection with parentheses
+        self.view.run_command("insert_snippet", {"contents": "${1:abc}" + a + "${0:$SELECTION}" + b})

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+.gitattributes export-ignore`
	`2`	`+demo export-ignore`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,6 @@ @@
 +// [
 +//     {
 +//         "keys": ["alt+w"],
 +//         "command": "wrap"
 +//     },
 +// ]
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "install": "messages/install.txt"`
	`3`	`+}`