From 78db8b15af42faf56c565202f29b4cae9c4b0e68 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 13:29:23 +0800 Subject: [PATCH 01/10] Simplify MD rules --- book/.markdownlint.yml | 13 ------------- book/src/contributing.md | 4 ++-- book/src/faq.md | 2 +- book/src/intro.md | 2 +- 4 files changed, 4 insertions(+), 17 deletions(-) diff --git a/book/.markdownlint.yml b/book/.markdownlint.yml index 5d6bda2..3596fa5 100644 --- a/book/.markdownlint.yml +++ b/book/.markdownlint.yml @@ -1,16 +1,7 @@ -# MD010: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs -MD010: - # Set code blocks to false so that code blocks will be ignored, default is true - code_blocks: false - #MD013 line length: https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md # Set to false as this will also interfere with help_x.md files, and it is not necessary to comply with the line length of 80 MD013: false -# MD028: set to false to allow blank line between blockquote: https://github.com/DavidAnson/markdownlint/blob/main/doc/md028.md -# This is because the blockquotes are shown separatedly (a deisred outcome) when having a blank line in between -MD028: false - # MD024: set siblings_only to true so that same headings with different parent headings are allowed # https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md MD024: @@ -22,7 +13,3 @@ MD033: false # MD036 set to false to preserve the emphasis on deprecation notice on key-management.md (a heading is not necessary) MD036: false - -# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md -# Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change -MD040: false \ No newline at end of file diff --git a/book/src/contributing.md b/book/src/contributing.md index 19ea123..8aecddc 100644 --- a/book/src/contributing.md +++ b/book/src/contributing.md @@ -59,7 +59,7 @@ All `TODO` statements should be accompanied by a GitHub issue. ```rust pub fn my_function(&mut self, _something &[u8]) -> Result { // TODO: something_here - // https://github.com/sigp/lighthouse/issues/XX + // https://github.com/sigp/anchor/issues/XX } ``` @@ -82,7 +82,7 @@ fn validate_attestation() {} // A comment on the same line after a space - The comments should come before attributes. ```rust -/// Stores the core configuration for this Lighthouse instance. +/// Stores the core configuration for this instance. /// This struct is general, other components may implement more /// specialized config structs. #[derive(Clone)] diff --git a/book/src/faq.md b/book/src/faq.md index 583c499..3a3188a 100644 --- a/book/src/faq.md +++ b/book/src/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -- [What is sigp/anchor](#sigp-anchor) +- [What is sigp/anchor?](#sigp-anchor) ## What is sigp/anchor diff --git a/book/src/intro.md b/book/src/intro.md index 768d6b2..a0037ca 100644 --- a/book/src/intro.md +++ b/book/src/intro.md @@ -7,7 +7,7 @@ highly performant and secure. This book aims to provide help and support to users and developers of this client. -> Note: The Anchor client is currently under heavily development and should not be used in a +> Note: The Anchor client is currently under active development and should not be used in a production setting. ## About this Book From d3f9ee943e66c6aa38debfb451e6bcac4af800b9 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 14:29:56 +0800 Subject: [PATCH 02/10] wordlist --- .spellcheck.yml | 20 ++++++++++++++++++++ wordlist.txt | 30 ++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 .spellcheck.yml create mode 100644 wordlist.txt diff --git a/.spellcheck.yml b/.spellcheck.yml new file mode 100644 index 0000000..d5762b4 --- /dev/null +++ b/.spellcheck.yml @@ -0,0 +1,20 @@ +matrix: +- name: Markdown + sources: + - '!venv/**/*.md|**/*.md' + default_encoding: utf-8 + aspell: + lang: en + dictionary: + wordlists: + - wordlist.txt + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + sources: + - './book/**/*.md' diff --git a/wordlist.txt b/wordlist.txt new file mode 100644 index 0000000..4b75a54 --- /dev/null +++ b/wordlist.txt @@ -0,0 +1,30 @@ +MacOS +linter +Testnets +testnet +Testnet +QBFT +SSV +validator +libp +middleware +performant +github +sigp +io +sigmaprime +mdBook +spec'd +PRs +Styleguide +clippy +rustfmt +TODOs +config +struct +structs +Config +PathBuf +dir +Exercism + From 61106da8844f34b7a2a33e5120daa315f27116b9 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 14:30:19 +0800 Subject: [PATCH 03/10] wordlist --- dictionary.dic | Bin 0 -> 1264 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 dictionary.dic diff --git a/dictionary.dic b/dictionary.dic new file mode 100644 index 0000000000000000000000000000000000000000..48ec1b2eb1f0e817e1c1c9636ca3e02fc268783b GIT binary patch literal 1264 zcmai!y>HV{6va;)+iBCrN%K{NswxwRAR#IynA!jl$Z=|7iz2b$CQfVNd|*42vLP`r zArK2}h=~za!~hcu5(5)rgFk?c2?@?kTnUwdCtdySJMX>gd+)RDMk6l>s$H+=j)S;5 znR#I~9PS0xwNq=S@t@Ih-~O}X6_s^mD!(Hh&CpW73jLE)8I(W?X_{=!(GEt{8(_3M z9C$I9!ht$vEt%E~Okx=8z$`VRK8J_s8oz6e>s53km=VSetE|Pz!Sx z?|5OykNU`^q)>fH+wtSw@iugY1v^OV$`v7(SvQwEfj=7U3qtzucD%{*H+t<7?HozcSoV$_mEB52J_D;)J9B@7vMlEX#Daz z$GdzmZ-RyMfnDKOkSyE+=Os Z#%8i6zI>xMXy>?o|F1pA62C&q_ye=G{~iDU literal 0 HcmV?d00001 From 0f3acf139f6b7075790e87f1c0c2ce19b0a92b24 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 14:34:23 +0800 Subject: [PATCH 04/10] delete dic --- dictionary.dic | Bin 1264 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 dictionary.dic diff --git a/dictionary.dic b/dictionary.dic deleted file mode 100644 index 48ec1b2eb1f0e817e1c1c9636ca3e02fc268783b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1264 zcmai!y>HV{6va;)+iBCrN%K{NswxwRAR#IynA!jl$Z=|7iz2b$CQfVNd|*42vLP`r zArK2}h=~za!~hcu5(5)rgFk?c2?@?kTnUwdCtdySJMX>gd+)RDMk6l>s$H+=j)S;5 znR#I~9PS0xwNq=S@t@Ih-~O}X6_s^mD!(Hh&CpW73jLE)8I(W?X_{=!(GEt{8(_3M z9C$I9!ht$vEt%E~Okx=8z$`VRK8J_s8oz6e>s53km=VSetE|Pz!Sx z?|5OykNU`^q)>fH+wtSw@iugY1v^OV$`v7(SvQwEfj=7U3qtzucD%{*H+t<7?HozcSoV$_mEB52J_D;)J9B@7vMlEX#Daz z$GdzmZ-RyMfnDKOkSyE+=Os Z#%8i6zI>xMXy>?o|F1pA62C&q_ye=G{~iDU From df481afcdf39f4f0270e32c90cb01803d3defb98 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 14:48:10 +0800 Subject: [PATCH 05/10] CI --- .github/workflows/test-suite.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/test-suite.yml b/.github/workflows/test-suite.yml index 8222ace..66388e8 100644 --- a/.github/workflows/test-suite.yml +++ b/.github/workflows/test-suite.yml @@ -164,6 +164,14 @@ jobs: env: # Allow warnings on Nightly RUSTFLAGS: "" + spell-check: + name: Spellcheck + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + # Uses the canonical version so that the version is up to date: + # https://github.com/rojopolis/spellcheck-github-actions?tab=readme-ov-file#using-a-canonical-version + - uses: rojopolis/spellcheck-github-actions@v0 # cli-check: # name: cli-check # needs: [check-labels] From 3f4acbf3a6b62204fcc9f31e98a72e57d92d13a7 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 15:37:51 +0800 Subject: [PATCH 06/10] Revert "Simplify MD rules" This reverts commit 78db8b15af42faf56c565202f29b4cae9c4b0e68. --- book/.markdownlint.yml | 13 +++++++++++++ book/src/contributing.md | 4 ++-- book/src/faq.md | 2 +- book/src/intro.md | 2 +- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/book/.markdownlint.yml b/book/.markdownlint.yml index 3596fa5..5d6bda2 100644 --- a/book/.markdownlint.yml +++ b/book/.markdownlint.yml @@ -1,7 +1,16 @@ +# MD010: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs +MD010: + # Set code blocks to false so that code blocks will be ignored, default is true + code_blocks: false + #MD013 line length: https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md # Set to false as this will also interfere with help_x.md files, and it is not necessary to comply with the line length of 80 MD013: false +# MD028: set to false to allow blank line between blockquote: https://github.com/DavidAnson/markdownlint/blob/main/doc/md028.md +# This is because the blockquotes are shown separatedly (a deisred outcome) when having a blank line in between +MD028: false + # MD024: set siblings_only to true so that same headings with different parent headings are allowed # https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md MD024: @@ -13,3 +22,7 @@ MD033: false # MD036 set to false to preserve the emphasis on deprecation notice on key-management.md (a heading is not necessary) MD036: false + +# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md +# Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change +MD040: false \ No newline at end of file diff --git a/book/src/contributing.md b/book/src/contributing.md index 8aecddc..19ea123 100644 --- a/book/src/contributing.md +++ b/book/src/contributing.md @@ -59,7 +59,7 @@ All `TODO` statements should be accompanied by a GitHub issue. ```rust pub fn my_function(&mut self, _something &[u8]) -> Result { // TODO: something_here - // https://github.com/sigp/anchor/issues/XX + // https://github.com/sigp/lighthouse/issues/XX } ``` @@ -82,7 +82,7 @@ fn validate_attestation() {} // A comment on the same line after a space - The comments should come before attributes. ```rust -/// Stores the core configuration for this instance. +/// Stores the core configuration for this Lighthouse instance. /// This struct is general, other components may implement more /// specialized config structs. #[derive(Clone)] diff --git a/book/src/faq.md b/book/src/faq.md index 3a3188a..583c499 100644 --- a/book/src/faq.md +++ b/book/src/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -- [What is sigp/anchor?](#sigp-anchor) +- [What is sigp/anchor](#sigp-anchor) ## What is sigp/anchor diff --git a/book/src/intro.md b/book/src/intro.md index a0037ca..768d6b2 100644 --- a/book/src/intro.md +++ b/book/src/intro.md @@ -7,7 +7,7 @@ highly performant and secure. This book aims to provide help and support to users and developers of this client. -> Note: The Anchor client is currently under active development and should not be used in a +> Note: The Anchor client is currently under heavily development and should not be used in a production setting. ## About this Book From e63e7de637c19473ea62d37bd5b5081caa9d151b Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 15:38:33 +0800 Subject: [PATCH 07/10] Revert "Simplify MD rules" This reverts commit 78db8b15af42faf56c565202f29b4cae9c4b0e68. --- book/.markdownlint.yml | 13 +++++++++++++ book/src/contributing.md | 4 ++-- book/src/faq.md | 2 +- book/src/intro.md | 2 +- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/book/.markdownlint.yml b/book/.markdownlint.yml index 3596fa5..5d6bda2 100644 --- a/book/.markdownlint.yml +++ b/book/.markdownlint.yml @@ -1,7 +1,16 @@ +# MD010: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md010---hard-tabs +MD010: + # Set code blocks to false so that code blocks will be ignored, default is true + code_blocks: false + #MD013 line length: https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md # Set to false as this will also interfere with help_x.md files, and it is not necessary to comply with the line length of 80 MD013: false +# MD028: set to false to allow blank line between blockquote: https://github.com/DavidAnson/markdownlint/blob/main/doc/md028.md +# This is because the blockquotes are shown separatedly (a deisred outcome) when having a blank line in between +MD028: false + # MD024: set siblings_only to true so that same headings with different parent headings are allowed # https://github.com/DavidAnson/markdownlint/blob/main/doc/md024.md MD024: @@ -13,3 +22,7 @@ MD033: false # MD036 set to false to preserve the emphasis on deprecation notice on key-management.md (a heading is not necessary) MD036: false + +# MD040 code blocks should have a language specified: https://github.com/DavidAnson/markdownlint/blob/main/doc/md040.md +# Set to false as the help_x.md files are code blocks without a language specified, which is fine and does not need to change +MD040: false \ No newline at end of file diff --git a/book/src/contributing.md b/book/src/contributing.md index 8aecddc..19ea123 100644 --- a/book/src/contributing.md +++ b/book/src/contributing.md @@ -59,7 +59,7 @@ All `TODO` statements should be accompanied by a GitHub issue. ```rust pub fn my_function(&mut self, _something &[u8]) -> Result { // TODO: something_here - // https://github.com/sigp/anchor/issues/XX + // https://github.com/sigp/lighthouse/issues/XX } ``` @@ -82,7 +82,7 @@ fn validate_attestation() {} // A comment on the same line after a space - The comments should come before attributes. ```rust -/// Stores the core configuration for this instance. +/// Stores the core configuration for this Lighthouse instance. /// This struct is general, other components may implement more /// specialized config structs. #[derive(Clone)] diff --git a/book/src/faq.md b/book/src/faq.md index 3a3188a..583c499 100644 --- a/book/src/faq.md +++ b/book/src/faq.md @@ -1,6 +1,6 @@ # Frequently Asked Questions -- [What is sigp/anchor?](#sigp-anchor) +- [What is sigp/anchor](#sigp-anchor) ## What is sigp/anchor diff --git a/book/src/intro.md b/book/src/intro.md index a0037ca..768d6b2 100644 --- a/book/src/intro.md +++ b/book/src/intro.md @@ -7,7 +7,7 @@ highly performant and secure. This book aims to provide help and support to users and developers of this client. -> Note: The Anchor client is currently under active development and should not be used in a +> Note: The Anchor client is currently under heavily development and should not be used in a production setting. ## About this Book From 325fed552203c3d3efccba99ad3817bba4ad9f1e Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 15:41:18 +0800 Subject: [PATCH 08/10] small letter --- .github/workflows/test-suite.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/test-suite.yml b/.github/workflows/test-suite.yml index 66388e8..6985e69 100644 --- a/.github/workflows/test-suite.yml +++ b/.github/workflows/test-suite.yml @@ -165,7 +165,7 @@ jobs: # Allow warnings on Nightly RUSTFLAGS: "" spell-check: - name: Spellcheck + name: spellcheck runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 From 199db7f35a0ee334ba347c11b81292323a99a4fb Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 15:54:44 +0800 Subject: [PATCH 09/10] Merge branch 'chonghe/spellcheck' of https://github.com/chong-he/anchor into chonghe/spellcheck --- .spellcheck.yml | 5 ++++- dictionary.dic | Bin 0 -> 1392 bytes wordlist.txt | 5 ++++- 3 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 dictionary.dic diff --git a/.spellcheck.yml b/.spellcheck.yml index d5762b4..806a68b 100644 --- a/.spellcheck.yml +++ b/.spellcheck.yml @@ -17,4 +17,7 @@ matrix: - code - pre sources: - - './book/**/*.md' + - './book/**/*.md' + - 'README.md' + - 'SECURITY.md' + - 'CONTRIBUTING.md' diff --git a/dictionary.dic b/dictionary.dic new file mode 100644 index 0000000000000000000000000000000000000000..7c4c629f8b40400fa2ecbda26e132cad7806713f GIT binary patch literal 1392 zcmai!&yU+w5XZlp_(wLo>twUZR&7xgPAx$Kdf)_ymFY$+*~yyNY7y$iNnSQqo!GJ+ z%5tKoazot8kvl?_dZ<)!fNM`6ap?)TA+G!Z+wa7wgvx;@jXv|f^E`et@7ZCVsyOaW z)ht}aMRz?@SvO1W$K9Ln+v%1>G;|3Un+1vEMD(tn#KgA%GVlO{_W zv{$36mPqHxQWfA9Ua2K}n`!T;%+Ygz3N_m;^PL1`K8JCgx?=-|ka2mJGX!d+OMP3& zd7T_E&yJAK?~>jTU-n{s1i@3%fx|o$m`-h)qhJw}s9C<25~;3q1!9g@KDl zYmV>(DRuuQ>JIQG`TE%2>cQHpL|KE-zJ z_;Zy_qI`jl&YpZSgw?5!<79GgG7qCA8X7y~!))j$fjEt-bjsQ{&Z1(z8pG1qu>hu} zeJo^{jbnHcM`?PFD;gWxD4k_Aj+TYWU{$5V zdQ%^SlT)A9osD*&wT#8oPLg}v?I3XPjAXZqXgZD6{V-G5*Vz9)^aIlii@Cj;aUD-W zGPmog%4SKn2$uzRt8y;7AjfWnhhyz)nMxBJ7(AgqZ>`ldvsGTq76o=HJT0?X_5Is8 zG}E$vIj QpKsRuMaCQdQ^sVx1b4d!8~^|S literal 0 HcmV?d00001 diff --git a/wordlist.txt b/wordlist.txt index 4b75a54..5573d13 100644 --- a/wordlist.txt +++ b/wordlist.txt @@ -27,4 +27,7 @@ Config PathBuf dir Exercism - +blockchain +Ethereum +HTTPS +repo From 23baf598fb9574a33e4644f49d78c2930d18e9a2 Mon Sep 17 00:00:00 2001 From: Tan Chee Keong Date: Tue, 29 Oct 2024 15:55:57 +0800 Subject: [PATCH 10/10] delete dic --- dictionary.dic | Bin 1392 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 dictionary.dic diff --git a/dictionary.dic b/dictionary.dic deleted file mode 100644 index 7c4c629f8b40400fa2ecbda26e132cad7806713f..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1392 zcmai!&yU+w5XZlp_(wLo>twUZR&7xgPAx$Kdf)_ymFY$+*~yyNY7y$iNnSQqo!GJ+ z%5tKoazot8kvl?_dZ<)!fNM`6ap?)TA+G!Z+wa7wgvx;@jXv|f^E`et@7ZCVsyOaW z)ht}aMRz?@SvO1W$K9Ln+v%1>G;|3Un+1vEMD(tn#KgA%GVlO{_W zv{$36mPqHxQWfA9Ua2K}n`!T;%+Ygz3N_m;^PL1`K8JCgx?=-|ka2mJGX!d+OMP3& zd7T_E&yJAK?~>jTU-n{s1i@3%fx|o$m`-h)qhJw}s9C<25~;3q1!9g@KDl zYmV>(DRuuQ>JIQG`TE%2>cQHpL|KE-zJ z_;Zy_qI`jl&YpZSgw?5!<79GgG7qCA8X7y~!))j$fjEt-bjsQ{&Z1(z8pG1qu>hu} zeJo^{jbnHcM`?PFD;gWxD4k_Aj+TYWU{$5V zdQ%^SlT)A9osD*&wT#8oPLg}v?I3XPjAXZqXgZD6{V-G5*Vz9)^aIlii@Cj;aUD-W zGPmog%4SKn2$uzRt8y;7AjfWnhhyz)nMxBJ7(AgqZ>`ldvsGTq76o=HJT0?X_5Is8 zG}E$vIj QpKsRuMaCQdQ^sVx1b4d!8~^|S