Repo cleanup and maintenance #269

YesThatAllen · 2023-05-05T19:43:14Z

Repo cleanup ref: #265

Sort and organize the gitignore
introduce .editorconfig
Remove old cruft
Misc whitespace cleanup
Use .keep vs Readme.md to preserve key folders

mcbirse · 2023-05-06T01:50:09Z

As part of the clean up, perhaps also delete the file pypowerwall.sample which appears to be an unused extraneous duplicate of pypowerwall.env.sample ?

YesThatAllen

Some thoughts/questions I had along the way

.gitignore

.editorconfig

influxdb/backups/.keep

.gitignore

mcbirse · 2023-05-06T02:37:32Z

Just on trailing newlines.... there's a few files where it is missing which I find quite irksome! Especially when you do something like below, and end up with the command prompt printing on the same line as the file content.

admin@alpine:~/Powerwall-Dashboard$ cat compose.env.sample
# Environment variables for docker compose.
#
# GRAFANAUSER - may need to be adjusted for cases such as rootless docker.
# See issue #22,
# https://github.com/jasonacox/Powerwall-Dashboard/issues/22#issuecomment-1253076441)
GRAFANAUSER="1000:1000"admin@alpine:~/Powerwall-Dashboard$

I just went through all the files and identified the below with missing trailing newlines:

_config.yml
compose.env.sample
telegraf.local.sample
dashboards\powerflow-animation.html
grafana\README.md
influxdb\README.md
tools\influxdb2\flux\tesla_energy.vitals.flux
tools\solar-only\compose.env.sample
tools\solar-only\grafana\README.md
tools\solar-only\influxdb\README.md
v6.5.1\grafana\README.md
v6.5.1\influxdb\README.md
weather\contrib\ecowitt\Dockerfile

I would recommend adding the trailing newline to those files.

There are more without the trailing newline, but those are .json files so I have ignored them since they shouldn't have the trailing newline? Some do have a trailing newline however so it is a bit inconsistent, but probably doesn't matter too much with those.

jasonacox · 2023-05-06T03:30:55Z

Additionally, I feel like it'd be good to rename sample files so they retain their native extension (.env).. makes it easier for editors to auto-highlight.

Something like renaming pypowerwall.env.sample to pypowerwall.sample.env?

YesThatAllen · 2023-05-06T12:37:28Z

ok, I think we're close.

once you're happy with the changes: lmk and I'll rebase these 16 down to like, 4 commits or something something sane for the overall commit history.

jasonacox · 2023-05-06T15:25:54Z

Wow! @YesThatAllen this looks great. Thank you!! 🙇

I can squash and merge unless you think it is better to keep it as ~4 commits.

@mcbirse thanks for your review as well.

YesThatAllen · 2023-05-06T19:32:34Z

Nah, squashing to master as one commit is fine. I just didn't want 16 commits in master lol.

YesThatAllen · 2023-05-06T19:37:18Z

.editorconfig

+indent_size = 2
+indent_style = space


@jasonacox / @mcbirse I'm just assuming 2 spaces vs tabs is your preference.

Not every file matches this setting.

The editorconfig does NOT force changes, but does attempt to tell the editor how it should behave when you're adding new code.
Please make sure this is your preference before squashing

We have a mix, but 4 spaces is my preference (as seen in most of the *py, *sh and *yml) but I know we have 2 spaces in *conf.

Yes, I know, we aren't consistent. This should help. :)

YesThatAllen

.

YesThatAllen · 2023-05-06T23:56:42Z

.editorconfig

+# 4 space indentation
+[*.py]
+indent_size = 4


If the default for the repo is 4 spaces, we can remove this fallout.

Not needed since default is already 4 spaces.

jasonacox · 2023-05-07T00:16:32Z

Merged! I'll test and set this up as v2.9.5.

Testing

Raspberry Pi - Passed
Linux / Ubuntu - Passed
Windows 11 - Passed

jasonacox · 2023-05-07T00:23:38Z

@YesThatAllen - Thank you! 🙏

Bman7714 · 2024-05-15T18:19:42Z

Less goooo

YesThatAllen added 9 commits May 5, 2023 07:48

Remove existing .DS_Store files

08b56b3

use .keep vs readme

644e734

Add editorconfig to match existing code

8ec8a76

remove extra whitespace

ed4b030

ignore backup .tgz files

6ba0101

ignore .done files

37d2997

fixup! use .keep vs readme

0cc6719

Ignore more grafana directories

3d207c5

ignore more local configs

33663df

This comment was marked as resolved.

Sign in to view

Remove duplicate .sample file

ba60c13

This comment was marked as outdated.

Sign in to view

YesThatAllen commented May 6, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

.editorconfig Show resolved Hide resolved

influxdb/backups/.keep Outdated Show resolved Hide resolved

.gitignore Outdated Show resolved Hide resolved

YesThatAllen added 2 commits May 5, 2023 21:17

remove other excess .sample file

62922b0

.json files don't want a trailing newline

4163ba9

YesThatAllen added 2 commits May 5, 2023 21:57

Whitespace/trailing newline cleanup

1059acc

fixup! Whitespace/trailing newline cleanup

c693f1f

This comment was marked as resolved.

Sign in to view

YesThatAllen added 2 commits May 6, 2023 07:25

update visualstudio entry

374bd28

organize gitignore, add vscode

c1db5b7

YesThatAllen marked this pull request as ready for review May 6, 2023 12:34

YesThatAllen mentioned this pull request May 6, 2023

Repo cleanup.. remove ignored files, update ignore list #265

Open

YesThatAllen commented May 6, 2023

View reviewed changes

Update default indent to 4 spaces

8b9f1e5

Yes, I know, we aren't consistent. This should help. :)

YesThatAllen commented May 6, 2023

View reviewed changes

Remove separate *.py indentation

394de5e

Not needed since default is already 4 spaces.

jasonacox merged commit 185c62c into jasonacox:main May 7, 2023

YesThatAllen deleted the yesthatallen-265-cleanup branch May 7, 2023 13:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repo cleanup and maintenance #269

Repo cleanup and maintenance #269

YesThatAllen commented May 5, 2023 •

edited

Loading

This comment was marked as resolved.

mcbirse commented May 6, 2023

This comment was marked as outdated.

YesThatAllen left a comment

mcbirse commented May 6, 2023

This comment was marked as resolved.

jasonacox commented May 6, 2023

This comment was marked as resolved.

YesThatAllen commented May 6, 2023

jasonacox commented May 6, 2023

YesThatAllen commented May 6, 2023

YesThatAllen May 6, 2023

jasonacox May 6, 2023

YesThatAllen left a comment

YesThatAllen May 6, 2023

jasonacox commented May 7, 2023 •

edited

Loading

jasonacox commented May 7, 2023

Bman7714 commented May 15, 2024

		indent_size = 2
		indent_style = space

Repo cleanup and maintenance #269

Repo cleanup and maintenance #269

Conversation

YesThatAllen commented May 5, 2023 • edited Loading

This comment was marked as resolved.

mcbirse commented May 6, 2023

This comment was marked as outdated.

YesThatAllen left a comment

Choose a reason for hiding this comment

mcbirse commented May 6, 2023

This comment was marked as resolved.

jasonacox commented May 6, 2023

This comment was marked as resolved.

YesThatAllen commented May 6, 2023

jasonacox commented May 6, 2023

YesThatAllen commented May 6, 2023

YesThatAllen May 6, 2023

Choose a reason for hiding this comment

jasonacox May 6, 2023

Choose a reason for hiding this comment

YesThatAllen left a comment

Choose a reason for hiding this comment

YesThatAllen May 6, 2023

Choose a reason for hiding this comment

jasonacox commented May 7, 2023 • edited Loading

Testing

jasonacox commented May 7, 2023

Bman7714 commented May 15, 2024

YesThatAllen commented May 5, 2023 •

edited

Loading

jasonacox commented May 7, 2023 •

edited

Loading