chore: prettier, markdownlint, cspell and fix many typos #705

carlocorradini · 2023-09-03T16:37:16Z

Related to PR #671

Keep in mind that this PR is purely focused to improving standards and maintainability.

What has been changed:

Added prettier
Added markdownlint
Added cspell
Added shellcheck
Fix spelling typos
Fix formatting (markdown and others)
Moved CoC.md to root and renamed as CODE_OF_CONDUCT.md (standard and better for new contributors)

Scripts:

npm run check
Check for errors
npm run fix
Fix errors (if possible)

When the GitHub workflows are modified, npm run check has to be added

…rors

swanandx

Hey, thank you for the PR! There were too many typos haha. I have few doubts / suggestions which I am writing here ( and in review comments ):

.npmrc, prettter etc. aren't required, only part we use JS is utils, which again, isn't used that frequently, so no need for this. ( same goes fo shellcheck )
and due to above mentioned comment, we don't need to move package.json outside utils
Indentation in markdown files is too much. Also do we really need those markdownlints? ( will review MD files later )
csspell is something nice to have for personal use, if we have it in CI, it will fail runs sometimes when not required and the words we have to ignore in it will just keep increasing.

IMHO, as the repo is mostly ( i wish to say completely ) only Rust files, we don't need lints/formatter for others, We are pretty much consistent over the indentation already right? Primary focus must be how maintainable our code is and how easy new users can contribute.

PS: This are just comments, so please feel free to discuss them!

swanandx · 2023-09-04T08:09:37Z

.github/PULL_REQUEST_TEMPLATE.md

existing file feels more grammatically correct

The GitHub Issue Template should be updated to reflect the new specification (see this): From md to yaml

swanandx · 2023-09-04T08:17:13Z

.github/workflows/build.yml

+            - "**.rs"
+            - "Cargo.*"
+            - "*/Cargo.*"


we are not escaping any special characters, ' should be fine. NOTE: ' and " are differently processed by YAML

Fixed! Prettier is highly customizable. Now, ' and not " must be used in all yml and yaml files.

swanandx · 2023-09-04T08:17:40Z

.github/workflows/release.yml

-      - 'rumqttd-*'
+    push:
+        tags:
+            - "rumqttd-*"


same reason mentioned in previous comment, ' is good.

Fixed (see comment above)

swanandx · 2023-09-04T08:18:49Z

.github/workflows/main.yml

Existing indentation is more readable, also as it is consistent in all yaml files, I don't see the need to this excess indentation ( same applies to other YAML files )

If you want I can change the configuration from 4 to 2 spaces

As always for YAML files only

swanandx · 2023-09-04T08:21:08Z

rumqttd/src/router/routing.rs

@@ -1394,7 +1394,7 @@ enum ConsumeStatus {
    FilterCaughtup,
    /// Some publishes on topic have been forwarded
    PartialRead,
-    /// Use to indicate we want to skip the datareqest
+    /// Use to indicate we want to skip the data request


Suggested change

/// Use to indicate we want to skip the data request

/// Use to indicate we want to skip the DataRequest

swanandx · 2023-09-04T08:33:50Z

rumqttd/.gitignore

is it safe to remove this @henil ?

i don't see a reason to remove it

is there any reason to keep it though?

I wanted to ask do we need stage/ in .gitignore here? or shall we keep it empty ( if we want to keep it )

To assist users and contributors, if this .gitignore is required, please include a note

swanandx · 2023-09-04T08:48:47Z

LICENSE

This is generated by GITHUB, why change it?

For accuracy and correctness, I only removed the last slash from the URL. Nothing special

swanandx · 2023-09-04T08:50:32Z

benchmarks/results/benchmarks.html

This file is automatically generated by plot.go!

Okay, but since it's in the repository, it's been formatted similarly to the other files. Nothing special

swanandx · 2023-09-04T08:57:58Z

benchmarks/README.md

as rel="import" is deprecated, is there any other way we can embed the benchmark results html file in here?

I think this is not possible :/

h3nill

I agree with @swanandx comment here, fixing typos is fine but we don't need spellchecker ad other js related things.

h3nill · 2023-09-04T09:24:44Z

rumqttd/.gitignore

i don't see a reason to remove it

carlocorradini · 2023-09-23T13:59:17Z

Sorry for the late reply but I was very very busy 😥🤯

carlocorradini · 2023-09-23T14:02:55Z

@swanandx @henil Although I completely agree with you, these technologies and tools are almost necessary to maintain an effective and standardized repository structure and code.
What if these configuration files—markdownlint, prettier, etc.—were transferred to utils and used to inspect and fix the entire repository?

carlocorradini added 3 commits September 3, 2023 14:02

chore: added markdownlint, cspell, prettier. fixed the majority of er…

e94c8c1

…rors

Merge branch 'main' into improvements

20991f0

chore(cspell): fix spelling errors

3fa0dfe

swanandx reviewed Sep 4, 2023

View reviewed changes

h3nill reviewed Sep 4, 2023

View reviewed changes

rumqttd/.gitignore Outdated

Copy link

h3nill Sep 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't see a reason to remove it

Merge branch 'main' into improvements

78731d9

carlocorradini added 2 commits September 23, 2023 16:09

chore(prettier): use single quote when dealing with YAML

068ebd7

chore(spell): fix erroneous word

53f0bd5

de-sh force-pushed the main branch from 1fd3c83 to e63bcab Compare May 29, 2024 17:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: prettier, markdownlint, cspell and fix many typos #705

chore: prettier, markdownlint, cspell and fix many typos #705

carlocorradini commented Sep 3, 2023 •

edited

swanandx left a comment

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

h3nill Sep 4, 2023

swanandx Sep 4, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

swanandx Sep 4, 2023

carlocorradini Sep 23, 2023

h3nill left a comment

h3nill Sep 4, 2023

carlocorradini commented Sep 23, 2023

carlocorradini commented Sep 23, 2023 •

edited

	/// Use to indicate we want to skip the data request
	/// Use to indicate we want to skip the DataRequest

chore: prettier, markdownlint, cspell and fix many typos #705

Are you sure you want to change the base?

chore: prettier, markdownlint, cspell and fix many typos #705

Conversation

carlocorradini commented Sep 3, 2023 • edited

swanandx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

h3nill left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlocorradini commented Sep 23, 2023

carlocorradini commented Sep 23, 2023 • edited

carlocorradini commented Sep 3, 2023 •

edited

carlocorradini commented Sep 23, 2023 •

edited