mudhorn/oh-my-posh
1
0
Fork 0
mirror of https://github.com/JanDeDobbeleer/oh-my-posh.git synced 2024-11-09 20:44:03 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

fix: consistent naming for Oh My Posh

Browse source 
relates to https://github.com/microsoft/winget-pkgs/pull/16328
This commit is contained in:
Jan De Dobbeleer 2021-06-05 19:27:33 +02:00 committed by Jan De Dobbeleer
parent abe3d0990b
commit b21670f35b
19 changed files with 45 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE.md vendored
View file

@ -9,7 +9,7 @@
### Environment
- Oh my Posh version:
- Oh My Posh version:
- Theme:
- Operating System:
- Shell:

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View file

@ -12,7 +12,7 @@
### Tips
If you're not comfortable working with git, we're working a [guide][docs] to help you out.
Oh my Posh advises [GitKraken][kraken] as your preferred cross platfrom git GUI powertool.
Oh My Posh advises [GitKraken][kraken] as your preferred cross platfrom git GUI powertool.
[cc]: https://www.conventionalcommits.org/en/v1.0.0/#summary
[docs]: https://ohmyposh.dev/docs/contributing_git

6
docs/docs/configuration.md
View file

@ -4,7 +4,7 @@ title: Configuration
sidebar_label: ⚙️ Configuration
---
Oh my Posh renders your prompt based on the definition of _blocks_ (like Lego) which contain one or more _segments_.
Oh My Posh renders your prompt based on the definition of _blocks_ (like Lego) which contain one or more _segments_.
A really simple configuration could look like this.
```json
@ -33,7 +33,7 @@ A really simple configuration could look like this.
```
With this configuration, a single powerline segment is rendered that shows the name of the folder you're currently in.
To set this configuration in combination with a Oh my Posh [executable][releases], use the `--config` flag to
To set this configuration in combination with a Oh My Posh [executable][releases], use the `--config` flag to
set a path to a json file containing the above code. The `--shell universal` flag is used to print the prompt without
escape characters to see the prompt as it would be shown inside a prompt function for your shell.
@ -345,7 +345,7 @@ To change *only* the background color, just omit the first color from the above
"prefix": "<,#FFFFFF>┏[</>",
```
Oh my Posh mainly supports three different color types being
Oh My Posh mainly supports three different color types being
- Typical [hex colors][hexcolors] (for example `#CB4B16`).
- The `transparent` keyword which can be used to create either a transparent foreground override

8
docs/docs/contributing-started.mdx
View file

@ -12,7 +12,7 @@ The codebase is in [go][go], meaning we need a working go setup before we can do
Have a look at the [go guide][go-started] to get up and running with go in no time!
:::info
Oh my Posh needs at least go 1.16.
Oh My Posh needs at least go 1.16.
:::
### golangci-lint
@ -23,9 +23,9 @@ Have a look at the [local installation guide][golang-ci-lint-local] to make sure
## Get the source code
The source is hosted on [Github][omp]. When you want to contribute, create a [fork][gh-fork] so you can make changes in
your repository and create pull request in the official Oh my Posh repository.
your repository and create pull request in the official Oh My Posh repository.
Clone your fork of Oh my Posh locally, replace `<user>` with your Github username.
Clone your fork of Oh My Posh locally, replace `<user>` with your Github username.
```bash
git clone git@github.com:<user>/oh-my-posh.git
@ -51,7 +51,7 @@ golangci-lint run
The easiest way to validate your changes is to write tests. Unfortunately, as it's a visual tool, you'll want to validate
the changes by running the prompt in your shell as well. You can make use of go's `bin` folder which is usually added to
your path to add your own Oh my Posh binary to and immediately see the changes appear in your shell.
your path to add your own Oh My Posh binary to and immediately see the changes appear in your shell.
```bash
go build -o $GOPATH/bin/oh-my-posh

4
docs/docs/faq.mdx
View file

@ -7,7 +7,7 @@ sidebar_label: 🤨 FAQ
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
Before validating anything, make sure you're on the [latest version][latest] of Oh my Posh and your terminal and shell are up-to-date.
Before validating anything, make sure you're on the [latest version][latest] of Oh My Posh and your terminal and shell are up-to-date.
### The prompt is slow (delay in showing the prompt between commands)
@ -45,7 +45,7 @@ Once added, reload your profile for the changes to take effect.
</TabItem>
<TabItem value="others">
You can use the Oh my Posh's built-in `--debug` flag to identify slow segments.
You can use the Oh My Posh's built-in `--debug` flag to identify slow segments.
```bash
oh-my-posh --config ~/.mytheme.omp.json --debug --shell uni

4
docs/docs/fonts.md
View file

@ -6,10 +6,10 @@ sidebar_label: 🆎 Fonts
### Nerd Fonts
Oh my Posh was designed to use [Nerd Fonts][nerdfonts]. Nerd Fonts are popular fonts that are patched to include icons.
Oh My Posh was designed to use [Nerd Fonts][nerdfonts]. Nerd Fonts are popular fonts that are patched to include icons.
We recommend [Meslo LGM NF][meslo], but any Nerd Font should be compatible with the standard [themes][themes].
To see the icons displayed in Oh my Posh, **install** a [Nerd Font][nerdfonts], and **configure** your terminal to use it.
To see the icons displayed in Oh My Posh, **install** a [Nerd Font][nerdfonts], and **configure** your terminal to use it.
#### Windows

2
docs/docs/install-linux.mdx
View file

@ -12,7 +12,7 @@ import CustomizeCmd from "./install-customize-cmd.mdx";
### Setup your terminal
Oh my Posh uses ANSI color codes under the hood, these should work in every terminal,
Oh My Posh uses ANSI color codes under the hood, these should work in every terminal,
but you may have to set the environment variable `$TERM` to `xterm-256color` for it to work.
### Installation

4
docs/docs/install-macos.mdx
View file

@ -27,10 +27,10 @@ brew install oh-my-posh
This installs two things:
- `oh-my-posh` - Executable, added to `/usr/local/bin`
- `themes` - The latest Oh my Posh themes
- `themes` - The latest Oh My Posh themes
If you want to use a standard theme, you can find them in `$(brew --prefix oh-my-posh)/themes`, referencing them as such
will always keep them compatible with the binary when updating Oh my Posh.
will always keep them compatible with the binary when updating Oh My Posh.
#### Preview the themes

2
docs/docs/install-pwsh.mdx
View file

@ -9,7 +9,7 @@ import TabItem from "@theme/TabItem";
import Customize from "./install-customize.md";
:::info
This guide is for usage inside PowerShell only. If you plan to use Oh my Posh inside other shells as well,
This guide is for usage inside PowerShell only. If you plan to use Oh My Posh inside other shells as well,
have a look at the platform specific install instructions.
:::

4
docs/docs/install-shells.mdx
View file

@ -2,7 +2,7 @@ import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
:::info
If you have no idea which shell you're currently using, Oh my Posh has a utility switch that can you tell you (not relevant
If you have no idea which shell you're currently using, Oh My Posh has a utility switch that can you tell you (not relevant
for the Powershell module).
:::
@ -78,7 +78,7 @@ Or, when using `~/.profile`.
It's advised to be on the latest version of fish. Versions below 3.1.2 have issues displaying the prompt.
:::
Initialize Oh my Posh in `~/.config/fish/config.fish`:
Initialize Oh My Posh in `~/.config/fish/config.fish`:
```bash
oh-my-posh --init --shell fish --config ~/.poshthemes/jandedobbeleer.omp.json | source

10
docs/docs/install-windows.mdx
View file

@ -12,7 +12,7 @@ import CustomizeCmd from "./install-customize-cmd.mdx";
### Setup your terminal
While Oh my Posh works on the standard terminal, we advise using the [Windows Terminal][wt].
While Oh My Posh works on the standard terminal, we advise using the [Windows Terminal][wt].
### Installation
@ -34,11 +34,11 @@ This installs a couple of things:
- `oh-my-posh.exe` - Windows executable, added to your `$PATH`
- `oh-my-posh-wsl` - Linux executable, added to your `$PATH` for use in the WSL
- `themes` - The latest Oh my Posh themes
- `themes` - The latest Oh My Posh themes
If you want to use a standard theme, you can find them in `~\AppData\Local\Programs\oh-my-posh\themes\`,
referencing them as such
will always keep them compatible with the binary when updating Oh my Posh.
will always keep them compatible with the binary when updating Oh My Posh.
</TabItem>
<TabItem value="scoop">
@ -51,11 +51,11 @@ This installs a couple of things:
- `oh-my-posh.exe` - Windows executable, added to your `$PATH`
- `oh-my-posh-wsl` - Linux executable, added to your `$PATH` for use in the WSL
- `themes` - The latest Oh my Posh themes
- `themes` - The latest Oh My Posh themes
If you want to use a standard theme, you can find them in `~\scoop\apps\oh-my-posh\current\themes\`,
referencing them as such
will always keep them compatible with the binary when updating Oh my Posh.
will always keep them compatible with the binary when updating Oh My Posh.
</TabItem>
</Tabs>

18
docs/docs/introduction.md
View file

@ -5,29 +5,29 @@ sidebar_label: 👋 Introduction
slug: /
---
Oh my Posh is a custom prompt engine for any shell that has the ability to adjust
Oh My Posh is a custom prompt engine for any shell that has the ability to adjust
the prompt string with a function or variable.
## Oh my Posh 3 vs Oh my Posh 2
## Oh My Posh 3 vs Oh My Posh 2
Oh my Posh 3 is the offspring of [Oh my Posh][omp], a prompt theme engine for PowerShell.
Oh my Posh started out by being inspired from tools like [oh my zsh][omz] when nothing was
Oh My Posh 3 is the offspring of [Oh My Posh][omp], a prompt theme engine for PowerShell.
Oh My Posh started out by being inspired from tools like [oh my zsh][omz] when nothing was
available specifically for PowerShell.
Over the years, I switched operating system/main shell quite a lot, even on
Windows via the [WSL][wsl]. This made it so that my prompt wasn't portable enough,
I wanted the same visual/functional experience regardless
of the shell I was working in. Hello world [Oh my Posh 3][omp3]!
of the shell I was working in. Hello world [Oh My Posh 3][omp3]!
## Concept
Traditionally, prompt tools work with custom scripts per theme (just like [Oh my Posh][omp] did) or a lot
of CLI configuration switches to define what it looks like. With Oh my Posh, I wanted to start from a single
Traditionally, prompt tools work with custom scripts per theme (just like [Oh My Posh][omp] did) or a lot
of CLI configuration switches to define what it looks like. With Oh My Posh, I wanted to start from a single
configuration file that could easily be shared anywhere, removing the need to really grasp what goes on underneath.
When you look at prompts like Agnoster or Paradox, you notice they usually consist of a few building
**blocks** which contain one or more **segments** that display some sort of information. The configuration of
Oh my Posh works exactly like that. Blocks are a combination of one or more segments.
Oh My Posh works exactly like that. Blocks are a combination of one or more segments.
The basic layout of the config file is as follows.
@ -53,7 +53,7 @@ A [block][block] has properties that indicate its position and the [segments][se
A [segment][segment] renders a single context like showing the current folder, user information or git status
when relevant. It can be styled any way you want, resulting in visualizing the prompt you are looking for.
For your convenience, the existing [themes][themes] from [Oh my Posh][omp-themes] have been added to version 3, so you
For your convenience, the existing [themes][themes] from [Oh My Posh][omp-themes] have been added to version 3, so you
can get started even without having to understand the theming. So, let's no longer waste time on theory, have a look at the
installation guide to get started right away!

2
docs/docs/themes.md
View file

@ -4,7 +4,7 @@ title: Themes
sidebar_label: 🎨 Themes
---
Oh my Posh comes with many themes included out of the box. Below are some screenshots of the more common themes.
Oh My Posh comes with many themes included out of the box. Below are some screenshots of the more common themes.
For the full updated list of themes, [view the themes][themes] in Github. If you are using PowerShell, you can
display every available theme using the following PowerShell cmdlet.

6
docs/docusaurus.config.js
View file

@ -1,5 +1,5 @@
module.exports = {
title: "Oh my Posh",
title: "Oh My Posh",
tagline: "A prompt theme engine for any shell.",
url: "https://ohmyposh.dev",
baseUrl: "/",
@ -14,9 +14,9 @@ module.exports = {
darkTheme: require("prism-react-renderer/themes/oceanicNext"),
},
navbar: {
title: "Oh my Posh",
title: "Oh My Posh",
logo: {
alt: "Oh my Posh Logo",
alt: "Oh My Posh Logo",
src: "img/logo.svg",
},
items: [

4
docs/src/pages/index.js
View file

@ -11,7 +11,7 @@ const features = [
title: <>Colors</>,
description: (
<>
Oh my Posh enables you to use the full color set of your terminal
Oh My Posh enables you to use the full color set of your terminal
by using colors to define and render the prompt.
</>
),
@ -71,7 +71,7 @@ function Home() {
Get Started
</Link>
</div>
<img class="hero--image" src="/img/hero.png" alt="Oh my Posh prompt"></img>
<img class="hero--image" src="/img/hero.png" alt="Oh My Posh prompt"></img>
</div>
</header>
<main>

4
packages/inno/oh-my-posh.iss
View file

@ -1,8 +1,8 @@
[Setup]
AppName=Oh my Posh
AppName=Oh My Posh
AppVersion=<VERSION>
DefaultDirName={autopf}\oh-my-posh
DefaultGroupName=Oh my Posh
DefaultGroupName=Oh My Posh
PrivilegesRequired=lowest
AppPublisher=Jan De Dobbeleer
AppPublisherURL=https://ohmyposh.dev

2
packages/scoop/oh-my-posh.json
View file

@ -17,7 +17,7 @@
"github": "https://github.com/JanDeDobbeleer/oh-my-posh"
},
"post_install": [
"Write-Host 'Thanks for installing Oh my Posh.'",
"Write-Host 'Thanks for installing Oh My Posh.'",
"Write-Host 'Have a look at https://ohmyposh.dev/docs/installation for detailed instructions for your shell.'"
],
"autoupdate": {

2
src/main.go
View file

@ -27,7 +27,7 @@ var bashInit string
var zshInit string
const (
noExe = "echo \"Unable to find Oh my Posh executable\""
noExe = "echo \"Unable to find Oh My Posh executable\""
zsh = "zsh"
bash = "bash"
pwsh = "pwsh"

2
themes/schema.json
View file

@ -2,7 +2,7 @@
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "http://example.com/example.json",
"type": "object",
"title": "The Oh my Posh theme definition",
"title": "The Oh My Posh theme definition",
"description": "https://ohmyposh.dev/docs/configure",
"definitions": {
"color": {