├── lib
    └── main.coffee
├── CHANGELOG.md
├── package.json
├── LICENSE.md
├── README.md
└── snippets
    ├── odoo-python-snippets.cson
    └── odoo-xml-snippets.cson


/lib/main.coffee:
--------------------------------------------------------------------------------
1 | module.exports =
2 |   activate: (state) ->
3 | 
4 |   deactivate: ->
5 | 
6 |   serialize: ->
7 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | ## 0.4.0
 2 | 
 3 | * Change prefix to `odoo_`
 4 | 
 5 | ## 0.3.2
 6 | 
 7 | * Fix HTML field (issue #6)
 8 | 
 9 | ## 0.3.1
10 | 
11 | * Minor fix
12 | 
13 | ## 0.3.0
14 | 
15 | * Global improvements for Python snippets (placeholders, better relational fields...)
16 | 
17 | ## 0.2.0
18 | 
19 | * Remove useless xpath
20 | 
21 | ## 0.1.0
22 | 
23 | * Initial release
24 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "odoo-snippets",
 3 |   "main": "./lib/main",
 4 |   "version": "0.5.0",
 5 |   "description": "Snippets for the Odoo software development",
 6 |   "keywords": [
 7 |     "snippets",
 8 |     "odoo",
 9 |     "python",
10 |     "xml"
11 |   ],
12 |   "activationCommands": {},
13 |   "repository": "https://github.com/DocMarty84/atom-odoo-snippets",
14 |   "license": "MIT",
15 |   "engines": {
16 |     "atom": ">0.50.0"
17 |   },
18 |   "dependencies": {}
19 | }
20 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 Nicolas Martinelli
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # atom-odoo-snippets
 2 | 
 3 | Add snippets for the Odoo software development to the Atom editor. Snippets are
 4 | provided for Python and XML sources. All snippets start with prefix 'odoo_'.
 5 | 
 6 | Python snippets:
 7 | - Create new Odoo object
 8 | - Inherit/Extend existing Odoo object
 9 | - Add new field of type Integer, Char, Text, Many2one, One2many, Many2many,
10 | Boolean, HTML, Float, Date, DateTime, Selection, Binary
11 | - Call to search and name_search
12 | - Create method for compute, onchange, constrains
13 | - Add a computed field with appropriate methods
14 | 
15 | XML snippets:
16 | - Create the main tags
17 | - Create Form/Tree/Search view
18 | - Inherit existing Form/Tree/Search view
19 | - Add Form's header with 'state' and buttons
20 | - Create action
21 | - Create menu item for any of the 3 levels (upper bar, category, action)
22 | - Add nested groups, notebook and page, page
23 | - Add domain to a field
24 | - Create security category
25 | - Create group, then assign new permissions
26 | - Create security rules
27 | - Create workflow
28 | - Add transition or activity to an existing workflow
29 | - Add social messaging and followers
30 | 
31 | Inspired by the project odoo-pycharm-templates:
32 | https://github.com/mohamedmagdy/odoo-pycharm-templates
33 | 


--------------------------------------------------------------------------------
/snippets/odoo-python-snippets.cson:
--------------------------------------------------------------------------------
  1 | '.source.python':
  2 | 
  3 | # Odoo objects
  4 | 
  5 | 	'Create New Odoo Object':
  6 | 		'prefix': 'odoo_object'
  7 | 		'body': """
  8 | 			class ${10:NewModule}(models.Model):
  9 | 				_name = "${20:module.name}"
 10 | 				_rec_name = "${30:module.rec_name}" # optional
 11 | 				_description = "${40:Module description}"
 12 | 				_order = "${50:field1}, ${60:field2}, " # optional
 13 | 
 14 | 				name = fields.Char()$70
 15 | 		"""
 16 | 
 17 | 	'Inherit/Extend Existing Odoo Object':
 18 | 		'prefix': 'odoo_object_inherit'
 19 | 		'body': """
 20 | 			class ${10:NewModule}(models.Model):
 21 | 				_name = "${20:module.name}" # optional
 22 | 				_inherit = "${30:module.name}"
 23 | 
 24 | 				name = fields.Char()$40
 25 | 		"""
 26 | 
 27 | # Odoo fields
 28 | 
 29 | 	'Integer Field':
 30 | 		'prefix': 'odoo_field_integer'
 31 | 		'body': '${5:new_field} = fields.Integer(string="${10:Field name}", )'
 32 | 
 33 | 	'Float Field':
 34 | 		'prefix': 'odoo_field_float'
 35 | 		'body': '${5:new_field} = fields.Float(string="${10:Field name}", )'
 36 | 
 37 | 	'Char Field':
 38 | 		'prefix': 'odoo_field_char'
 39 | 		'body': '${5:new_field} = fields.Char(string="${10:Field name}", )'
 40 | 
 41 | 	'Text Field':
 42 | 		'prefix': 'odoo_field_text'
 43 | 		'body': '${5:new_field} = fields.Text(string="${10:Field name}", )'
 44 | 
 45 | 	'Many2one Field':
 46 | 		'prefix': 'odoo_field_many2one'
 47 | 		'body': '''
 48 | 			${10:new_field_id} = fields.Many2one(
 49 | 				string="${20:Field name}",
 50 | 				comodel_name="${30:res.partner}",
 51 | 				domain="[('${40:field}', '${41:=}', ${42:other})]",
 52 | 				context={"${50:key}": ${51:"value"}\\},
 53 | 				ondelete="${60:set null}",
 54 | 				help="${70:Explain your field}.",
 55 | 			)$80
 56 | 			'''
 57 | 
 58 | 	'One2many Field':
 59 | 		'prefix': 'odoo_field_one2many'
 60 | 		'body': '''
 61 | 			${10:new_field_ids} = fields.One2many(
 62 | 				string="${20:Field name}",
 63 | 				comodel_name="${30:res.partner}",
 64 | 				inverse_name="${40:inverse_name_id}",
 65 | 				domain="[('${50:field}', '${51:=}', ${52:other})]",
 66 | 				context={"${60:key}": ${61:"value"}\\},
 67 | 				help="${70:Explain your field}.",
 68 | 			)$80
 69 | 			'''
 70 | 
 71 | 	'Many2many Field':
 72 | 		'prefix': 'odoo_field_many2many'
 73 | 		'body': '''
 74 | 			${10:new_field_ids} = fields.Many2many(
 75 | 				string="${20:Field name}",
 76 | 				comodel_name="${30:res.partner}",
 77 | 				relation="${40:relation_table_name}",
 78 | 				column1="${50:column_this}",
 79 | 				column2="${60:column_other}",
 80 | 				domain="[('${70:field}', '${71:=}', ${72:other})]",
 81 | 				context={"${80:key}": ${81:"value"}\\},
 82 | 				help="${90:Explain your field}.",
 83 | 			)$100
 84 | 			'''
 85 | 
 86 | 	'Boolean Field':
 87 | 		'prefix': 'odoo_field_boolean'
 88 | 		'body': '${5:is_new_field} = fields.Boolean(string="${10:Field name}", )'
 89 | 
 90 | 	'HTML Field':
 91 | 		'prefix': 'odoo_field_html'
 92 | 		'body': '${5:new_field} = fields.Html(string="${10:Field name}", )'
 93 | 
 94 | 	'Date Field':
 95 | 		'prefix': 'odoo_field_date'
 96 | 		'body': '${5:new_field} = fields.Date(string="${10:Field name}", )'
 97 | 
 98 | 	'DateTime Field':
 99 | 		'prefix': 'odoo_field_datetime'
100 | 		'body': '${5:new_field} = fields.Datetime(string="${10:Field name}", )'
101 | 
102 | 	'Selection Field':
103 | 		'prefix': 'odoo_field_selection'
104 | 		'body': '''
105 | 			${5:new_field} = fields.Selection(
106 | 				string="${10:Field name}",
107 | 				selection=[
108 | 						(\'${20:value1}\', \'${21:description1}\'),
109 | 						(\'${30:value2}\', \'${31:description2}\'),
110 | 				],$40
111 | 			)$50
112 | 			'''
113 | 
114 | 	'Binary Field':
115 | 		'prefix': 'odoo_field_binary'
116 | 		'body': '${5:new_field} = fields.Binary(string="${10:Field name}", )'
117 | 
118 | # Call to common Odoo methods
119 | 
120 | 	'Search':
121 | 		'prefix': 'odoo_search'
122 | 		'body': 'self.search([(\'$1\', \'=\', $2), ...], offset=0, limit=None, order=None, count=False)'
123 | 
124 | 	'Name search':
125 | 		'prefix': 'odoo_search_name'
126 | 		'body': 'self.name_search(name=\'$1\', args=None, operator=\'ilike\', limit=100)'
127 | 
128 | # Creation of common Odoo methods
129 | 
130 | 	'Compute method':
131 | 		'prefix': 'odoo_method_compute'
132 | 		'body': """
133 | 			@api.multi
134 | 			@api.depends("${10:field1}", "${20:field2}", )
135 | 			def _compute_${30:field}(self):
136 | 				for s in self:
137 | 					${40:pass}
138 | 		"""
139 | 
140 | 	'Onchange method':
141 | 		'prefix': 'odoo_onchange_method'
142 | 		'body': """
143 | 			@api.onchange("${10:field1}", "${20:field2}", )
144 | 			def _onchange_${30:field}(self):
145 | 				vals = {}
146 | 
147 | 				# Remove warning if necessary
148 | 				vals['warning'] = {
149 | 					'title': _('$40')
150 | 					'message': _('$50')
151 | 				}
152 | 
153 | 				# Remove domain if necessary
154 | 				vals['domain'] = {
155 | 					"${60:field}": [("$61", "${62:=}", ${63:value})],
156 | 				}
157 | 
158 | 				return vals$70
159 | 		"""
160 | 
161 | 	'Constrains method':
162 | 		'prefix': 'odoo_constrains_method'
163 | 		'body': """
164 | 			@api.multi
165 | 			@api.constrains("${10:field1}", "${20:field2}", )
166 | 			def _check_${30:field}(self):
167 | 				for s in self:
168 | 					if s.${40:field} == ${50:value}:
169 | 						raise ValidationError(_("$60"))$70
170 | 			"""
171 | 
172 | # Complex Odoo fields
173 | 
174 | 	'Compute field':
175 | 		'prefix': 'ododoo_field_compute'
176 | 		'body': """
177 | 			${10:new_field} = fields.${20:Float}(
178 | 				string="${30:Field string}",
179 | 				compute='_compute_${10:new_field}',
180 | 				inverse='_inverse_${10:new_field}',
181 | 				search='_search_${10:new_field}',
182 | 				help="$50",
183 | 			)
184 | 
185 | 			@api.multi
186 | 			@api.depends("${60:field1}", "${70:field2}", )
187 | 			def _compute_${10:new_field}(self):
188 | 				for s in self:
189 | 					${80:pass}
190 | 
191 | 			@api.multi
192 | 			def _inverse_${10:new_field}(self):
193 | 				for s in self:
194 | 					${90:pass}
195 | 
196 | 			@api.multi
197 | 			def _search_${10:new_field}(self, operator, value):
198 | 				if operator == 'like':
199 | 					operator = 'ilike'
200 | 				return [('${100:new_field}', operator, value)]}
201 | 			"""
202 | 


--------------------------------------------------------------------------------
/snippets/odoo-xml-snippets.cson:
--------------------------------------------------------------------------------
  1 | '.text.xml':
  2 | 	'Create the main tags':
  3 | 		'prefix': 'odoo_data'
  4 | 		'body': """
  5 | 		<?xml version="1.0" encoding="utf-8"?>
  6 | 		<odoo>
  7 | 			$1
  8 | 		</odoo>
  9 | 		"""
 10 | 
 11 | # Form, tree and search view creation
 12 | 
 13 | 	'Create form view':
 14 | 		'prefix': 'odoo_form'
 15 | 		'body': """
 16 | 			<record id="$1_view_form" model="ir.ui.view">
 17 | 				<field name="name">$2.form</field>
 18 | 				<field name="model">$2</field>
 19 | 				<field name="arch" type="xml">
 20 | 					<form string="$3">
 21 | 						<sheet>
 22 | 							<group>
 23 | 								<field name="$4"/>
 24 | 							</group>
 25 | 						</sheet>
 26 | 					</form>
 27 | 				</field>
 28 | 			</record>
 29 | 		"""
 30 | 
 31 | 	'Create tree view':
 32 | 		'prefix': 'odoo_tree'
 33 | 		'body': """
 34 | 			<record id="$1_view_tree" model="ir.ui.view">
 35 | 				<field name="name">$2.tree</field>
 36 | 				<field name="model">$2</field>
 37 | 				<field name="arch" type="xml">
 38 | 					<tree string="$3">
 39 | 						<field name="$4"/>
 40 | 					</tree>
 41 | 				</field>
 42 | 			</record>
 43 | 		"""
 44 | 
 45 | 	'Create search view':
 46 | 		'prefix': 'odoo_search'
 47 | 		'body': """
 48 | 			<record id="$1_view_search" model="ir.ui.view">
 49 | 				<field name="name">$2.search</field>
 50 | 				<field name="model">$2</field>
 51 | 				<field name="arch" type="xml">
 52 | 					<search string="$3">
 53 | 						<field name="$4"/>
 54 | 						<filter name="$5" string="$6" domain="[(\'$7\', \'=\', $8), ]"/>
 55 | 						<group string="Group By">
 56 | 							<filter name="$9" string="$10" domain="[]"  context="{'group_by':\'$11\'}"/>
 57 | 						</group>
 58 | 					</search>
 59 | 				</field>
 60 | 			</record>
 61 | 		"""
 62 | 
 63 | 	'Inherit existing form view':
 64 | 		'prefix': 'odoo_form_inherit'
 65 | 		'body': """
 66 | 			<!-- Inherit Form view -->
 67 | 			<record id="$1" model="ir.ui.view">
 68 | 				<field name="name">$2.form</field>
 69 | 				<field name="model">$2</field>
 70 | 				<field name="inherit_id" ref="$3"/>
 71 | 				<field name="arch" type="xml">
 72 | 					<field name="$4" position="$5">
 73 | 						<!-- Add your fields or attributes here -->
 74 | 					</field>
 75 | 				</field>
 76 | 			</record>
 77 | 		"""
 78 | 
 79 | 	'Inherit existing tree view':
 80 | 		'prefix': 'odoo_tree_inherit'
 81 | 		'body': """
 82 | 			<record id="$1" model="ir.ui.view">
 83 | 				<field name="name">$2.tree</field>
 84 | 				<field name="model">$2</field>
 85 | 				<field name="inherit_id" ref="$3"/>
 86 | 				<field name="arch" type="xml">
 87 | 					<field name="$4" position="$5">
 88 | 						<!-- Add new fields here -->
 89 | 					</field>
 90 | 				</field>
 91 | 			</record>
 92 | 		"""
 93 | 
 94 | 	'Inherit existing search view':
 95 | 		'prefix': 'odoo_search_inherit'
 96 | 		'body': """
 97 | 			<record id="$1" model="ir.ui.view">
 98 | 				<field name="name">$2.search</field>
 99 | 				<field name="model">$2</field>
100 | 				<field name="inherit_id" ref="$3"/>
101 | 				<field name="arch" type="xml">
102 | 					<field name="$4" position="$5">
103 | 						<!-- Add new fields or filters here -->
104 | 					</field>
105 | 				</field>
106 | 			</record>
107 | 		"""
108 | 
109 | 	'Add Form\'s header with \'state\' and buttons':
110 | 		'prefix': 'odoo_form_header'
111 | 		'body': """
112 | 			<header>
113 | 				<button name="$1" string="$2" class="oe_highlight" states="$3" type="$4"/>
114 | 				<field name="state" widget="statusbar" statusbar_visible="$5" statusbar_colors="{'KEY_IS_STATE':'VALUE_IS_COLOR'}"/>
115 | 			</header>
116 | 		"""
117 | 
118 | # Action
119 | 
120 | 	'Create new action':
121 | 		'prefix': 'odoo_action'
122 | 		'body': """
123 | 			<record id="$1_action_form" model="ir.actions.act_window">
124 | 				<field name="name">$2</field>
125 | 				<field name="res_model">$3</field>
126 | 				<field name="view_mode">tree,form</field>
127 | 				<field name="help" type="html">
128 | 					<p class="oe_view_nocontent_create">
129 | 						<!-- Add Text Here -->
130 | 					</p>
131 | 					<p>
132 | 						<!-- More details about what a user can do -->
133 | 					</p>
134 | 				</field>
135 | 			</record>
136 | 		"""
137 | 
138 | # Menuitem
139 | 
140 | 	'Create menu item in the upper bar':
141 | 		'prefix': 'odoo_menuitem_root'
142 | 		'body': '<menuitem id="menu_$1" name="$2" sequence="$3"/>'
143 | 
144 | 	'Create menu item for category':
145 | 		'prefix': 'odoo_menuitem_category'
146 | 		'body': '<menuitem id="menu_$1" name="$2" parent="$3" sequence="$4"/>'
147 | 
148 | 	'Create menu item for actions':
149 | 		'prefix': 'odoo_menuitem_action'
150 | 		'body': '<menuitem id="menu_$1" name="$2" parent="$3" action="$4" sequence="$5"/>'
151 | 
152 | # Common structures
153 | 
154 | 	'Add nested groups':
155 | 		'prefix': 'odoo_nested_group'
156 | 		'body': """
157 | 			<group string="$1">
158 | 				<group>
159 | 					<field name="$2"/>
160 | 				</group>
161 | 				<group>
162 | 					<field name="$3"/>
163 | 				</group>
164 | 			</group>
165 | 		"""
166 | 
167 | 	'Add notebook and a page':
168 | 		'prefix': 'odoo_notebook'
169 | 		'body': """
170 | 			<notebook>
171 | 				<page string="$1">
172 | 					<group>
173 | 						<field name="$2"/>
174 | 					</group>
175 | 				</page>
176 | 			</notebook>
177 | 		"""
178 | 
179 | 	'Add page':
180 | 		'prefix': 'odoo_page'
181 | 		'body': """
182 | 			<page string="$1">
183 | 				<group>
184 | 					<field name="$2"/>
185 | 				</group>
186 | 			</page>
187 | 		"""
188 | 
189 | 	'Add domain to a field':
190 | 		'prefix': 'odoo_domain'
191 | 		'body': 'domain="[(\'$1\', \'=\', $2), ]"'
192 | 
193 | # Security
194 | 
195 | 	'Create security category':
196 | 		'prefix': 'odoo_security_category'
197 | 		'body': """
198 | 		    <record id="module_category_$1" model="ir.module.category">
199 | 				<field name="name">$2</field>
200 | 				<field name="sequence">$3</field>
201 | 		    </record>
202 | 		"""
203 | 
204 | 	'Create group, then assign new permissions':
205 | 		'prefix': 'odoo_security_group'
206 | 		'body': """
207 | 			<record id="group_$1" model="res.groups">
208 | 				<field name="name">$2</field>
209 | 				<field name="category_id" ref="$3"/>
210 | 				<field name="implied_ids" eval="[(4, ref('base.group_user'))]"/>
211 | 			</record>
212 | 		"""
213 | 
214 | 	'Create security rules':
215 | 		'prefix': 'odoo_security_rule'
216 | 		'body': """
217 | 			<record id="rule_$1" model="ir.rule">
218 | 				<field name="name">$2</field>
219 | 				<field name="model_id" ref="model_$3"/>
220 | 				<field name="domain_force">[(\'$4\', \'=\', $5), ]</field>
221 | 				<field name="perm_write" eval="1"/>
222 | 				<field name="perm_create" eval="1"/>
223 | 				<field name="perm_read" eval="1"/>
224 | 				<field name="perm_unlink" eval="1"/>
225 | 				<!-- You can attach this rule to a specific group, or make it global -->
226 | 				<field name="groups" eval="[(4, ref('group_id'))]"/>
227 | 				<!--<field name="global" eval="1"/> -->
228 | 			</record>
229 | 		"""
230 | 
231 | # Workflow
232 | 
233 | 	'Create workflow':
234 | 		'prefix': 'odoo_wkf'
235 | 		'body': """
236 | 			<record id="wkf_$1" model="workflow">
237 | 				<field name="name">$2</field>
238 | 				<field name="osv">$3</field>
239 | 				<field name="on_create">True</field>
240 | 			</record>
241 | 		"""
242 | 
243 | 	'Add transition to workflow':
244 | 		'prefix': 'odoo_wkf_transition'
245 | 		'body': """
246 | 			<record id="trans_$1" model="workflow.transition">
247 | 				<field name="act_from" ref="$2"/>
248 | 				<field name="act_to" ref="$3"/>
249 | 				<field name="signal">$4</field>
250 | 			</record>
251 | 		"""
252 | 
253 | 	'Add activity to workflow':
254 | 		'prefix': 'odoo_wkf_activity'
255 | 		'body': """
256 | 			<record id="act_$1" model="workflow.activity">
257 | 				<field name="wkf_id" ref="$2"/>
258 | 				<field name="name">$3</field>
259 | 				<!--<field name="flow_start">True</field>-->
260 | 				<!--<field name="flow_stop">True</field>-->
261 | 				<field name="kind">function</field>
262 | 				<field name="action">$4</field>
263 | 			</record>
264 | 		"""
265 | 
266 | # Misc
267 | 
268 | 	'Add Social Messaging and followers':
269 | 		'prefix': 'odoo_form_social'
270 | 		'body': """
271 | 			<div class="oe_chatter">
272 | 				<field name="message_follower_ids" widget="mail_followers"/>
273 | 				<field name="message_ids" widget="mail_thread"/>
274 | 			</div>
275 | 		"""
276 | 


--------------------------------------------------------------------------------