DevOrSysAdminScripts/README.html at main · LLyaudet/DevOrSysAdminScripts · 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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="generator" content="pandoc">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
  <title>DevOrSysAdminScripts</title>
  <style>
    html {
      color: #1a1a1a;
      background-color: #fdfdfd;
    }
    body {
      margin: 0 auto;
      max-width: 36em;
      padding-left: 50px;
      padding-right: 50px;
      padding-top: 50px;
      padding-bottom: 50px;
      hyphens: auto;
      overflow-wrap: break-word;
      text-rendering: optimizeLegibility;
      font-kerning: normal;
    }
    @media (max-width: 600px) {
      body {
        font-size: 0.9em;
        padding: 12px;
      }
      h1 {
        font-size: 1.8em;
      }
    }
    @media print {
      html {
        background-color: white;
      }
      body {
        background-color: transparent;
        color: black;
        font-size: 12pt;
      }
      p, h2, h3 {
        orphans: 3;
        widows: 3;
      }
      h2, h3, h4 {
        page-break-after: avoid;
      }
    }
    p {
      margin: 1em 0;
    }
    a {
      color: #1a1a1a;
    }
    a:visited {
      color: #1a1a1a;
    }
    img {
      max-width: 100%;
    }
    svg {
      height: auto;
      max-width: 100%;
    }
    h1, h2, h3, h4, h5, h6 {
      margin-top: 1.4em;
    }
    h5, h6 {
      font-size: 1em;
      font-style: italic;
    }
    h6 {
      font-weight: normal;
    }
    ol, ul {
      padding-left: 1.7em;
      margin-top: 1em;
    }
    li > ol, li > ul {
      margin-top: 0;
    }
    blockquote {
      margin: 1em 0 1em 1.7em;
      padding-left: 1em;
      border-left: 2px solid #e6e6e6;
      color: #606060;
    }
    code {
      font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
      font-size: 85%;
      margin: 0;
      hyphens: manual;
      white-space: pre-wrap;
    }
    pre {
      margin: 1em 0;
      overflow: auto;
    }
    pre code {
      padding: 0;
      overflow: visible;
      overflow-wrap: normal;
    }
    .sourceCode {
     background-color: transparent;
     overflow: visible;
    }
    hr {
      background-color: #1a1a1a;
      border: none;
      height: 1px;
      margin: 1em 0;
    }
    table {
      margin: 1em 0;
      border-collapse: collapse;
      width: 100%;
      overflow-x: auto;
      display: block;
      font-variant-numeric: lining-nums tabular-nums;
    }
    table caption {
      margin-bottom: 0.75em;
    }
    tbody {
      margin-top: 0.5em;
      border-top: 1px solid #1a1a1a;
      border-bottom: 1px solid #1a1a1a;
    }
    th {
      border-top: 1px solid #1a1a1a;
      padding: 0.25em 0.5em 0.25em 0.5em;
    }
    td {
      padding: 0.125em 0.5em 0.25em 0.5em;
    }
    header {
      margin-bottom: 4em;
      text-align: center;
    }
    #TOC li {
      list-style: none;
    }
    #TOC ul {
      padding-left: 1.3em;
    }
    #TOC > ul {
      padding-left: 0;
    }
    #TOC a:not(:hover) {
      text-decoration: none;
    }
    span.smallcaps{font-variant: small-caps;}
    div.columns{display: flex; gap: min(4vw, 1.5em);}
    div.column{flex: auto; overflow-x: auto;}
    div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
    /* The extra [class] is a hack that increases specificity enough to
       override a similar rule in reveal.js */
    ul.task-list[class]{list-style: none;}
    ul.task-list li input[type="checkbox"] {
      font-size: inherit;
      width: 0.8em;
      margin: 0 0.8em 0.2em -1.6em;
      vertical-align: middle;
    }
    .display.math{display: block; text-align: center; margin: 0.5rem auto;}
  </style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">DevOrSysAdminScripts</h1>
</header>
<p><a
href="https://www.codefactor.io/repository/github/llyaudet/DevOrSysAdminScripts"><img
src="https://www.codefactor.io/repository/github/llyaudet/DevOrSysAdminScripts/badge"
alt="CodeFactor-badge"></a> <a
href="https://app.codacy.com/gh/LLyaudet/DevOrSysAdminScripts/dashboard?utm_source=gh&amp;utm_medium=referral&amp;utm_content=&amp;utm_campaign=Badge_grade"><img
src="https://app.codacy.com/project/badge/Grade/3dd6ef85e8db4460991d1ebc404b68dd"
alt="Codacy-badge"></a> <img
src="https://img.shields.io/github/languages/top/llyaudet/DevOrSysAdminScripts"
alt="GitHub-top-language-badge"> <img
src="https://img.shields.io/github/languages/code-size/llyaudet/DevOrSysAdminScripts"
alt="GitHub-code-size-in-bytes-badge"> <a
href="https://github.com/PyCQA/bandit"><img
src="https://img.shields.io/badge/security-bandit-yellow.svg"
alt="Security:bandit:badge"></a> <a
href="https://github.com/psf/black"><img
src="https://img.shields.io/badge/code%20style-black-000000.svg"
alt="Code-style:black:badge"></a> <a
href="https://pycqa.github.io/isort/"><img
src="https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&amp;labelColor=ef8336"
alt="Imports:isort:badge"></a> <a href="https://mypy-lang.org/"><img
src="https://www.mypy-lang.org/static/mypy_badge.svg"
alt="Typecheck:mypy:badge"></a> <a
href="https://github.com/pylint-dev/pylint"><img
src="https://img.shields.io/badge/linting-pylint-yellowgreen"
alt="Linting:pylint:badge"></a> <a
href="https://github.com/astral-sh/ruff"><img
src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json"
alt="Linting:ruff:badge"></a></p>
<table>
<thead>
<tr class="header">
<th style="text-align: center;"><strong>Some “small” useful
scripts</strong></th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td style="text-align: center;"><strong>for enhancing development or
system-administrators tasks</strong></td>
</tr>
</tbody>
</table>
<p>Currently, the biggest part of this repository is in a suite of shell
scripts about build and checks that I use in some of my other
repositories.</p>
<p>I tried to follow some conventions for my bash code:</p>
<ul>
<li>I tried to encapsulate most of the code in functions.</li>
<li>Unless used as return values, variables in functions are defined as
local variables (<code>local</code> keyword or <code>declare</code>)
with prefix “LFBFL_”.</li>
<li>When used as return values, variables in functions are defined as
global variables (<code>declare -g</code>) with prefix “<span
class="citation" data-cites="function_name">@function_name</span><span
class="citation" data-cites="_result_">@_result_</span>”.</li>
<li>Whenever a variable is no more modified after some point, add the
keyword <code>readonly</code> or use <code>declare -r</code>.</li>
<li>Whenever a variable will only contain integer values (or boolean
values as 0 or 1), use <code>declare -i</code>.</li>
<li>I named bash files with suffixes “.exec.sh” when the script can be
runned (executable, abbreviation stops before a vowel).</li>
<li>I named bash files with suffixes “.libr.sh” when the script contains
only functions definitions (library, abbreviation stops before a
vowel).</li>
<li>When some “.exec.sh” code is encapsulated into functions, either
these functions can be reused and go in some “.libr.sh” file, either
they are truly specific to this script and they are kept in “.exec.sh”
file.</li>
<li>When using <code>source</code> builtin, although any path/filename
with a slash will only be searched for from the current directory
(tested), we add the prefix “./”, to make it explicit.</li>
<li>We use mapfile instead of read -r most of the time, but with the
following exceptions: real use of read -r to read the command line of
the shell, comments (of course), and a file funny.sh where it is kind of
required to use read -r.</li>
<li>We replaced all echo calls by printf calls to follow “The Open Group
Base Specifications” since at least 2 decades: “New applications are
encouraged to use printf instead of echo.”, <a
href="https://pubs.opengroup.org/onlinepubs/000095399/"
class="uri">https://pubs.opengroup.org/onlinepubs/000095399/</a>.</li>
<li>We used <code>_?i_</code> or <code>_?j_</code>, etc. in integer
variables names in Bash scripts.</li>
</ul>
<p>But the files “pre-commit” and “post-commit” were not renamed, since
it is not possible to give them other names to use them as
pre-commit/post-commit hooks in <code>git</code>.</p>
</body>
</html>