aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 1357c9b13f1f74f3506fa42ece8e81b4bf2adb63 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
Case Conversion
===============

A plugin for JetBrain IDEs to convert between cases.

The plugin provides actions to convert to these cases:

- `snake_case`
- `dash-case`
- `camelCase`
- `PascalCase`
- `SCREAMING_SNAKE_CASE`
- `UPPER CASE`
- `lower case`
- `fLIP cASE`
- `Title Case`
- `Sentence case`
- `dot.case`

The Plugin was inspired by the [Case Conversion Plugin for SublimeText](https://packagecontrol.io/packages/Case%20Conversion).

How to use
----------

Select the text you want to convert and then invoke the desired action.
There are multiple ways to do this:

- Use the menu bar: The actions of this plugin can be found in
  "Edit" > "Convert Case"
- Use the Find Action feature: Bring up the "Find Action" search dialog
  (default keyboard shortcut is Ctrl+Shift+A) and type the name of the
  desired convert action (or type "Convert Case" to see all actions).
  Tip: This search uses fuzzy matching so you can just type "camcas" for
  "Convert Case: camelCase".
- Create a keyboard shortcut: Open Settings > Keymap and search for
  "Convert Case" and create a keyboard shortcut for the desired action.

Configuration
-------------

The plugin has a configuration page in the "Settings" window of the IDE.
You can find it under Tools > Case conversion.

Currently there is only one configuration option:

- **Treat newline as**: Can be either "White space" in which case selected
  line breaks will be treated like every other white space (i.e. as a word
  separator), or it can be "Record separator" in which case each line will
  be converted individually. The default is "White space".

Contributing
------------

You can send patches, bugreports or feature-requests to laria-code at laria dot me. You can also go to the mirrored GitHub repo (<https://github.com/silvasur/idea_caseconv>) and create a pull request.