PROBL

2023.01.01 20:33

makereadme.sh

#!/bin/bash
echo -ne "# Powl's Home Assistant configuration: \n<p align="right"> $(date +"${1:-%Y.%m.%d %H:%M:%S}") </p>\n\n## Total lines of code: " > README.md 
( find . -maxdepth 2 -name '*.yaml' -print0 | xargs -0 cat ) | wc -l >> README.md
echo -e "\n<table>\n<tr valign="top"><td>\n\n| # | HA |\n| --: | -- |" >> README.md
find . -maxdepth 1 -name '*.yaml' | xargs wc -l | sort -nr >> README.md
echo -e "\n</td><td>\n\n| # | ESPHome |\n| --: | -- |" >> README.md
find ./esphome -maxdepth 2 -name '*.yaml' | xargs wc -l | sort -nr >> README.md
echo -e "\n</td></tr> </table>\n" >> README.md
sed -i -E -e "s/(\s*)([0-9]{1,5}) (\.\/)(\w*\/)?(\w*\/)?(\w*\/)?(\w*\/)?(.*\.yaml)/\1\2 [\5\6\7\8](\3\4\5\6\7\8)/" -e "s/(\s{2,10})([0-9]{1,5})/| \2 |/" -e "s/\| ([0-9]*) \| total/\| \*\*\1\*\* \| \*\*Total\*\*/" README.md

Line 1: echo »

echo -ne "# Powl's Home Assistant configuration: \n<p align="right"> $(date +"${1:-%Y.%m.%d %H:%M:%S}") </p>\n\n## Total lines of code: " > README.md 

echoes the strin and writes to README.md

flag -e means \n is expanded to a newline character instead of being literally printed

flag -n means no trailing new line. We want the following number on the same line

resulting in

# Powl's Home Assistant configuration: 
<p align="right"> $(date +"${1:-%Y.%m.%d %H:%M:%S}") </p>

## Total lines of code: 

where $(date + "") renders current date in the format given. Here $1 or the default %Y.%m.%d %H:%M:%S if no argument is passed.

($1 is the first argument passed when the script is being executed, i.e. BLABLA when executing user@device: /home/ $ makereadme.sh BLABLA)

# Powl's Home Assistant configuration: 
<p align="right"> 2023.01.01 13:37:00 </p>

## Total lines of code:

Line 2: ( find . ) → total # lines

( find . -maxdepth 2 -name '*.yaml' -print0 | xargs -0 cat ) | wc -l >> README.md

finds all files in . (here)

max depth means only include subdirs of that depth max. I want files of current dir and one dir below (i.e. esphome)

-name specifies the file name

-print0 means don't print to stdout I guess lol

all that is piped via cat to wc -l which counts the total number of lines in all files that were found.

# Powl's Home Assistant configuration: 
<p align="right"> 2023.01.01 13:37:00 </p>

## Total lines of code: 10486

Line 3: echo »

We want two tables, HA and ESPHome, nested inside one larger table.

Tables in markdown look like this:

|  Title1  | Title2 |
| -------- | ------ |   <--- can specify horiz column alignment 
|  myrow1  | mydata |         with a colon on either side, see example

two of which are put into this html thingy

<table>
<tr valign=top><td>   <--- this align prevents the shorter table from 
    mytable1                  scooting halfway down and looking ugly af lol
</td><td>
    mytable2
</td></tr>
</table>

so we begin to print

echo -e "\n<table>\n<tr valign="top"><td>\n\n| # | HA |\n| --: | -- |" >> README.md

resulting in

▐
<table>
<tr valign="top"><td>

|  #  | HA |
| --: | -- |  <-- left column is now right-aligned

Line 4: find .

find . -maxdepth 1 -name '*.yaml' | xargs wc -l | sort -nr >> README.md

pretty self explanatory, finds files, counts lines, sorts numerically, writes

For reference, find's regular console output looks like this:

User@DESKTOP: /home/config $ find . -maxdepth 1 -name '*.yaml' | xargs wc -l | sort -nr
  7934 total
  3435 ./automations.yaml
  1825 ./scripts.yaml
   802 ./automations-telegram.yaml
   300 ./configuration.yaml
etc...

Line 5: echo »

echo -e "\n</td><td>\n\n| # | ESPHome |\n| --: | -- |" >> README.md

same shit again, prints

▐
</td><td>   <-- divider between table1 and table2

|  #  | ESPHome |
| --: | -- |

Line 6: find ./esphome

find ./esphome -maxdepth 2 -name '*.yaml' | xargs wc -l | sort -nr >> README.md

again, self explanatory, finds files in subdir esphome/ and one layer of subdirs, i.e. esphome/common/

stdout is:

User@DESKTOP: /home/config $ find ./esphome -maxdepth 2 -name '*.yaml' | xargs wc -l | sort -nr
  2591 total
   572 ./esphome/gerald.yaml
   274 ./esphome/cora.yaml
   262 ./esphome/frieder.yaml
   237 ./esphome/berta.yaml
etc...

Line 7: echo »

echo -e "\n</td></tr> </table>\n" >> README.md

bruh

▐
</td></tr> </table>     <-- end of tableception

Line 8: sed

sed

sed enables regex operations on files. That being sed usually sed outputs to stdout, but

flag -i makes it write to the file it is reading from

falg -E enables extended patterns, used for grouping patterns with (...) and later referring to them with \1 etc.

flag -e is just an identifyer of a regex pattern we wanna apply. We're using it it three times

sed -i -E 
-e "s/(\s*)([0-9]{1,5}) (\.\/)(\w*\/)?(\w*\/)?(\w*\/)?(\w*\/)?(.*\.yaml)/\1\2 [\5\6\7\8](\3\4\5\6\7\8)/" 
-e "s/(\s{2,10})([0-9]{1,5})/| \2 |/" 
-e "s/\| ([0-9]*) \| total/\| \*\*\1\*\* \| \*\*Total\*\*/" README.md

We want to replace text (s), so we use -e "s/ search_pattern / replace_with /"

First pattern: Place links to the files

-e "s/(\s*)([0-9]{1,5}) (\.\/)(\w*\/)?(\w*\/)?(\w*\/)?(\w*\/)?(.*\.yaml)/\1\2 [\5\6\7\8](\3\4\5\6\7\8)/" 

Unfold

We can place links using this syntax: [prettyname](link/to/file)

Replace (\s*)([0-9]{1,5}) (\.\/)(\w*\/)?(\w*\/)?(\w*\/)?(\w*\/)?(.*\.yaml)

with \1\2 [\5\6\7\8](\3\4\5\6\7\8)

  7918 total
  3435 ./automations.yaml
   572 ./esphome/gerald.yaml
\1 \2  \3  \4\7      \8

\1 contains \s* which is an arbitrary amount of whitespaces that are followed by a number (in \2). But regex is a greedy cunt so it takes em all lol

\2 contains [0-9]{1,5} which is one to five digits, remember, greedy. This is the amount of lines in the file we're currently looking at.

\3 contains \.\/ which is just a full stop and a forwardslash, but both need to be escaped (coz . is any char)

\4,\5,\6,\7 can contain \w*\/ (quantified by ?, so either 0 or 1 occurance) which means an arbitrary amount of word chars, followed by a forwardslash. This is all subdirectories, if there are any.

finally, \8 contains .*\.yaml which is any amount of any character followed by .yaml = The filename.

After that, our text looks like this

  7918 total
  3435 [automations.yaml](./automations.yaml)
   572 [gerald.yaml](./esphome/gerald.yaml)
\1 \2  [ \5\6\7\8  ](    \3\4\5\6\7\8     )

Notice in the square brackets we intentionally left out some path variables but kept others. We don't want \3\4 (./ and esphome/) but do wan't \5\6\7, because those can store any path beyond esphome/, for example esphome's subdir common/.

Have a look if you need

 7918 total
    1 ./esphome/common/build_path.yaml 
translates to:
    1 [common/build_path.yaml](./esphome/common/build_path.yaml)
\1 \2 [       \5\6\7\8       ](          \3\4\5\6\7\8          )

Second pattern. Put pipes around line numbers

-e "s/(\s{2,10})([0-9]{1,5})/| \2 |/" 

Unfold

Replace (\s{2,10})([0-9]{1,5}) with | \2 |

We lose \1 which is the whitespaces and place pipes around \2. Bish bash bosh

Look rn:

| 7918 | total
| 3435 | [automations.yaml](./automations.yaml)
| 1825 | [scripts.yaml](./scripts.yaml)

Third pattern. Make the totals bold face

-e "s/\| ([0-9]*) \| total/\| \*\*\1\*\* \| \*\*Total\*\*/"

Unfold

Replace \| ([0-9]*) \| total with \| \*\*\1\*\* \| \*\*Total\*\*

Find text | xxxx | total and put **s around. We need to escape all asterisks because else they'd be quantifiers, obv.

Eventually the document should look like this:

Raw

# Powl's Home Assistant configuration: 
<p align="right"> 2023.01.01 13:37:00 </p>

## Total lines of code: 10486

<table>
<tr valign=top><td>

| # | Home Assistant |
| --: | -- |
| **7918** | **Total**
| 3435 | [automations.yaml](./automations.yaml)
| 1825 | [scripts.yaml](./scripts.yaml)
| 802 | [automations-telegram.yaml](./automations-telegram.yaml)
 «redacted»
| 5 | [counter.yaml](./counter.yaml)

</td><td>

| # | ESPHome |
| --: | -- |
| **2591** | **Total**
| 572 | [gerald.yaml](./esphome/gerald.yaml)
| 274 | [cora.yaml](./esphome/cora.yaml)
 «redacted»
| 13 | [common/nuki_dev.yaml](./esphome/common/nuki_dev.yaml)
| 9 | [common/nuki.yaml](./esphome/common/nuki.yaml)
| 1 | [common/build_path.yaml](./esphome/common/build_path.yaml)

</td></tr> </table>

Formatted

Powl's Home Assistant configuration:

2023.01.01 13:37:00

Total lines of code: 10486

# Home Assistant 7918 Total 3435 automations.yaml 1825 scripts.yaml 802 automations-telegram.yaml «redacted» 5 counter.yaml

# ESPHome 2591 Total 572 gerald.yaml 274 cora.yaml «redacted» 13 common/nuki_dev.yaml 9 common/nuki.yaml 1 common/build_path.yaml

Thank you for coming to my ted talk

PROBL


















added blank space to avoid excrutiatingly painful, brain damaging section unfolding