Code conventions - Revision history

Dereckson: /* Salt */ Double quotes

2026-04-03T22:35:38Z

Salt: Double quotes

← Older revision		Revision as of 22:35, 3 April 2026
Line 72:		Line 72:
	== Salt ==		== Salt ==
	=== Style ===		=== Style ===
	Whitespaces:		;Whitespaces
	* Indent with two spaces		* Indent with two spaces
	* YAML lists use indented bullets		* YAML lists use indented bullets
Line 82:		Line 82:
	- otherkey: value		- otherkey: value
	</syntaxhighlight>		</syntaxhighlight>

			;Quotes
			* Use double quotes in Python, Salt and Jinja expressions

	=== Tips ===		=== Tips ===

Dereckson: /* Makefile */

2026-03-20T01:47:16Z

Makefile

@@ Line 116: / Line 116: @@
 ;Templates
 * New command: [https://devcentral.nasqueron.org/source/snippets/browse/main/shell/script.sh shell/script.sh]
 == Makefile ==

Dereckson: /* Shell scripts */

2025-10-11T14:01:22Z

Shell scripts

← Older revision		Revision as of 14:01, 11 October 2025
Line 99:		Line 99:

	== Shell scripts ==		== Shell scripts ==
	UNIX agnosticism:		;UNIX agnosticism:
	* Don't assume absolute path, use <code>#!/usr/bin/env bash</code> and not <code>#!/bin/bash</code> (it could be elsewhere on BSD or Solaris)		* Don't assume absolute path, use <code>#!/usr/bin/env bash</code> and not <code>#!/bin/bash</code> (it could be elsewhere on BSD or Solaris)
	* Use `sh` as must as possible, try to avoid <code>bash</code>, document exceptions rationale in your commits		* Use `sh` as must as possible, try to avoid <code>bash</code>, document exceptions rationale in your commits

	Whitespaces:		;Whitespaces:
	* One whitespace line between shebang and actual content		* One whitespace line between shebang and actual content
	* 4 spaces as indent		* 4 spaces as indent

	File names:		;File names:
	* We use hyphens (-) as separators, not underscores or camelcase		* We use hyphens (-) as separators, not underscores or camelcase
	* Filename should start by a verb if it performs an action		* Filename should start by a verb if it performs an action
Line 113:		Line 113:
	** sometimes you'll see them on Phabricator pastes' titles, but it has been added there, so Phab knows shell syntax highlighting should be used		** sometimes you'll see them on Phabricator pastes' titles, but it has been added there, so Phab knows shell syntax highlighting should be used
	** '''Tip.''' You can use .sh in src/ to help linters, but then provide a Makefile to install it under correct name without extension. Same for operations repository where everything uses .sh, but when deploying with file.managed the extension is omitted		** '''Tip.''' You can use .sh in src/ to help linters, but then provide a Makefile to install it under correct name without extension. Same for operations repository where everything uses .sh, but when deploying with file.managed the extension is omitted

			;Templates
			* New command: [https://devcentral.nasqueron.org/source/snippets/browse/main/shell/script.sh shell/script.sh]

	== Makefile ==		== Makefile ==

Dereckson: /* Python */ Templates

2025-10-11T13:52:47Z

Python: Templates

← Older revision		Revision as of 13:52, 11 October 2025
Line 44:		Line 44:

	'''2015.''' We follow [https://www.python.org/dev/peps/pep-0008/ PEP-8].		'''2015.''' We follow [https://www.python.org/dev/peps/pep-0008/ PEP-8].

			=== Templates ===
			A template exists for a new Python command: [https://devcentral.nasqueron.org/source/snippets/browse/main/python/command.py python/command.py]

			In packages, empty __init__.py files can follow [https://devcentral.nasqueron.org/source/merge-dictionaries/browse/main/src/mergedictionaries/utils/__init__.py;eaf5bc2c21118454837e8148147606c19d4afff7 this example].

	=== Configuration files ===		=== Configuration files ===

Dereckson: /* Rust */

2025-09-26T00:18:24Z

Rust

← Older revision		Revision as of 00:18, 26 September 2025
Line 59:		Line 59:

	Use trailing comma for elements in every struct/impl/etc.		Use trailing comma for elements in every struct/impl/etc.

			=== Threads ===
			Standard library isn't the most ergonomic for threads programming, those crate allows more efficient and legible code:
			* [https://docs.rs/crossbeam-channel/latest/crossbeam_channel/ crossbeam_channel] for mpmc (multiple producers, multiple consumers)
			* [https://docs.rs/parking_lot/latest/parking_lot/type.Mutex.html parking_lot] for Mutex

	== Salt ==		== Salt ==

Dereckson: /* Python */

2025-09-25T17:05:51Z

Python

← Older revision		Revision as of 17:05, 25 September 2025
Line 40:		Line 40:

	== Python ==		== Python ==
			=== Code style ===
	'''2023.''' We follow [https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html black style], so use black utility (<code>pip install black</code>). As such, you need to configure Flake8 to ignore rule E203.		'''2023.''' We follow [https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html black style], so use black utility (<code>pip install black</code>). As such, you need to configure Flake8 to ignore rule E203.

	'''2015.''' We follow [https://www.python.org/dev/peps/pep-0008/ PEP-8].		'''2015.''' We follow [https://www.python.org/dev/peps/pep-0008/ PEP-8].

			=== Configuration files ===
			Allow empty configuration files. For example, the YAML parser will return None if the file exists but is empty, we can catch that and return default instead:

			<syntaxhighlight lang="python">
			with open(get_configuration_path()) as fd:
			return yaml.safe_load(fd) or {}
			</syntaxhighlight>

	== Rust ==		== Rust ==

Dereckson: /* Shell scripts */ tab -> 4 spaces (de facto modern practice of Nasqueron scripts for a while)

2025-09-15T21:46:12Z

Shell scripts: tab -> 4 spaces (de facto modern practice of Nasqueron scripts for a while)

← Older revision		Revision as of 21:46, 15 September 2025
Line 86:		Line 86:
	Whitespaces:		Whitespaces:
	* One whitespace line between shebang and actual content		* One whitespace line between shebang and actual content
	* ~~Indent with tabulations~~		* 4 spaces as indent

	File names:		File names:
	* We use hyphens (-) as separators, not underscores or camelcase.		* We use hyphens (-) as separators, not underscores or camelcase
	* Filename should start by a verb if it performs an action		* Filename should start by a verb if it performs an action
	* Don't use .sh extensions (sometimes you'll see them on Phabricator pastes' titles, but it has been added there, so Phab knows shell syntax highlighting should be used)		* Don't use .sh extensions when deployed as command
	** '''Tip.''' You can use .sh in src/ to help linters, but then provide a Makefile to install it under correct name without extension		** sometimes you'll see them on Phabricator pastes' titles, but it has been added there, so Phab knows shell syntax highlighting should be used
			** '''Tip.''' You can use .sh in src/ to help linters, but then provide a Makefile to install it under correct name without extension. Same for operations repository where everything uses .sh, but when deploying with file.managed the extension is omitted

	== Makefile ==		== Makefile ==

Dereckson at 21:37, 24 October 2024

2024-10-24T21:37:40Z

← Older revision		Revision as of 21:37, 24 October 2024
Line 136:		Line 136:

	[[Category:Reference]]		[[Category:Reference]]
			[[Category:Contributor guide]]

Dereckson: /* PHP */

2023-07-02T08:15:17Z

PHP

← Older revision		Revision as of 08:15, 2 July 2023
Line 23:		Line 23:
	* Arrays use short syntax		* Arrays use short syntax
	* Array elements ends with a comma		* Array elements ends with a comma
			* Functions, methods and class names use camel case

	If you use PhpStorm or another JetBrains IDE, you can import [https://github.com/nasqueron/codestyle/blob/master/JetBrains/php-codestyle.xml JetBrains/php-codestyle.xml] from the codestyle repository as a code style (Settings or Default Settings > Editor > Code Style > PHP > click on the wheel icon > Import Scheme > Intellij IDEA codestyle XML).		If you use PhpStorm or another JetBrains IDE, you can import [https://github.com/nasqueron/codestyle/blob/master/JetBrains/php-codestyle.xml JetBrains/php-codestyle.xml] from the codestyle repository as a code style (Settings or Default Settings > Editor > Code Style > PHP > click on the wheel icon > Import Scheme > Intellij IDEA codestyle XML).

Dereckson: /* Makefile */

2023-06-05T23:36:43Z

Makefile

← Older revision		Revision as of 23:36, 5 June 2023
Line 99:		Line 99:
	Presentation:		Presentation:
	* Create a block with the general targets, then sections with your targets organized by categories/goals/parts		* Create a block with the general targets, then sections with your targets organized by categories/goals/parts

			Tip:
			* It's possible to provision BSDmakefile and GNUmakefile when UNIX agnosticism doesn't work.

	== Structured data formats (YAML, JSON, XML) ==		== Structured data formats (YAML, JSON, XML) ==