oliverdavies.uk/content/node.c99cc7ef-20b0-4743-9638-61cb4beeb5ec.yml

85 lines
3.2 KiB
YAML
Raw Normal View History

2025-07-10 00:14:12 +01:00
uuid:
- value: c99cc7ef-20b0-4743-9638-61cb4beeb5ec
langcode:
- value: en
type:
- target_id: daily_email
target_type: node_type
target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
revision_timestamp:
- value: '2025-05-11T09:00:12+00:00'
revision_uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
revision_log: { }
status:
- value: true
uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
title:
- value: 'Why I use long parameter names in scripts'
created:
- value: '2024-05-23T00:00:00+00:00'
changed:
- value: '2025-05-11T09:00:12+00:00'
promote:
- value: false
sticky:
- value: false
default_langcode:
- value: true
revision_translation_affected:
- value: true
path:
- alias: /daily/2024/05/23/why-i-use-long-parameter-names-in-scripts
langcode: en
body:
- value: |
<p>The other day, <a href="/daily/2024/05/21/which-commit-has-the-largest-message">I posted about a script I'd written</a> that found the longest commit message in a repository.</p>
<p>As I couldn't find a native way to do this with Git, the script loops over each commit in the repository, calculates its length and stores the length and commit SHA in a file.</p>
<p>The lines in the file are sorted so the longest commit is first.</p>
<p>Whilst I commonly use short parameters, such as <code>git add -p</code> when typing commands, in scripts, I prefer to use the equivalent longer parameters, where possible.</p>
<p>For example, in the script, I execute this command to sort the lines:</p>
<pre><code class="bash">sort "${result_file}" --reverse --numeric-sort --output "${result_file}"
</code></pre>
<p>This could be re-written as:</p>
<pre><code class="bash">sort "${result_file}" -rn -o "${result_file}"
</code></pre>
<p>Whilst the original is more verbose and longer to type, I prefer its verbosity which makes it easier for me or others to read and understand in the future.</p>
format: full_html
processed: |
2025-07-16 12:00:00 +01:00
<p>The other day, <a href="/daily/2024/05/21/which-commit-has-the-largest-message">I posted about a script I'd written</a> that found the longest commit message in a repository.</p>
2025-07-10 00:14:12 +01:00
<p>As I couldn't find a native way to do this with Git, the script loops over each commit in the repository, calculates its length and stores the length and commit SHA in a file.</p>
<p>The lines in the file are sorted so the longest commit is first.</p>
<p>Whilst I commonly use short parameters, such as <code>git add -p</code> when typing commands, in scripts, I prefer to use the equivalent longer parameters, where possible.</p>
<p>For example, in the script, I execute this command to sort the lines:</p>
<pre><code class="bash">sort "${result_file}" --reverse --numeric-sort --output "${result_file}"
</code></pre>
<p>This could be re-written as:</p>
<pre><code class="bash">sort "${result_file}" -rn -o "${result_file}"
</code></pre>
<p>Whilst the original is more verbose and longer to type, I prefer its verbosity which makes it easier for me or others to read and understand in the future.</p>
summary: null
field_daily_email_cta: { }