diff --git a/.automation/cleanup-docker.sh b/.automation/cleanup-docker.sh index e6a81770..838119c4 100755 --- a/.automation/cleanup-docker.sh +++ b/.automation/cleanup-docker.sh @@ -8,7 +8,7 @@ # Its based on being built from a GitHub Action, but could be easily updated # To be ran in a different medium. # -# PRE-Reqs: +# PRE-Requirements: # - Dockerfile # - System with Docker installed # - Global variables met diff --git a/.automation/test/ansible/ghe-initialize/templates/ghe-config-apply.sh b/.automation/test/ansible/ghe-initialize/templates/ghe-config-apply.sh index 6ddf4d71..5a0f32dd 100644 --- a/.automation/test/ansible/ghe-initialize/templates/ghe-config-apply.sh +++ b/.automation/test/ansible/ghe-initialize/templates/ghe-config-apply.sh @@ -35,7 +35,7 @@ CheckGHEPid() ################################################ if [ ! -f "$GHE_CONFIG_PID" ]; then # File not found - echo "Were good to move forward, no .pid file found at:[$GHE_CONFIG_PID]" + echo "We're good to move forward, no .pid file found at:[$GHE_CONFIG_PID]" else # Found the pid running, need to sleep echo "Current PID found, sleeping $SLEEP_SECONDS seconds before next check..." @@ -189,10 +189,10 @@ CheckGHEProcess #################### RunConfigApply -########################################## -# Were going to run it again after a nap # -# to make sure there is no crazy actions # -########################################## +########################################### +# We're going to run it again after a nap # +# to make sure there is no crazy actions # +########################################### sleep 300s ###################### diff --git a/.automation/test/coffeescript/coffeescript_bad_1.coffee b/.automation/test/coffeescript/coffeescript_bad_1.coffee index 5efeeacb..e388e7cc 100644 --- a/.automation/test/coffeescript/coffeescript_bad_1.coffee +++ b/.automation/test/coffeescript/coffeescript_bad_1.coffee @@ -6,7 +6,7 @@ # `mona echo *` - repeats what you say # # Author: -# admiralAwkbar@github.com +# admiralawkbar@github.com ############################### # Drop Hammer array of images # diff --git a/.automation/test/coffeescript/coffeescript_good_1.coffee b/.automation/test/coffeescript/coffeescript_good_1.coffee index 62f2a4fe..064f850e 100644 --- a/.automation/test/coffeescript/coffeescript_good_1.coffee +++ b/.automation/test/coffeescript/coffeescript_good_1.coffee @@ -6,7 +6,7 @@ # `mona echo *` - repeats what you say # # Author: -# admiralAwkbar@github.com +# admiralawkbar@github.com ############################### # Drop Hammer array of images # diff --git a/.automation/test/css/css_bad_01.css b/.automation/test/css/css_bad_01.css index 3c600b36..6ae90d7e 100644 --- a/.automation/test/css/css_bad_01.css +++ b/.automation/test/css/css_bad_01.css @@ -1,5 +1,5 @@ /* Bad */ -/* Multiline */ +/* Multi-line */ /* Comment */ .selector-3[type="text"] { background: linear-gradient(#FFFFFF, rgba(0, 0, 0, 0.8)); diff --git a/.automation/test/markdown/markdown_bad_1.md b/.automation/test/markdown/markdown_bad_1.md index 47aa18af..6599ac74 100644 --- a/.automation/test/markdown/markdown_bad_1.md +++ b/.automation/test/markdown/markdown_bad_1.md @@ -16,5 +16,5 @@ ls -la # Walk away -Were all done **here**. +We're all done **here**. - [Link Action]https://github.com diff --git a/.automation/test/markdown/markdown_good_1.md b/.automation/test/markdown/markdown_good_1.md index 5634a455..7a0aef45 100644 --- a/.automation/test/markdown/markdown_good_1.md +++ b/.automation/test/markdown/markdown_good_1.md @@ -16,5 +16,5 @@ ls -la ### Walk away -Were all done **here**. +We're all done **here**. - [Link Action](https://github.com) diff --git a/.automation/test/perl/perl_bad_1.pl b/.automation/test/perl/perl_bad_1.pl index e3626f88..7b127b99 100644 --- a/.automation/test/perl/perl_bad_1.pl +++ b/.automation/test/perl/perl_bad_1.pl @@ -1,7 +1,7 @@ #!/usr/bin/perl ################################################################################ ################################################################################ -######### Script action @admiralAwkbar ######################################### +######### Script action @admiralawkbar ######################################### ################################################################################ ############# diff --git a/.automation/test/perl/perl_good_1.pl b/.automation/test/perl/perl_good_1.pl index f35c1409..caca0994 100644 --- a/.automation/test/perl/perl_good_1.pl +++ b/.automation/test/perl/perl_good_1.pl @@ -1,7 +1,7 @@ #!/usr/bin/perl ################################################################################ ################################################################################ -######### Script action @admiralAwkbar ######################################### +######### Script action @admiralawkbar ######################################### ################################################################################ ############# diff --git a/.automation/upload-docker.sh b/.automation/upload-docker.sh index 4902edfb..12c15635 100755 --- a/.automation/upload-docker.sh +++ b/.automation/upload-docker.sh @@ -9,7 +9,7 @@ # Its based on being built from a GitHub Action, but could be easily updated # To be ran in a different medium. # -# PRE-Reqs: +# PRE-Requirements: # - Dockerfile # - System with Docker installed # - Global variables met diff --git a/.github/actions/spelling/allow/Dockerfile.txt b/.github/actions/spelling/allow/Dockerfile.txt new file mode 100644 index 00000000..bb490a92 --- /dev/null +++ b/.github/actions/spelling/allow/Dockerfile.txt @@ -0,0 +1,7 @@ +musl +nvq +rdoc +setuptools +uninstall +wget +WORKDIR diff --git a/.github/actions/spelling/allow/cleanup-docker.sh.txt b/.github/actions/spelling/allow/cleanup-docker.sh.txt new file mode 100644 index 00000000..1efe4ad7 --- /dev/null +++ b/.github/actions/spelling/allow/cleanup-docker.sh.txt @@ -0,0 +1 @@ +alnum diff --git a/.github/actions/spelling/allow/disabling-linters.md.txt b/.github/actions/spelling/allow/disabling-linters.md.txt new file mode 100644 index 00000000..fe1303c8 --- /dev/null +++ b/.github/actions/spelling/allow/disabling-linters.md.txt @@ -0,0 +1,3 @@ +noqa +toc +todo diff --git a/.github/actions/spelling/allow/ghe-api-config-apply.yml.txt b/.github/actions/spelling/allow/ghe-api-config-apply.yml.txt new file mode 100644 index 00000000..8d39ee0b --- /dev/null +++ b/.github/actions/spelling/allow/ghe-api-config-apply.yml.txt @@ -0,0 +1,2 @@ +configcheck +nohup diff --git a/.github/actions/spelling/allow/ghe-config-apply.sh.txt b/.github/actions/spelling/allow/ghe-config-apply.sh.txt new file mode 100644 index 00000000..0570567b --- /dev/null +++ b/.github/actions/spelling/allow/ghe-config-apply.sh.txt @@ -0,0 +1,2 @@ +args +pid diff --git a/.github/actions/spelling/allow/ghe-initial-configuration.yml.txt b/.github/actions/spelling/allow/ghe-initial-configuration.yml.txt new file mode 100644 index 00000000..a09f0564 --- /dev/null +++ b/.github/actions/spelling/allow/ghe-initial-configuration.yml.txt @@ -0,0 +1 @@ +initialconfig diff --git a/.github/actions/spelling/allow/ghe-ldap-configuration.yml.txt b/.github/actions/spelling/allow/ghe-ldap-configuration.yml.txt new file mode 100644 index 00000000..04b1c12f --- /dev/null +++ b/.github/actions/spelling/allow/ghe-ldap-configuration.yml.txt @@ -0,0 +1,2 @@ +ldapconfig +openldap diff --git a/.github/actions/spelling/allow/gitignore.txt b/.github/actions/spelling/allow/gitignore.txt new file mode 100644 index 00000000..6fcb9a9c --- /dev/null +++ b/.github/actions/spelling/allow/gitignore.txt @@ -0,0 +1,8 @@ +cov +eslintcache +jscoverage +jspm +nyc +tgz +typings +wscript diff --git a/.github/actions/spelling/allow/linter.sh.txt b/.github/actions/spelling/allow/linter.sh.txt new file mode 100644 index 00000000..9bd25b2f --- /dev/null +++ b/.github/actions/spelling/allow/linter.sh.txt @@ -0,0 +1,7 @@ +cw +Mstrict +printenv +rcfile +tf +tolower +whoami diff --git a/.github/actions/spelling/allow/main.yml.txt b/.github/actions/spelling/allow/main.yml.txt new file mode 100644 index 00000000..877e71bb --- /dev/null +++ b/.github/actions/spelling/allow/main.yml.txt @@ -0,0 +1,8 @@ +Autobots +basemap +cas +cn +crt +rsa +tlsv +tmp diff --git a/.github/actions/spelling/allow/settings.json.j2.txt b/.github/actions/spelling/allow/settings.json.j2.txt new file mode 100644 index 00000000..7f01269b --- /dev/null +++ b/.github/actions/spelling/allow/settings.json.j2.txt @@ -0,0 +1,4 @@ +dotcom +identicons +oauth +timezone diff --git a/.github/actions/spelling/allow/words.txt b/.github/actions/spelling/allow/words.txt new file mode 100644 index 00000000..0e91754b --- /dev/null +++ b/.github/actions/spelling/allow/words.txt @@ -0,0 +1,158 @@ +admiralawkbar +ansible +api +apk +aws +baz +beardofedu +certs +changeset +codebase +CODEOWNERS +coffeelint +coffeescript +collectd +concat +config +configs +css +dest +devops +dirname +dockerfile +dockerfilelint +dockerfilelintrc +dotenv +elif +emails +entrypoint +Errorf +eslint +eslintrc +filetype +func +gcc +getenv +ghe +GHES +ghl +github +globals +golang +golangci +Google +gpg +gql +Grafana +graphql +grep +homepage +hookshot +hostname +hostvars +http +https +hubot +idp +ip +Jani +javascript +jq +json +jsonlint +jwiebalk +JWT +ldap +len +lfs +libxml +linted +linting +loadbalancer +localhost +loglevel +markdownlint +millis +mkdir +nodejs +NONINFRINGEMENT +noproxy +noreply +npm +ntp +opensource +opensourcefriday +perl +plugin +posix +pprint +Prego +prettyjson +Println +probot +px +py +pylint +rb +readlines +README +regex +regexp +resqued +rgba +rien +Rubo +rubocop +saml +screenshots +shellcheck +signup +smtp +snmp +socio +splunk +src +ssh +ssl +sso +stackoverflow +stacktraces +standardjs +stringify +stylelint +stylelintrc +subdomain +subfolders +sudo +sys +syslog +taz +terraform +tflint +tileserver +tls +typeof +ubuntu +udp +uid +undef +uniq +uri +url +urlencode +username +usr +utils +Vape +vnd +webhook +wiki +wildcards +workflow +xml +xmllint +yaml +yamllint +yml +yq +zkoppert diff --git a/.github/actions/spelling/excludes.txt b/.github/actions/spelling/excludes.txt new file mode 100644 index 00000000..549b89c5 --- /dev/null +++ b/.github/actions/spelling/excludes.txt @@ -0,0 +1,2 @@ +^\.github/linters/ +^TEMPLATES/\.\S* diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt new file mode 100644 index 00000000..64d9960d --- /dev/null +++ b/.github/actions/spelling/expect.txt @@ -0,0 +1,39 @@ +cdxml +changelog +chmod +Dockerhub +EOL +GPR +IAm +icu +jre +kotlin +krb +ktlint +libgcc +libintl +libssl +libstdc +linux +lttng +microsoft +ncurses +nq +openjdk +php +powershell +println +psd +psm +psrc +pssc +psscriptanalyzer +pwsh +rcu +rhc +ry +terminfo +tzdata +userspace +xargs +zlib diff --git a/.github/actions/spelling/patterns.txt b/.github/actions/spelling/patterns.txt new file mode 100644 index 00000000..5c595e9b --- /dev/null +++ b/.github/actions/spelling/patterns.txt @@ -0,0 +1,7 @@ +https?:\S* +# ignore long runs of a single character: +([A-Za-z])\1{3,} +# Any CLI args (-xzf -aef) +\ -\w+\b +# Hex colors (dummy group to not be treated as comment) +(?:#)([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3}) diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml new file mode 100644 index 00000000..b99524b0 --- /dev/null +++ b/.github/workflows/check-spelling.yml @@ -0,0 +1,48 @@ +--- +#################### +## Check spelling ## +#################### + +# +# Documentation: +# https://help.github.com/en/articles/workflow-syntax-for-github-actions +# + +name: Spell checking +############################# +# Start the job on all push # +############################# +on: + push: + branches-ignore: + - 'master' + +############### +# Set the Job # +############### +jobs: + build: + # Name the Job + name: Spell checking + # Set the agent to run on + runs-on: ubuntu-latest + ################## + # Load all steps # + ################## + steps: + ########################## + # Checkout the code base # + ########################## + - name: Checkout Code + uses: actions/checkout@v2 + + ############################# + # Run check spelling action # + ############################# + - name: Check spelling + uses: check-spelling/check-spelling@0.0.16-alpha + with: + bucket: .github/actions + project: spelling + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index ad46b308..0c70da66 100644 --- a/.gitignore +++ b/.gitignore @@ -29,7 +29,7 @@ bower_components # node-waf configuration .lock-wscript -# Compiled binary addons (https://nodejs.org/api/addons.html) +# Compiled binary add-ons (https://nodejs.org/api/addons.html) build/Release # Dependency directories diff --git a/docs/disabling-linters.md b/docs/disabling-linters.md index c738bdbd..9c6ecf0a 100644 --- a/docs/disabling-linters.md +++ b/docs/disabling-linters.md @@ -156,9 +156,9 @@ This line is waaaaaaaaaay too long # yamllint disable-line ### Yamllint disable code block ```yml # yamllint disable rule:colons -- Lorem : ipsum - dolor : sit amet, - consectetur : adipiscing elit +- Key : value + dolor : sit, + foo : bar # yamllint enable ``` @@ -222,9 +222,9 @@ class Foo(object): def meth3(self): """test one line disabling""" # no error - print(self.bla) # pylint: disable=no-member + print(self.baz) # pylint: disable=no-member # error - print(self.blop) + print(self.baz) ``` ### Pylint disable entire file diff --git a/lib/linter.sh b/lib/linter.sh index 9099b04b..e422ad9d 100755 --- a/lib/linter.sh +++ b/lib/linter.sh @@ -3,7 +3,7 @@ ################################################################################ ################################################################################ -########### Super-Linter (Lint all the code) @AdmiralAwkbar #################### +########### Super-Linter (Lint all the code) @admiralawkbar #################### ################################################################################ ################################################################################ @@ -27,7 +27,7 @@ RUBY_FILE_NAME='.ruby-lint.yml' # Name of th RUBY_LINTER_RULES="$DEFAULT_RULES_LOCATION/$RUBY_FILE_NAME" # Path to the ruby lint rules # Coffee Vars COFFEE_FILE_NAME='.coffee-lint.json' # Name of the file -COFFEESCRIPT_LINTER_RULES="$DEFAULT_RULES_LOCATION/$COFFEE_FILE_NAME" # Path to the coffescript lint rules +COFFEESCRIPT_LINTER_RULES="$DEFAULT_RULES_LOCATION/$COFFEE_FILE_NAME" # Path to the coffeescript lint rules # Javascript Vars JAVASCRIPT_FILE_NAME='.eslintrc.yml' # Name of the file JAVASCRIPT_LINTER_RULES="$DEFAULT_RULES_LOCATION/$JAVASCRIPT_FILE_NAME" # Path to the Javascript lint rules