-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
99 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,68 @@ | ||
| ClassName | ||
| ============= | ||
| # ClassName | ||
|
|
||
| [](https://travis-ci.org/litefeel/Sublime-ClassName) | ||
| [](https://ci.appveyor.com/project/litefeel/sublime-ClassName/branch/master) | ||
| [](https://coveralls.io/github/litefeel/Sublime-ClassName?branch=master) | ||
| [](https://scrutinizer-ci.com/g/litefeel/Sublime-ClassName/?branch=master) | ||
| [](https://codecov.io/gh/litefeel/Sublime-ClassName) | ||
| <a href="https://packagecontrol.io/packages/ClassName"><img src="https://packagecontrol.herokuapp.com/downloads/ClassName.svg"></a> | ||
| <a href="https://www.paypal.me/litefeel/5usd" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-blue.svg" /></a> | ||
|
|
||
| ClassName is a tiny and simple plugin for [Sublime Text](http://www.sublimetext.com) . | ||
| It copy class full name and package path to clipboard. | ||
|
|
||
| Usage | ||
| ============ | ||
| Install it using [Sublime Package Control](http://wbond.net/sublime_packages/package_control). | ||
| ### Installtion | ||
|
|
||
| 1. Install it using [Sublime Package Control](https://packagecontrol.io/installation). | ||
| 2. Run `Package Control: Install Package` command | ||
| 3. find and install ClassName plugin. | ||
|
|
||
| The default key bindings are | ||
| - [ctrl+alt+c] : copy class full name of current file to clipboard. | ||
| ### Usage | ||
|
|
||
| You can also call ClassName commands when right-clicking files in the side bar. | ||
| - Right click to copy class name and package path | ||
| - `Ctrl+Alt+C` to copy class name | ||
|
|
||
| Settings | ||
| ============== | ||
| ### Key Bindings | ||
|
|
||
| If you need you will be able to add the prefix and suffix of classname. | ||
| please modify the path by selecting | ||
| "Preferences->Package Settings->ClassName->Settings - User" in the menu. | ||
| Default Key Bindings: | ||
| ~~~json5 | ||
| [ | ||
| { "keys": ["ctrl+alt+c"], "command": "classname_copy" } | ||
| ] | ||
| ~~~ | ||
|
|
||
| The default setting is: | ||
| Change key bindings via menu: | ||
| `Preferences > Package Settings > ClassName > Key Bindings` | ||
|
|
||
| { | ||
| // set this string as prefix of class name | ||
| "classname_prefix": "", | ||
| // set this string as namespace separator | ||
| "namespace_separator": ".", | ||
| // set this string as suffix of class name | ||
| "classname_suffix": "" | ||
| } | ||
| ### Settings | ||
|
|
||
| IMPORTANT | ||
| ============== | ||
| Default Settings: | ||
|
|
||
| 1. How to find class full name. | ||
| An folder '`xxxx/src`' in sibe bar and an file '`xxxx/src/com/litefeel/MyClass.ext`', the file's class full name is '`com.litefeel.MyClass`'. | ||
| ~~~json5 | ||
| { | ||
| // set this string as prefix of class name | ||
| "classname_prefix": "", | ||
| // set this string as namespace separator | ||
| "namespace_separator": ".", | ||
| // set this string as suffix of class name | ||
| "classname_suffix": "" | ||
| } | ||
| ~~~ | ||
|
|
||
| Change setting via menu: | ||
| `Preferences > Package Settings > ClassName > Settings` | ||
|
|
||
| ### Frequently Asked Questions | ||
|
|
||
| 1. What is class full name? | ||
| If the path of a file in the sidebar is `src/com/litefeel/MyClass.lua`, | ||
| so the class full name is `com.litefeel.MyClass`. | ||
|
|
||
| 2. What is package path? | ||
| If the path of a file in the sidebar is `src/com/litefeel/MyClass.lua`, | ||
| so the package path is `com.litefeel`. | ||
|
|
||
| ### Related Links | ||
|
|
||
| homepage:<https://www.litefeel.com/sublime-classname/> | ||
| github:<https://github.com/litefeel/Sublime-ClassName/> | ||
| issues:<https://github.com/litefeel/Sublime-ClassName/issues> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,61 @@ | ||
| Sublime-ClassName | ||
| ============= | ||
| sublime-ClassName is a tiny and simple plugin for [Sublime Text](http://www.sublimetext.com) . | ||
| # ClassName | ||
|
|
||
| ClassName is a tiny and simple plugin for [Sublime Text](http://www.sublimetext.com) . | ||
| It copy class full name and package path to clipboard. | ||
|
|
||
| Usage | ||
| ============ | ||
| Install it using [Sublime Package Control](http://wbond.net/sublime_packages/package_control). | ||
| ### Installtion | ||
|
|
||
| 1. Install it using [Sublime Package Control](https://packagecontrol.io/installation). | ||
| 2. Run `Package Control: Install Package` command | ||
| 3. find and install ClassName plugin. | ||
|
|
||
| ### Usage | ||
|
|
||
| - Right click to copy class name and package path | ||
| - `Ctrl+Alt+C` to copy class name | ||
|
|
||
| ### Key Bindings | ||
|
|
||
| Default Key Bindings: | ||
| ~~~json5 | ||
| [ | ||
| { "keys": ["ctrl+alt+c"], "command": "classname_copy" } | ||
| ] | ||
| ~~~ | ||
|
|
||
| Change key bindings via menu: | ||
| `Preferences > Package Settings > ClassName > Key Bindings` | ||
|
|
||
| ### Settings | ||
|
|
||
| The default key bindings are | ||
| - [ctrl+alt+c] : copy class full name of current file to clipboard. | ||
| Default Settings: | ||
|
|
||
| You can also call ClassName commands when right-clicking files in the side bar. | ||
| ~~~json5 | ||
| { | ||
| // set this string as prefix of class name | ||
| "classname_prefix": "", | ||
| // set this string as namespace separator | ||
| "namespace_separator": ".", | ||
| // set this string as suffix of class name | ||
| "classname_suffix": "" | ||
| } | ||
| ~~~ | ||
|
|
||
| Settings | ||
| ============== | ||
| Change setting via menu: | ||
| `Preferences > Package Settings > ClassName > Settings` | ||
|
|
||
| If you need you will be able to add the prefix and suffix of classname. | ||
| please modify the path by selecting | ||
| "Preferences->Package Settings->ClassName->Settings - User" in the menu. | ||
| ### Frequently Asked Questions | ||
|
|
||
| The default setting is: | ||
| 1. What is class full name? | ||
| If the path of a file in the sidebar is `src/com/litefeel/MyClass.lua`, | ||
| so the class full name is `com.litefeel.MyClass`. | ||
|
|
||
| { | ||
| // set this string as prefix of class name | ||
| "classname_prefix": "", | ||
| // set this string as namespace separator | ||
| "namespace_separator": ".", | ||
| // set this string as suffix of class name | ||
| "classname_suffix": "" | ||
| } | ||
| 2. What is package path? | ||
| If the path of a file in the sidebar is `src/com/litefeel/MyClass.lua`, | ||
| so the package path is `com.litefeel`. | ||
|
|
||
| IMPORTANT | ||
| ============== | ||
| ### Related Links | ||
|
|
||
| 1. How to find class full name. | ||
| An folder '`xxxx/src`' in sibe bar and an file '`xxxx/src/com/litefeel/MyClass.ext`', the file's class full name is '`com.litefeel.MyClass`'. | ||
| homepage:<https://www.litefeel.com/sublime-classname/> | ||
| github:<https://github.com/litefeel/Sublime-ClassName/> | ||
| issues:<https://github.com/litefeel/Sublime-ClassName/issues> |