mirror of
https://github.com/sigp/lighthouse.git
synced 2026-03-02 16:21:42 +00:00
3070cb7c39
* linter * Add markdown linter * add env * only check markdown * Add token * Update .github/workflows/test-suite.yml * Markdown linter * Exit code * Update script * rename * mdlint * Add an empty line after end of file * Testing disable * add text * update mdlint.sh * ori validator inclusion * Add config yml file * Remove MD041 and fix advanced-datadir file * FIx validator inclusion file conflict * Merge branch 'unstable' into markdown-linter * change files * Merge branch 'markdown-linter' of https://github.com/chong-he/lighthouse into markdown-linter * mdlint * Remove MD025 * Remove MD036 * Remove MD045 * Removr MD001 * Set MD028 to false * Remove MD024 * Remove MD055 * Remove MD029 * Remove MD040 * Set MD040 to false * Set MD033 to false * Set MD013 to false * Rearrange yml file * Update mdlint.sh and test * Test remove fix * Test with fix * Test with space * Fix summary indentation * Test mdlint.sh * Update mdlint.sh * Test * Update * Test fix * Test again * Fix * merge into check-code * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Update scripts/mdlint.sh Co-authored-by: Mac L <mjladson@pm.me> * Remove set -e * Add comment * Merge pull request #7 from chong-he/unstable Merge unstable to markdown branch * mdlint * Merge branch 'unstable' into markdown-linter * mdlint
102 lines
3.0 KiB
Bash
Executable File
102 lines
3.0 KiB
Bash
Executable File
#! /usr/bin/env bash
|
|
|
|
# IMPORTANT
|
|
# This script should NOT be run directly.
|
|
# Run `make cli` or `make cli-local` from the root of the repository instead.
|
|
|
|
set -e
|
|
|
|
# A function to generate formatted .md files
|
|
write_to_file() {
|
|
local cmd="$1"
|
|
local file="$2"
|
|
local program="$3"
|
|
|
|
# Remove first line of cmd to get rid of commit specific numbers.
|
|
cmd=${cmd#*$'\n'}
|
|
|
|
# We need to add the header and the backticks to create the code block.
|
|
printf "# %s\n\n\`\`\`\n%s\n\`\`\`" "$program" "$cmd" > "$file"
|
|
|
|
# Adjust the width of the help text and append to the end of file
|
|
sed -i -e '$a\'$'\n''\n''<style> .content main {max-width:88%;} </style>' "$file"
|
|
}
|
|
|
|
CMD=./target/release/lighthouse
|
|
|
|
# Store all help strings in variables.
|
|
general_cli=$($CMD --help)
|
|
bn_cli=$($CMD bn --help)
|
|
vc_cli=$($CMD vc --help)
|
|
vm_cli=$($CMD vm --help)
|
|
vm_cli_create=$($CMD vm create --help)
|
|
vm_cli_import=$($CMD vm import --help)
|
|
vm_cli_move=$($CMD vm move --help)
|
|
|
|
general=./help_general.md
|
|
bn=./help_bn.md
|
|
vc=./help_vc.md
|
|
am=./help_am.md
|
|
vm=./help_vm.md
|
|
vm_create=./help_vm_create.md
|
|
vm_import=./help_vm_import.md
|
|
vm_move=./help_vm_move.md
|
|
|
|
# create .md files
|
|
write_to_file "$general_cli" "$general" "Lighthouse General Commands"
|
|
write_to_file "$bn_cli" "$bn" "Beacon Node"
|
|
write_to_file "$vc_cli" "$vc" "Validator Client"
|
|
write_to_file "$vm_cli" "$vm" "Validator Manager"
|
|
write_to_file "$vm_cli_create" "$vm_create" "Validator Manager Create"
|
|
write_to_file "$vm_cli_import" "$vm_import" "Validator Manager Import"
|
|
write_to_file "$vm_cli_move" "$vm_move" "Validator Manager Move"
|
|
|
|
#input 1 = $1 = files; input 2 = $2 = new files
|
|
files=(./book/src/help_general.md ./book/src/help_bn.md ./book/src/help_vc.md ./book/src/help_vm.md ./book/src/help_vm_create.md ./book/src/help_vm_import.md ./book/src/help_vm_move.md)
|
|
new_files=($general $bn $vc $vm $vm_create $vm_import $vm_move)
|
|
|
|
# function to check
|
|
check() {
|
|
local file="$1"
|
|
local new_file="$2"
|
|
|
|
if [[ -f $file ]]; then # check for existence of file
|
|
diff=$(diff $file $new_file || :)
|
|
else
|
|
cp $new_file $file
|
|
changes=true
|
|
echo "$file is not found, it has just been created"
|
|
fi
|
|
|
|
if [[ -z $diff ]]; then # check for difference
|
|
: # do nothing
|
|
else
|
|
cp $new_file $file
|
|
changes=true
|
|
echo "$file has been updated"
|
|
fi
|
|
}
|
|
|
|
# define changes as false
|
|
changes=false
|
|
# call check function to check for each help file
|
|
check ${files[0]} ${new_files[0]}
|
|
check ${files[1]} ${new_files[1]}
|
|
check ${files[2]} ${new_files[2]}
|
|
check ${files[3]} ${new_files[3]}
|
|
check ${files[4]} ${new_files[4]}
|
|
check ${files[5]} ${new_files[5]}
|
|
check ${files[6]} ${new_files[6]}
|
|
|
|
# remove help files
|
|
rm -f help_general.md help_bn.md help_vc.md help_am.md help_vm.md help_vm_create.md help_vm_import.md help_vm_move.md
|
|
|
|
# only exit at the very end
|
|
if [[ $changes == true ]]; then
|
|
echo "Exiting with error to indicate changes occurred. To fix, run 'make cli-local' or 'make cli' and commit the changes."
|
|
exit 1
|
|
else
|
|
echo "CLI help texts are up to date."
|
|
exit 0
|
|
fi
|