cookbook 'lxmx_oh_my_zsh', '~> 0.5.0'
lxmx_oh_my_zsh (3) Versions 0.5.0 Follow2
A chef cookbook to install and configure oh-my-zsh
cookbook 'lxmx_oh_my_zsh', '~> 0.5.0', :supermarket
knife supermarket install lxmx_oh_my_zsh
knife supermarket download lxmx_oh_my_zsh
lxmx_oh_my_zsh
Description
This cookbook features:
- A Chef LWRP to install oh-my-zsh for system users.
- A companion recipe for user::data_bag which adds an oh-my-zsh per user installation option.
Usage
Include recipe[lxmx_oh_my_zsh]
in your run_list
and lxmx_oh_my_zsh_user
resource will become available.
The lxmx_oh_my_zsh::data_bag
recipe assumes that you're using the user::data_bag
recipe from the excellent user cookbook. It lets you configure oh-my-zsh installation in user specific data_bags, e.g.
{
"id" : "testman",
"home" : "/home/testman"
...
"oh-my-zsh" : { "enabled": true, "theme": "wedisagree", "plugins": ["git", "rvm"] }
}
Requirements
Platform
This cookbook has been tested with the following OSes:
- centos / redhat
- ubuntu
- gentoo
Cookbooks
The cookbook has got the following dependencies:
Recipes
default
No-op, does nothing.
data_bag
Processes node['users']
and installs oh-my-zsh for the ones whose data_bags enable it, e.g.
{
"id" : "ranger",
...
"oh-my-zsh" : { "enabled": true }
}
Resources and Providers
lxmx_oh_my_zsh_user
Actions
<table>
<thead>
<tr>
<th>Action</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>ensure</td>
<td>
Install only if <code>~/.oh-my-zsh</code> or <code>~/.zshrc</code> is missing.
</td>
<td>Yes</td>
</tr>
<tr>
<td>update</td>
<td>
Install oh-my-zsh into <code>~/.oh-my-zsh</code>, create and populate <code>~/.zshrc</code>.
</td>
<td>No</td>
</tr>
</tbody>
</table>
Attributes
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>login</td>
<td><b>Name attribute:</b> The login of the user.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>home</td>
<td>User's home directory.</td>
<td><code>/home/<i>username</i></code> or <code>/root</code></td>
</tr>
<tr>
<td>theme</td>
<td>Theme to use</td>
<td><code>alanpeabody</code></td>
</tr>
<tr>
<td>plugins</td>
<td>Plugins to enable</td>
<td><code>[]</code></td>
</tr>
<tr>
<td>case_sensitive</td>
<td>Use case sensitive completion</td>
<td><code>false</code></td>
</tr>
<tr>
<td>autocorrect</td>
<td>Use autocorrection feature</td>
<td><code>true</code></td>
</tr>
</tbody>
</table>
Example
lxmx_oh_my_zsh_user 'jessie' do plugins %w{git ruby} autocorrect false case_sensitive true end
License
Copyright:: Vasily Mikhaylichenko and LxMx.
Licensed under BSD license.
http://opensource.org/licenses/BSD-2-Clause
Dependent cookbooks
user >= 0.0.0 |
ark >= 0.0.0 |
zsh >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Collaborator Number Metric
0.5.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.5.0 failed this metric
FC064: Ensure issues_url is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC065: Ensure source_url is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC066: Ensure chef_version is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC069: Ensure standardized license defined in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: lxmx_oh_my_zsh/resources/user.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: lxmx_oh_my_zsh/providers/user.rb:44
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.5.0 passed this metric
Testing File Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.5.0 failed this metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.5.0 failed this metric
FC064: Ensure issues_url is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC065: Ensure source_url is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC066: Ensure chef_version is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC069: Ensure standardized license defined in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: lxmx_oh_my_zsh/resources/user.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: lxmx_oh_my_zsh/providers/user.rb:44
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
No Binaries Metric
0.5.0 passed this metric
Testing File Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.5.0 failed this metric
FC065: Ensure source_url is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC066: Ensure chef_version is set in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC069: Ensure standardized license defined in metadata: lxmx_oh_my_zsh/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: lxmx_oh_my_zsh/resources/user.rb:1
FC085: Resource using new_resource.updated_by_last_action to converge resource: lxmx_oh_my_zsh/providers/user.rb:44
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.5.0 passed this metric
Testing File Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number
0.5.0 failed this metric
0.5.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number