vscode-chef/snippets/chef_metadata.json at main · chef/vscode-chef · GitHub

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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
{
	"chef_version": {
		"prefix": "chef_version",
		"scope": "source.chef.metadata",
		"body": "chef_version '${1:>=} ${2:15.0}'",
		"description": "A range of Chef Infra Client versions that are supported by this cookbook."
	},
	"depends": {
		"prefix": "depends",
		"scope": "source.chef.metadata",
		"body": "depends '${1:apache2}', '${2:<} ${3:1.0}'",
		"description": "This field requires that a cookbook with a matching name and version exists on the Chef Infra Server. When the match exists, the Chef server includes the dependency as part of the set of cookbooks that are sent to the node when the Chef Infra Client runs. It is very important that the depends field contain accurate data. If a dependency statement is inaccurate, the Chef Infra Client may not be able to complete the configuration of the system."
	},
	"description": {
		"prefix": "description",
		"scope": "source.chef.metadata",
		"body": "description '${1:A fancy cookbook that manages a herd of cats!}'",
		"description": "A short description of a cookbook and its functionality.\nThis description is also shown at the Chef Supermarket."
	},
	"gem": {
		"prefix": "gem",
		"scope": "source.chef.metadata",
		"body": "gem '${1:rest-client}'",
		"description": "Specifies a gem dependency to be installed via the chef_gem resource after all cookbooks are synchronized, but before any other cookbook loading is done. Use this attribute once per gem dependency."
	},
	"issues_url": {
		"prefix": "issues_url",
		"scope": "source.chef.metadata",
		"body": "issues_url '${1:https://github.com/johndoe/mycookbook/issues}'",
		"description": "The URL for the location in which a cookbook’s issue tracking is maintained. This setting is also used by Chef Supermarket. In Chef Supermarket, this value is used to define the destination for the 'View Issues' link."
	},
	"license": {
		"prefix": "license",
		"scope": "source.chef.metadata",
		"body": "license '${1:All Rights Reserved}'",
		"description": "The type of license under which a cookbook is distributed: Apache v2.0, GPL v2, GPL v3, MIT, or license 'Proprietary - All Rights Reserved (default). Please be aware of the licenses for files inside of a cookbook and be sure to follow any restrictions they describe."
	},
	"maintainer": {
		"prefix": "maintainer",
		"scope": "source.chef.metadata",
		"body": "maintainer '${1:John Doe}'",
		"description": "The name of the person responsible for maintaining a cookbook, either an individual or an organization."
	},
	"maintainer_email": {
		"prefix": "maintainer_email",
		"scope": "source.chef.metadata",
		"body": "maintainer_email '${1:john_doe@example.com}'",
		"description": "The email address for the person responsible for maintaining a cookbook. Only one email can be listed here, so if this needs to be forwarded to multiple people consider using an email address that is already setup for mail forwarding."
	},
	"name": {
		"prefix": "name",
		"scope": "source.chef.metadata",
		"body": "name '${1:cats}'",
		"description": "Required. The name of the cookbook."
	},
	"ohai_version": {
		"prefix": "ohai_version",
		"scope": "source.chef.metadata",
		"body": "ohai_version '${1:>=} ${2:13}'",
		"description": "A range of Ohai versions that are supported by this cookbook."
	},
	"privacy": {
		"prefix": "privacy",
		"scope": "source.chef.metadata",
		"body": "privacy",
		"description": "Specify that a cookbook is private."
	},
	"source_url": {
		"prefix": "source_url",
		"scope": "source.chef.metadata",
		"body": "source_url '${1:https://github.com/johndoe/mycookbook}'",
		"description": "The URL for the location in which a cookbook’s source code is maintained. This setting is also used by Chef Supermarket. In Chef Supermarket, this value is used to define the destination for the 'View Source' link."
	},
	"supports": {
		"prefix": "supports OS",
		"scope": "source.chef.metadata",
		"body": "supports '${1:redhat}'",
		"description": "Show that a cookbook has a supported platform."
	},
	"version": {
		"prefix": "version",
		"scope": "source.chef.metadata",
		"body": "version '${0:2.0.0}'",
		"description": "The current version of a cookbook. Version numbers always follow a simple three-number version sequence."
	}
}