aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorJoel Spadin <[email protected]>2023-04-22 23:16:36 -0500
committerPete Johanson <[email protected]>2023-04-24 16:07:04 -0700
commit32ae776c42215d7302ab47787cbfb47298ccb532 (patch)
tree683b220ca15ec1ab8a7cd130ee86f2512c2b3432 /docs
parent9c4f1e02d14e2903d7ec377fc3042bb704cc7253 (diff)
downloadzmk-32ae776c42215d7302ab47787cbfb47298ccb532.tar.gz
zmk-32ae776c42215d7302ab47787cbfb47298ccb532.zip
refactor: Add more checks to pre-commit
Updated existing pre-commit hooks and added some new hooks: - Remove trailing whitespace - Ensure every non-empty file ends with a new line - Check YAML file validity - Prevent adding large files - Ensure any scripts with shebangs are executable Added a GitHub action to run pre-commit on every commit. Removed any existing actions which duplicate pre-commit. Ran pre-commit on the codebase.
Diffstat (limited to 'docs')
-rw-r--r--docs/package-lock.json17
-rw-r--r--docs/package.json2
-rw-r--r--docs/src/templates/setup.ps1.mustache4
-rw-r--r--docs/src/templates/setup.sh.mustache2
4 files changed, 14 insertions, 11 deletions
diff --git a/docs/package-lock.json b/docs/package-lock.json
index fbc859e502..c7333cb36a 100644
--- a/docs/package-lock.json
+++ b/docs/package-lock.json
@@ -39,7 +39,7 @@
"mustache": "^4.2.0",
"null-loader": "^4.0.0",
"prebuild-webpack-plugin": "^1.1.1",
- "prettier": "2.3.1",
+ "prettier": "^2.7.1",
"string-replace-loader": "^3.1.0",
"typescript": "^4.6.3",
"webpack": "^5.72.1"
@@ -12201,15 +12201,18 @@
}
},
"node_modules/prettier": {
- "version": "2.3.1",
- "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.3.1.tgz",
- "integrity": "sha512-p+vNbgpLjif/+D+DwAZAbndtRrR0md0MwfmOVN9N+2RgyACMT+7tfaRnT+WDPkqnuVwleyuBIG2XBxKDme3hPA==",
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+ "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
"dev": true,
"bin": {
"prettier": "bin-prettier.js"
},
"engines": {
"node": ">=10.13.0"
+ },
+ "funding": {
+ "url": "https://github.com/prettier/prettier?sponsor=1"
}
},
"node_modules/pretty-error": {
@@ -24675,9 +24678,9 @@
"integrity": "sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA=="
},
"prettier": {
- "version": "2.3.1",
- "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.3.1.tgz",
- "integrity": "sha512-p+vNbgpLjif/+D+DwAZAbndtRrR0md0MwfmOVN9N+2RgyACMT+7tfaRnT+WDPkqnuVwleyuBIG2XBxKDme3hPA==",
+ "version": "2.7.1",
+ "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.7.1.tgz",
+ "integrity": "sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==",
"dev": true
},
"pretty-error": {
diff --git a/docs/package.json b/docs/package.json
index 7c933b032a..95d47b9f0b 100644
--- a/docs/package.json
+++ b/docs/package.json
@@ -58,7 +58,7 @@
"mustache": "^4.2.0",
"null-loader": "^4.0.0",
"prebuild-webpack-plugin": "^1.1.1",
- "prettier": "2.3.1",
+ "prettier": "^2.7.1",
"string-replace-loader": "^3.1.0",
"typescript": "^4.6.3",
"webpack": "^5.72.1"
diff --git a/docs/src/templates/setup.ps1.mustache b/docs/src/templates/setup.ps1.mustache
index f90c74889e..90f9cdcfae 100644
--- a/docs/src/templates/setup.ps1.mustache
+++ b/docs/src/templates/setup.ps1.mustache
@@ -74,7 +74,7 @@ if (Test-CommandExists Get-Acl) {
$permission = (Get-Acl $pwd).Access |
?{$_.IdentityReference -match $env:UserName `
-and $_.FileSystemRights -match "FullControl" `
- -or $_.FileSystemRights -match "Write" } |
+ -or $_.FileSystemRights -match "Write" } |
Select IdentityReference,FileSystemRights
If (-Not $permission){
@@ -141,7 +141,7 @@ if ($keyboard_type -eq "shield") {
Write-Host "Wired split is not yet supported by ZMK."
exit 1
}
-
+
$shields = $keyboard_siblings
$board = $($($boards.keys)[$choice])
$boards = ( $board )
diff --git a/docs/src/templates/setup.sh.mustache b/docs/src/templates/setup.sh.mustache
index 4c3868ec45..c711dbc5b1 100644
--- a/docs/src/templates/setup.sh.mustache
+++ b/docs/src/templates/setup.sh.mustache
@@ -97,7 +97,7 @@ select opt in "${options[@]}" "Quit"; do
keyboard_arch=${keyboards_arch[$keyboard_index]}
keyboard_basedir=${keyboards_basedir[$keyboard_index]}
keyboard_title=${options[$keyboard_index]}
- keyboard_sibling_var=${keyboard}_siblings[@]
+ keyboard_sibling_var=${keyboard}_siblings[@]
keyboard_sibling_first=${keyboard}_siblings[0]
if [ -n "${!keyboard_sibling_first}" ]; then
keyboard_siblings=${!keyboard_sibling_var}