Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(GH-89) Rename shims to an apt-style prefix #1946

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/generated/CommandsInstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Install Command (choco install)

Installs a package or a list of packages (sometimes specified as a
packages.config). Some may prefer to use `cinst` as a shortcut for
packages.config). Some may prefer to use `choco-inst` as a shortcut for
[[`choco install`|Commandsinstall]].

**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
Expand All @@ -14,7 +14,7 @@ Installs a package or a list of packages (sometimes specified as a
## Usage

choco install <pkg|packages.config> [<pkg2> <pkgN>] [<options/switches>]
cinst <pkg|packages.config> [<pkg2> <pkgN>] [<options/switches>]
choco-inst <pkg|packages.config> [<pkg2> <pkgN>] [<options/switches>]

**NOTE:** `all` is a special package keyword that will allow you to install
all packages from a custom feed. Will not work with Chocolatey default
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/CommandsList.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# List/Search Command (choco list)

Chocolatey will perform a search for a package local or remote. Some
may prefer to use [[`clist`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].
may prefer to use [[`choco-list`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].

**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
with options and switches. In most cases you can still pass options
Expand All @@ -14,7 +14,7 @@ Chocolatey will perform a search for a package local or remote. Some

choco search <filter> [<options/switches>]
choco list <filter> [<options/switches>]
clist <filter> [<options/switches>]
choco-list <filter> [<options/switches>]

## Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/CommandsPush.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Push Command (choco push)

Chocolatey will attempt to push a compiled nupkg to a package feed.
Some may prefer to use `cpush` as a shortcut for `choco push`.
Some may prefer to use `choco-push` as a shortcut for `choco push`.

**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. Default push location is deprecated and
Expand All @@ -19,7 +19,7 @@ A feed can be a local folder, a file share, the [community feed](https://chocola
## Usage

choco push [<path to nupkg>] [<options/switches>]
cpush [<path to nupkg>] [<options/switches>]
choco-push [<path to nupkg>] [<options/switches>]

**NOTE:** If there is more than one nupkg file in the folder, the command
will require specifying the path to the file.
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/CommandsReference.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This is a listing of all of the different things you can pass to choco.
* [[setapikey|CommandsSetapikey]] - retrieves or saves an apikey for a particular source (alias for apikey)
* [[apikey|CommandsApikey]] - retrieves or saves an apikey for a particular source
* [[unpackself|CommandsUnpackself]] - have chocolatey set itself up
* [[version|CommandsVersion]] - [DEPRECATED] will be removed in v1 - use [[`choco outdated`|Commandsoutdated]] or `cup <pkg|all> -whatif` instead
* [[version|CommandsVersion]] - [DEPRECATED] will be removed in v1 - use [[`choco outdated`|Commandsoutdated]] or `choco-up <pkg|all> -whatif` instead
* [[update|CommandsUpdate]] - [DEPRECATED] RESERVED for future use (you are looking for upgrade, these are not the droids you are looking for)
* [[support|CommandsSupport]] - provides support information
* [[download|CommandsDownload]] - downloads packages - optionally internalizing all remote resources
Expand Down Expand Up @@ -89,7 +89,7 @@ Following this guide will ensure your experience is not frustrating
based on choco not receiving things you think you are passing to it.

* For consistency, always use `choco`, not `choco.exe`. Never use
shortcut commands like `cinst` or `cup`.
shortcut commands like `choco-inst` or `choco-up`.
* Always have the command as the first argument to `choco. e.g.
[[`choco install`|Commandsinstall]], where [[`install`|Commandsinstall]] is the command.
* If there is a subcommand, ensure that is the second argument. e.g.
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/CommandsSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# List/Search Command (choco search)

Chocolatey will perform a search for a package local or remote. Some
may prefer to use [[`clist`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].
may prefer to use [[`choco-list`|Commandslist]] as a shortcut for [[`choco list`|Commandslist]].

**NOTE:** 100% compatible with older Chocolatey client (0.9.8.x and below)
with options and switches. In most cases you can still pass options
Expand All @@ -14,7 +14,7 @@ Chocolatey will perform a search for a package local or remote. Some

choco search <filter> [<options/switches>]
choco list <filter> [<options/switches>]
clist <filter> [<options/switches>]
choco-list <filter> [<options/switches>]

## Examples

Expand Down
4 changes: 2 additions & 2 deletions docs/generated/CommandsUninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Uninstall Command (choco uninstall)

Uninstalls a package or a list of packages. Some may prefer to use
`cuninst` as a shortcut for [[`choco uninstall`|Commandsuninstall]].
`choco-uninst` as a shortcut for [[`choco uninstall`|Commandsuninstall]].

**NOTE:** 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. Add `-y` for previous behavior with no
Expand Down Expand Up @@ -54,7 +54,7 @@ chocolatey without attempting to uninstall the program.
## Usage

choco uninstall <pkg|all> [pkg2 pkgN] [options/switches]
cuninst <pkg|all> [pkg2 pkgN] [options/switches]
choco-uninst <pkg|all> [pkg2 pkgN] [options/switches]

**NOTE:** `all` is a special package keyword that will allow you to
uninstall all packages.
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/CommandsUpgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Upgrade Command (choco upgrade)

Upgrades a package or a list of packages. Some may prefer to use `cup`
Upgrades a package or a list of packages. Some may prefer to use `choco-up`
as a shortcut for [[`choco upgrade`|Commandsupgrade]]. If you do not have a package
installed, upgrade will install it.

Expand All @@ -14,7 +14,7 @@ Upgrades a package or a list of packages. Some may prefer to use `cup`
## Usage

choco upgrade <pkg|all> [<pkg2> <pkgN>] [<options/switches>]
cup <pkg|all> [<pkg2> <pkgN>] [<options/switches>]
choco-up <pkg|all> [<pkg2> <pkgN>] [<options/switches>]

**NOTE:** `all` is a special package keyword that will allow you to upgrade
all currently installed packages.
Expand Down
2 changes: 1 addition & 1 deletion nuget/chocolatey/tools/chocolateysetup.psm1
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ param(

$from = "$chocolateyPathOld\bin"
$to = "$chocolateyPath\bin"
$exclude = @("choco.exe", "chocolatey.exe", "cinst.exe", "clist.exe", "cpack.exe", "cpush.exe", "cuninst.exe", "cup.exe", "cver.exe", "RefreshEnv.cmd")
$exclude = @("choco.exe", "chocolatey.exe", "choco-inst.exe", "choco-list.exe", "choco-pack.exe", "choco-push.exe", "choco-uninst.exe", "choco-up.exe", "choco-ver.exe", "RefreshEnv.cmd")
Get-ChildItem -Path $from -recurse -Exclude $exclude |
% {
Write-Debug "Copying $_ `n to $to"
Expand Down
2 changes: 1 addition & 1 deletion setup.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ if(-not $env:ChocolateyInstall -or -not (Test-Path "$env:ChocolateyInstall")){
iex ((new-object net.webclient).DownloadString("https://chocolatey.org/install.ps1"))
}

cinst pester -version 2.0.2
choco-inst pester -version 2.0.2
28 changes: 14 additions & 14 deletions src/chocolatey.resources/chocolatey.resources.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -82,27 +82,27 @@
<EmbeddedResource Include="helpers\functions\Write-FileUpdateLog.ps1" />
<EmbeddedResource Include="redirects\choco.exe.ignore" />
<EmbeddedResource Include="redirects\chocolatey.exe.ignore" />
<EmbeddedResource Include="redirects\cinst.exe.ignore" />
<EmbeddedResource Include="redirects\clist.exe.ignore" />
<EmbeddedResource Include="redirects\cpack.exe.ignore" />
<EmbeddedResource Include="redirects\cpush.exe.ignore" />
<EmbeddedResource Include="redirects\cuninst.exe.ignore" />
<EmbeddedResource Include="redirects\cup.exe.ignore" />
<EmbeddedResource Include="redirects\cver.exe.ignore" />
<EmbeddedResource Include="redirects\choco-inst.exe.ignore" />
<EmbeddedResource Include="redirects\choco-list.exe.ignore" />
<EmbeddedResource Include="redirects\choco-pack.exe.ignore" />
<EmbeddedResource Include="redirects\choco-push.exe.ignore" />
<EmbeddedResource Include="redirects\choco-uninst.exe.ignore" />
<EmbeddedResource Include="redirects\choco-up.exe.ignore" />
<EmbeddedResource Include="redirects\choco-ver.exe.ignore" />
<EmbeddedResource Include="tools\checksum.exe.ignore" />
<EmbeddedResource Include="tools\shimgen.exe.ignore" />
</ItemGroup>
<ItemGroup>
<EmbeddedResource Include="LICENSE.txt" />
<EmbeddedResource Include="redirects\choco.exe" />
<EmbeddedResource Include="redirects\chocolatey.exe" />
<EmbeddedResource Include="redirects\cinst.exe" />
<EmbeddedResource Include="redirects\clist.exe" />
<EmbeddedResource Include="redirects\cpack.exe" />
<EmbeddedResource Include="redirects\cpush.exe" />
<EmbeddedResource Include="redirects\cuninst.exe" />
<EmbeddedResource Include="redirects\cup.exe" />
<EmbeddedResource Include="redirects\cver.exe" />
<EmbeddedResource Include="redirects\choco-inst.exe" />
<EmbeddedResource Include="redirects\choco-list.exe" />
<EmbeddedResource Include="redirects\choco-pack.exe" />
<EmbeddedResource Include="redirects\choco-push.exe" />
<EmbeddedResource Include="redirects\choco-uninst.exe" />
<EmbeddedResource Include="redirects\choco-up.exe" />
<EmbeddedResource Include="redirects\choco-ver.exe" />
<EmbeddedResource Include="tools\7zip.license.txt" />
<EmbeddedResource Include="tools\checksum.exe" />
<EmbeddedResource Include="tools\checksum.license.txt" />
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ public virtual void help_message(ChocolateyConfiguration configuration)
this.Log().Info(ChocolateyLoggers.Important, "List/Search Command");
this.Log().Info(@"
Chocolatey will perform a search for a package local or remote. Some
may prefer to use `clist` as a shortcut for `choco list`.
may prefer to use `choco-list` as a shortcut for `choco list`.

NOTE: 100% compatible with older Chocolatey client (0.9.8.x and below)
with options and switches. In most cases you can still pass options
Expand All @@ -164,7 +164,7 @@ the command reference (`choco -?`).
"chocolatey".Log().Info(@"
choco search <filter> [<options/switches>]
choco list <filter> [<options/switches>]
clist <filter> [<options/switches>]
choco-list <filter> [<options/switches>]
");

"chocolatey".Log().Info(ChocolateyLoggers.Important, "Examples");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ public virtual void help_message(ChocolateyConfiguration configuration)
this.Log().Info(ChocolateyLoggers.Important, "Pack Command");
this.Log().Info(@"
Chocolatey will attempt to package a nuspec into a compiled nupkg. Some
may prefer to use `cpack` as a shortcut for `choco pack`.
may prefer to use `choco-pack` as a shortcut for `choco pack`.

NOTE: 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. In most cases you can still pass options
Expand All @@ -92,15 +92,15 @@ the command reference (`choco -?`).
NOTE: You can pass arbitrary property value pairs through to nuspecs.
These will replace variables formatted as `$property$` with the value passed.

NOTE: `cpack` has been deprecated as it has a name collision with CMake. Please
NOTE: `choco-pack` has been deprecated as it has a name collision with CMake. Please
use `choco pack` instead. The shortcut will be removed in v1.

");

"chocolatey".Log().Info(ChocolateyLoggers.Important, "Usage");
"chocolatey".Log().Info(@"
choco pack [<path to nuspec>] [<options/switches>] [<property=value>]
cpack [<path to nuspec>] [<options/switches>] (DEPRECATED)
choco-pack [<path to nuspec>] [<options/switches>] (DEPRECATED)
");

"chocolatey".Log().Info(ChocolateyLoggers.Important, "Examples");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ public virtual void help_message(ChocolateyConfiguration configuration)
this.Log().Info(ChocolateyLoggers.Important, "Push Command");
this.Log().Info(@"
Chocolatey will attempt to push a compiled nupkg to a package feed.
Some may prefer to use `cpush` as a shortcut for `choco push`.
Some may prefer to use `choco-push` as a shortcut for `choco push`.

NOTE: 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. Default push location is deprecated and
Expand All @@ -165,7 +165,7 @@ the command reference (`choco -?`).
"chocolatey".Log().Info(ChocolateyLoggers.Important, "Usage");
"chocolatey".Log().Info(@"
choco push [<path to nupkg>] [<options/switches>]
cpush [<path to nupkg>] [<options/switches>]
choco-push [<path to nupkg>] [<options/switches>]

NOTE: If there is more than one nupkg file in the folder, the command
will require specifying the path to the file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ public virtual void help_message(ChocolateyConfiguration configuration)
this.Log().Info(ChocolateyLoggers.Important, "Uninstall Command");
this.Log().Info(@"
Uninstalls a package or a list of packages. Some may prefer to use
`cuninst` as a shortcut for `choco uninstall`.
`choco-uninst` as a shortcut for `choco uninstall`.

NOTE: 100% compatible with older chocolatey client (0.9.8.32 and below)
with options and switches. Add `-y` for previous behavior with no
Expand Down Expand Up @@ -207,7 +207,7 @@ to determine how to automatically uninstall software.
"chocolatey".Log().Info(ChocolateyLoggers.Important, "Usage");
"chocolatey".Log().Info(@"
choco uninstall <pkg|all> [pkg2 pkgN] [options/switches]
cuninst <pkg|all> [pkg2 pkgN] [options/switches]
choco-uninst <pkg|all> [pkg2 pkgN] [options/switches]

NOTE: `all` is a special package keyword that will allow you to
uninstall all packages.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ public virtual void help_message(ChocolateyConfiguration configuration)
{
this.Log().Info(ChocolateyLoggers.Important, "Upgrade Command");
this.Log().Info(@"
Upgrades a package or a list of packages. Some may prefer to use `cup`
Upgrades a package or a list of packages. Some may prefer to use `choco-up`
as a shortcut for `choco upgrade`. If you do not have a package
installed, upgrade will install it.

Expand All @@ -282,7 +282,7 @@ prompt. In most cases you can still pass options and switches with one
"chocolatey".Log().Info(ChocolateyLoggers.Important, "Usage");
"chocolatey".Log().Info(@"
choco upgrade <pkg|all> [<pkg2> <pkgN>] [<options/switches>]
cup <pkg|all> [<pkg2> <pkgN>] [<options/switches>]
choco-up <pkg|all> [<pkg2> <pkgN>] [<options/switches>]

NOTE: `all` is a special package keyword that will allow you to upgrade
all currently installed packages.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ namespace chocolatey.infrastructure.app.commands
using logging;
using services;

[CommandFor("version", "[DEPRECATED] will be removed in v1 - use `choco outdated` or `cup <pkg|all> -whatif` instead")]
[CommandFor("version", "[DEPRECATED] will be removed in v1 - use `choco outdated` or `choco-up <pkg|all> -whatif` instead")]
public class ChocolateyVersionCommand : ChocolateyUpgradeCommand
{
private readonly IChocolateyPackageService _packageService;
Expand Down