Skip to content

Commit e925ca0

Browse files
committed
chore: run prettier
1 parent 284d1a3 commit e925ca0

24 files changed

+615
-473
lines changed

Diff for: Articles.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!-- prettier-ignore-start -->
12
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
23
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
4+
<!-- prettier-ignore-end -->
35
46
Here are a collection of blog posts and articles that mention Oh My Zsh.
57

Diff for: Cheatsheet.md

+30-28
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1+
<!-- prettier-ignore-start -->
12
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
23
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
34
45
> **If you're coming from the Internet, this section has been edited to only show main**
56
> **Oh My Zsh tricks. Documentation for each plugin can be found in each [[Plugins]] README.**
7+
<!-- prettier-ignore-end -->
68
79
Quick reference:
810

@@ -14,34 +16,34 @@ Quick reference:
1416

1517
## Commands
1618

17-
| Command | Description |
18-
| :-------------- | :----------------------------------------------------------------------------------------- |
19-
| `alias` | List all aliases |
20-
| `mkcd` | Create a new directory and change to it, will create intermediate directories as required. |
21-
| `take` | Like `mkcd`, but also knows how to handle remote URLs. When given an argument that looks like a URL (something that ends in `.git` or `.tar.(gz\|bz2\|xz)`), download the remote resource and extract it (if necessary) into the current directory. Then change to the newly extracted/downloaded/cloned directory. |
22-
| `zsh_stats` | Get a list of the top 20 commands and how many times they have been run. |
19+
| Command | Description |
20+
| :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
21+
| `alias` | List all aliases |
22+
| `mkcd` | Create a new directory and change to it, will create intermediate directories as required. |
23+
| `take` | Like `mkcd`, but also knows how to handle remote URLs. When given an argument that looks like a URL (something that ends in `.git` or `.tar.(gz\|bz2\|xz)`), download the remote resource and extract it (if necessary) into the current directory. Then change to the newly extracted/downloaded/cloned directory. |
24+
| `zsh_stats` | Get a list of the top 20 commands and how many times they have been run. |
2325

2426
## Directory
2527

26-
| Alias | Command |
27-
| :--------- | :----------------------------------------- |
28-
| `md` | `mkdir -p` |
29-
| `rd` | `rmdir` |
30-
| `~` | `cd` (change to home directory) |
31-
| `..` | `cd ..` |
32-
| `...` | `cd ../..` |
33-
| `....` | `cd ../../..` |
34-
| `.....` | `cd ../../../..` |
35-
| `/` | `cd /` |
36-
| `d` | `dirs -v` (lists last visited directories) |
37-
| `cd +n` | Switch to directory number `n` |
38-
| `-` | `cd` to last visited directory |
39-
| `1` | `cd -1` |
40-
| `2` | `cd -2` |
41-
| `3` | `cd -3` |
42-
| `4` | `cd -4` |
43-
| `5` | `cd -5` |
44-
| `6` | `cd -6` |
45-
| `7` | `cd -7` |
46-
| `8` | `cd -8` |
47-
| `9` | `cd -9` |
28+
| Alias | Command |
29+
| :------ | :----------------------------------------- |
30+
| `md` | `mkdir -p` |
31+
| `rd` | `rmdir` |
32+
| `~` | `cd` (change to home directory) |
33+
| `..` | `cd ..` |
34+
| `...` | `cd ../..` |
35+
| `....` | `cd ../../..` |
36+
| `.....` | `cd ../../../..` |
37+
| `/` | `cd /` |
38+
| `d` | `dirs -v` (lists last visited directories) |
39+
| `cd +n` | Switch to directory number `n` |
40+
| `-` | `cd` to last visited directory |
41+
| `1` | `cd -1` |
42+
| `2` | `cd -2` |
43+
| `3` | `cd -3` |
44+
| `4` | `cd -4` |
45+
| `5` | `cd -5` |
46+
| `6` | `cd -6` |
47+
| `7` | `cd -7` |
48+
| `8` | `cd -8` |
49+
| `9` | `cd -9` |

Diff for: Code-Style-Guide.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!-- prettier-ignore-start -->
12
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
23
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
4+
<!-- prettier-ignore-end -->
35
46
## General Code Style
57

@@ -27,15 +29,15 @@ long_string_1="I am an exceptionalllllllllllly loooooooooooooooooooooooooooooooo
2729

2830
```shell
2931
cat <<END;
30-
I am an exceptionalllllllllllly
32+
I am an exceptionalllllllllllly
3133
looooooooooooooooooooooooooooooooooooooooong string.
3234
END
3335
```
3436

3537
##### _Good:_
3638

3739
```shell
38-
long_string_2="I am an exceptionalllllllllllly
40+
long_string_2="I am an exceptionalllllllllllly
3941
looooooooooooooooooooooooooooooooooooooooong string."
4042
```
4143

@@ -175,7 +177,7 @@ Ensure that local variables are only seen inside a function and its children by
175177
```shell
176178
function func_bad() {
177179
global_var=37 # Visible only within the function block
178-
# before the function has been called.
180+
# before the function has been called.
179181
}
180182

181183
echo "global_var = $global_var" # Function "func_bad" has not yet been called,

Diff for: Contribution-Technical-Practices.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!-- prettier-ignore-start -->
12
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
23
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
4+
<!-- prettier-ignore-end -->
35
46
Oh My Zsh is a community-driven project and contributions are welcome, but it all works best with a proper setup. Here follow the best practices for setting up a fork and getting started for contributing.
57

Diff for: Customization.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!-- prettier-ignore-start -->
12
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
23
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
4+
<!-- prettier-ignore-end -->
35
46
Oh My Zsh is fully configurable to your needs with the help of the `$ZSH_CUSTOM` variable, whether you want to change its internals, plugins or the rich theme set – and all that **without forking**!
57

@@ -30,11 +32,11 @@ $ZSH_CUSTOM
3032

3133
Also follow these steps if you want to override plugins that ship with your Oh My Zsh installation. To override a plugin with a custom version, put your custom version at `$ZSH_CUSTOM/plugins/<plugin_name>/`. For example, if it's the rvm plugin you want to override, create the directory `custom/plugins/rvm` and place a file called `rvm.plugin.zsh` inside of it.
3234

33-
This method will override the entire plugin: your custom plugin files will be loaded *instead* of the files from the original plugin.
35+
This method will override the entire plugin: your custom plugin files will be loaded _instead_ of the files from the original plugin.
3436

3537
### Partially overriding an existing plugin
3638

37-
To partially customize a plugin by redefining individual functions or variables from it, use a "patch" plugin. Create a custom "patch" plugin with a different name that has definitions for just the items you wish to override, and load that after the base plugin by putting your patch plugin in `$plugins` *after* the base plugin it customizes. (This is necessary because user custom files are loaded before any plugins are loaded.) Make sure it doesn't have the same name as any other base plugin, either.
39+
To partially customize a plugin by redefining individual functions or variables from it, use a "patch" plugin. Create a custom "patch" plugin with a different name that has definitions for just the items you wish to override, and load that after the base plugin by putting your patch plugin in `$plugins` _after_ the base plugin it customizes. (This is necessary because user custom files are loaded before any plugins are loaded.) Make sure it doesn't have the same name as any other base plugin, either.
3840

3941
This may or may not work, depending on how the plugin is written: your redefinitions only take effect after the plugin has been loaded by `source`-ing its definition file. If any of the things you redefine are called or referenced during the plugin's initialization, they will not see your redefinitions.
4042

Diff for: Design.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
<!-- prettier-ignore-start -->
12
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
23
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
4+
<!-- prettier-ignore-end -->
35
46
This page is a description of the current architecture and design of Oh My Zsh.
57

@@ -25,7 +27,7 @@ It seems that plugins can get arbitrarily powerful and do whatever they want, so
2527

2628
## Variables
2729

28-
These are variables that base OMZ (excluding any plugins) uses. I've read through .oh-my-zsh so far, but not the lib/*.zsh files. More may be on the way.
30+
These are variables that base OMZ (excluding any plugins) uses. I've read through .oh-my-zsh so far, but not the lib/\*.zsh files. More may be on the way.
2931

3032
### Variables OMZ reads
3133

@@ -39,8 +41,8 @@ In oh-my-zsh.sh:
3941
- `ZSH_THEME` – theme to load at startup
4042
- `CASE_SENSITIVE` – controls zsh completion matching
4143
- `COMPLETION_WAITING_DOTS`
42-
- `DISABLE_AUTO_UPDATE` – ("true"/*)
43-
- `DISABLE_AUTO_PROMPT` – ("true"/*)
44+
- `DISABLE_AUTO_UPDATE` – ("true"/\*)
45+
- `DISABLE_AUTO_PROMPT` – ("true"/\*)
4446
- `DISABLE_LS_COLORS` – in lib/theme-and-appearance
4547
- `ENABLE_CORRECTION`
4648
- `ZSH_CACHE_DIR`
@@ -67,13 +69,13 @@ At init:
6769
- `POST_1_7_2_GIT`
6870
- `PAGER`
6971
- `LESS`
70-
- `FX` – special terminal control "effects" (reset/bold/no-bold/etc)
72+
- `FX` – special terminal control "effects" (reset/bold/no-bold/etc)
7173
- `FG`
7274
- `BG`
7375

7476
At init (defaults if not provided):
7577

76-
- `ZSH_CUSTOM` - defaults to `$ZSH/custom`
78+
- `ZSH_CUSTOM` - defaults to `$ZSH/custom`
7779
- `ZSH_CACHE_DIR` - defaults to `$ZSH/cache`
7880
- `ZSH_COMPDUMP`
7981
- `ZSH_SPECTRUM_TEXT`
@@ -117,7 +119,7 @@ The initialization steps in detail:
117119
- Discovers and sources all lib files, in alphabetical order, respecting custom overrides
118120
- Load custom user code
119121
- Source each `$ZSH_CUSTOM/*.zsh` file, in alphabetical order
120-
- Pre-load plugins (add to `$fpath`, but don't source)
122+
- Pre-load plugins (add to `$fpath`, but don't source)
121123
- Set `$SHORT_HOST`
122124
- Initialize Completion support
123125
- Set `$ZSH_COMPDUMP`
@@ -130,16 +132,16 @@ The initialization steps in detail:
130132

131133
In Oh My Zsh terms, _customization_ means adding or overriding zsh code, including its internals and implementation. It's not just a term for user-specified configuration.
132134

133-
Overriding internals can be done by adding `*.zsh` files to the `$ZSH_CUSTOM` root directory. All `*.zsh` files there will be sourced after OMZ loads and sources its own lib/* files. This allows you to redefine functions after the fact. (This will take place after any setup has called OMZ functions.) These are referred to as "config files" in oh-my-zsh.sh.
135+
Overriding internals can be done by adding `*.zsh` files to the `$ZSH_CUSTOM` root directory. All `*.zsh` files there will be sourced after OMZ loads and sources its own lib/\* files. This allows you to redefine functions after the fact. (This will take place after any setup has called OMZ functions.) These are referred to as "config files" in oh-my-zsh.sh.
134136

135137
It's not documented in the _Customization_ page, but `$ZSH_CUSTOM/lib/*.zsh` do override the corresponding internals lib files. If a custom one is present, it is sourced instead of the one in the distribution.
136138

137139
So, you can:
138140

139-
- Override lib/* files on a per-file basis (loaded instead of the base file of the same name)
141+
- Override lib/\* files on a per-file basis (loaded instead of the base file of the same name)
140142
- Add arbitrary customization code that runs later and can redefine any function or variable from the core
141143
- Override plugins and themes on a per-plugin/theme basis (loaded instead of base)
142-
- Override parts of plugins by defining an additional "patch" plugin and including it in `$plugins` *after* the base plugin
144+
- Override parts of plugins by defining an additional "patch" plugin and including it in `$plugins` _after_ the base plugin
143145

144146
`$ZSH_CUSTOM` controls where the custom override files are found; defaults to `$ZSH/custom` (under the main OMZ installation).
145147

@@ -169,7 +171,7 @@ Themes control the appearance of the `zsh` prompt, the appearance of certain oth
169171

170172
OMZ turns on the `prompt_subst` shell option, and OMZ themes assume it is enabled.
171173

172-
Themes set a variety of variables to control the appearance of the zsh prompt. They may also install hook functions. These variables are read by core OMZ functions like `git_prompt_info()` and used to modify their behavior and style their output.
174+
Themes set a variety of variables to control the appearance of the zsh prompt. They may also install hook functions. These variables are read by core OMZ functions like `git_prompt_info()` and used to modify their behavior and style their output.
173175

174176
Things themes do:
175177

@@ -183,7 +185,7 @@ These variables are set by themes to control the prompt's appearance and other c
183185

184186
- `PROMPT`
185187
- `DEFAULT_USER`
186-
- `ZSH_THEME_SCM_PROMPT_PREFIX` – used in `bzr_prompt_info()` from `lib/bzr.sh`
188+
- `ZSH_THEME_SCM_PROMPT_PREFIX` – used in `bzr_prompt_info()` from `lib/bzr.sh`
187189

188190
git_prompt_info():
189191

Diff for: External-plugins.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page, go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
1+
<!-- prettier-ignore-start -->
2+
> _This wiki is automatically published from [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki). To edit this page,_
3+
> _go to [ohmyzsh/wiki](https://github.com/ohmyzsh/wiki), make your changes and submit a Pull Request._
4+
<!-- prettier-ignore-end -->
25
36
## Non-Bundled Plugins
47

0 commit comments

Comments
 (0)