Reorganization
This commit is contained in:
66
scripts/validate/changelog.sh
Normal file
66
scripts/validate/changelog.sh
Normal file
@@ -0,0 +1,66 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
||||
#
|
||||
# This file is part of a Moko Consulting project.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: MokoStandards
|
||||
# INGROUP: Tooling.Changelog
|
||||
# FILE: verify_changelog.sh
|
||||
# BRIEF: Validate CHANGELOG.md governance rules for CI enforcement
|
||||
#
|
||||
# PURPOSE:
|
||||
# Validate that CHANGELOG.md contains only released, properly ordered entries and complies with MokoStandards governance rules.
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
CHANGELOG="CHANGELOG.md"
|
||||
|
||||
if [ ! -f "$CHANGELOG" ]; then
|
||||
echo "ERROR: CHANGELOG.md not found at repository root" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
CONTENT="$(cat "$CHANGELOG")"
|
||||
|
||||
if echo "$CONTENT" | grep -Eiq '^##[[:space:]]*\[?TODO\]?'; then
|
||||
echo "ERROR: TODO section detected in CHANGELOG.md." >&2
|
||||
echo "CHANGELOG.md must contain released versions only." >&2
|
||||
echo "Move all TODO items to TODO.md and remove the section from CHANGELOG.md." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if echo "$CONTENT" | grep -Eiq 'UNRELEASED'; then
|
||||
echo "ERROR: UNRELEASED placeholder detected in CHANGELOG.md." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
for token in "TBD" "TO BE DETERMINED" "PLACEHOLDER"; do
|
||||
if echo "$CONTENT" | grep -Eiq "$token"; then
|
||||
echo "ERROR: Unresolved placeholder detected: $token" >&2
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
mapfile -t versions < <(
|
||||
grep -E '^## \[[0-9]+\.[0-9]+\.[0-9]+\] [0-9]{4}-[0-9]{2}-[0-9]{2}$' "$CHANGELOG" \
|
||||
| sed -E 's/^## \[([0-9]+\.[0-9]+\.[0-9]+)\].*/\1/'
|
||||
)
|
||||
|
||||
if [ "${#versions[@]}" -eq 0 ]; then
|
||||
echo "ERROR: No valid version headings found in CHANGELOG.md" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
sorted_versions="$(printf '%s\n' "${versions[@]}" | sort -Vr)"
|
||||
|
||||
if [ "$(printf '%s\n' "${versions[@]}")" != "$sorted_versions" ]; then
|
||||
echo "ERROR: Versions are not ordered from newest to oldest" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "CHANGELOG.md validation passed"
|
||||
exit 0
|
||||
0
scripts/validate/language_structure.sh
Normal file
0
scripts/validate/language_structure.sh
Normal file
0
scripts/validate/license_headers.sh
Normal file
0
scripts/validate/license_headers.sh
Normal file
110
scripts/validate/manifest.sh
Normal file
110
scripts/validate/manifest.sh
Normal file
@@ -0,0 +1,110 @@
|
||||
# ============================================================================
|
||||
# Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
||||
#
|
||||
# This file is part of a Moko Consulting project.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: Shell.Script
|
||||
# INGROUP: MokoStandards.Validation
|
||||
# REPO: https://github.com/mokoconsulting-tech/MokoStandards
|
||||
# PATH: /scripts/validate_manifest.sh
|
||||
# VERSION: 03.05.00
|
||||
# BRIEF: Validate Joomla extension manifest governance before packaging.
|
||||
# NOTE: Enforces: manifest discovery, extension type presence, version and creationDate presence, XML wellformedness when xmllint is available.
|
||||
# ============================================================================
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
# Purpose:
|
||||
# - Locate the primary Joomla manifest under /src.
|
||||
# - Validate that it contains a <extension ... type="..."> root.
|
||||
# - Validate required fields exist: <version>, <creationDate>, <name>.
|
||||
# - Validate XML is wellformed when xmllint is available.
|
||||
#
|
||||
# Usage:
|
||||
# ./scripts/validate_manifest.sh
|
||||
|
||||
log_json() {
|
||||
# shellcheck disable=SC2059
|
||||
printf '%s\n' "$1"
|
||||
}
|
||||
|
||||
fail() {
|
||||
local msg="$1"
|
||||
echo "ERROR: ${msg}" >&2
|
||||
exit 1
|
||||
}
|
||||
|
||||
[ -d "src" ] || fail "src directory missing"
|
||||
|
||||
# Discovery priority order.
|
||||
manifest=""
|
||||
if [ -f "src/templateDetails.xml" ]; then
|
||||
manifest="src/templateDetails.xml"
|
||||
elif find src -maxdepth 4 -type f -name 'templateDetails.xml' | head -n 1 | grep -q .; then
|
||||
manifest="$(find src -maxdepth 4 -type f -name 'templateDetails.xml' | head -n 1)"
|
||||
elif find src -maxdepth 4 -type f -name 'pkg_*.xml' | head -n 1 | grep -q .; then
|
||||
manifest="$(find src -maxdepth 4 -type f -name 'pkg_*.xml' | head -n 1)"
|
||||
elif find src -maxdepth 4 -type f -name 'com_*.xml' | head -n 1 | grep -q .; then
|
||||
manifest="$(find src -maxdepth 4 -type f -name 'com_*.xml' | head -n 1)"
|
||||
elif find src -maxdepth 4 -type f -name 'mod_*.xml' | head -n 1 | grep -q .; then
|
||||
manifest="$(find src -maxdepth 4 -type f -name 'mod_*.xml' | head -n 1)"
|
||||
elif find src -maxdepth 6 -type f -name 'plg_*.xml' | head -n 1 | grep -q .; then
|
||||
manifest="$(find src -maxdepth 6 -type f -name 'plg_*.xml' | head -n 1)"
|
||||
else
|
||||
manifest="$(grep -Rsl --include='*.xml' '<extension' src | head -n 1 || true)"
|
||||
fi
|
||||
|
||||
[ -n "${manifest}" ] || fail "No Joomla manifest XML found under src"
|
||||
[ -f "${manifest}" ] || fail "Manifest not found on disk: ${manifest}"
|
||||
|
||||
# Validate root tag presence.
|
||||
if ! grep -Eq '<extension[^>]*>' "${manifest}"; then
|
||||
fail "Manifest does not contain <extension ...> root: ${manifest}"
|
||||
fi
|
||||
|
||||
ext_type="$(grep -Eo 'type="[^"]+"' "${manifest}" | head -n 1 | cut -d '"' -f2 || true)"
|
||||
[ -n "${ext_type}" ] || fail "Manifest missing required attribute type= on <extension>: ${manifest}"
|
||||
|
||||
# Required fields checks.
|
||||
name_val="$(grep -Eo '<name>[^<]+' "${manifest}" | head -n 1 | sed 's/<name>//' || true)"
|
||||
version_val="$(grep -Eo '<version>[^<]+' "${manifest}" | head -n 1 | sed 's/<version>//' || true)"
|
||||
date_val="$(grep -Eo '<creationDate>[^<]+' "${manifest}" | head -n 1 | sed 's/<creationDate>//' || true)"
|
||||
|
||||
[ -n "${name_val}" ] || fail "Manifest missing <name>: ${manifest}"
|
||||
[ -n "${version_val}" ] || fail "Manifest missing <version>: ${manifest}"
|
||||
[ -n "${date_val}" ] || fail "Manifest missing <creationDate>: ${manifest}"
|
||||
|
||||
# Basic version format guardrail (00.00.00 style).
|
||||
if ! printf '%s' "${version_val}" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$'; then
|
||||
fail "Manifest <version> is not semantic (x.y.z): ${version_val}"
|
||||
fi
|
||||
|
||||
# Basic date format guardrail (YYYY-MM-DD).
|
||||
if ! printf '%s' "${date_val}" | grep -Eq '^[0-9]{4}-[0-9]{2}-[0-9]{2}$'; then
|
||||
fail "Manifest <creationDate> is not YYYY-MM-DD: ${date_val}"
|
||||
fi
|
||||
|
||||
# XML wellformedness when available.
|
||||
if command -v xmllint >/dev/null 2>&1; then
|
||||
xmllint --noout "${manifest}" || fail "xmllint reported invalid XML: ${manifest}"
|
||||
else
|
||||
echo "WARN: xmllint not available, skipping strict wellformedness check" >&2
|
||||
fi
|
||||
|
||||
log_json "{\"status\":\"ok\",\"manifest\":\"${manifest}\",\"type\":\"${ext_type}\",\"name\":\"${name_val}\",\"version\":\"${version_val}\",\"creationDate\":\"${date_val}\"}"
|
||||
0
scripts/validate/no_secrets.sh
Normal file
0
scripts/validate/no_secrets.sh
Normal file
79
scripts/validate/paths.sh
Normal file
79
scripts/validate/paths.sh
Normal file
@@ -0,0 +1,79 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
||||
#
|
||||
# This file is part of a Moko Consulting project.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: MokoStandards
|
||||
# INGROUP: Scripts.Validation
|
||||
# REPO: https://github.com/mokoconsulting-tech/MokoStandards
|
||||
# PATH: /scripts/validate_paths.sh
|
||||
# VERSION: 03.05.00
|
||||
# BRIEF: Detect Windows-style path separators in repository text files for CI enforcement.
|
||||
#
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
ROOT_DIR="$(git rev-parse --show-toplevel)"
|
||||
EXIT_CODE=0
|
||||
|
||||
echo "Scanning repository for Windows-style path separators (\\)"
|
||||
|
||||
# Exclude common binary and vendor paths
|
||||
EXCLUDES=(
|
||||
".git"
|
||||
"node_modules"
|
||||
"vendor"
|
||||
"dist"
|
||||
"build"
|
||||
)
|
||||
|
||||
EXCLUDE_ARGS=()
|
||||
for path in "${EXCLUDES[@]}"; do
|
||||
EXCLUDE_ARGS+=("--exclude-dir=${path}")
|
||||
done
|
||||
|
||||
# Only scan likely-text files to reduce false positives from binaries.
|
||||
# This list is intentionally broad for standards repos.
|
||||
INCLUDE_GLOBS=(
|
||||
"*.md" "*.txt" "*.yml" "*.yaml" "*.json" "*.xml" "*.ini" "*.cfg"
|
||||
"*.sh" "*.bash" "*.ps1" "*.php" "*.js" "*.ts" "*.css" "*.scss"
|
||||
"*.html" "*.htm" "*.vue" "*.java" "*.go" "*.py" "*.rb" "*.c" "*.h" "*.cpp" "*.hpp"
|
||||
)
|
||||
|
||||
GREP_INCLUDE_ARGS=()
|
||||
for g in "${INCLUDE_GLOBS[@]}"; do
|
||||
GREP_INCLUDE_ARGS+=("--include=${g}")
|
||||
done
|
||||
|
||||
# Search for backslashes. This is a governance check for repo docs and automation scripts.
|
||||
# Note: This does not try to interpret programming-language string escapes.
|
||||
MATCHES=$(grep -RIn "\\\\" "${ROOT_DIR}" "${EXCLUDE_ARGS[@]}" "${GREP_INCLUDE_ARGS[@]}" || true)
|
||||
|
||||
if [ -n "${MATCHES}" ]; then
|
||||
echo "Windows-style path separators detected in the following files:"
|
||||
echo "${MATCHES}"
|
||||
echo ""
|
||||
echo "CI policy violation: use forward slashes (/) in repository content unless required by runtime logic"
|
||||
EXIT_CODE=1
|
||||
else
|
||||
echo "No Windows-style path separators found"
|
||||
fi
|
||||
|
||||
exit "${EXIT_CODE}"
|
||||
0
scripts/validate/php_syntax.sh
Normal file
0
scripts/validate/php_syntax.sh
Normal file
88
scripts/validate/tabs.sh
Normal file
88
scripts/validate/tabs.sh
Normal file
@@ -0,0 +1,88 @@
|
||||
#!/usr/bin/env bash
|
||||
# ============================================================================
|
||||
# Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>
|
||||
#
|
||||
# This file is part of a Moko Consulting project.
|
||||
#
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation; either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
#
|
||||
# FILE INFORMATION
|
||||
# DEFGROUP: MokoStandards
|
||||
# INGROUP: GitHub.Actions.CI
|
||||
# REPO: https://github.com/mokoconsulting-tech/MokoStandards
|
||||
# PATH: /scripts/validate_tabs.sh
|
||||
# VERSION: 03.05.00
|
||||
# BRIEF: CI validator that blocks tab characters in YAML files and enforces two-space indentation policy.
|
||||
# NOTE: YAML is indentation sensitive; tabs are noncompliant. This validator fails the job when any tab is detected.
|
||||
# ============================================================================
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
log() {
|
||||
printf '%s\n' "$*"
|
||||
}
|
||||
|
||||
fail=0
|
||||
|
||||
log "[validate_tabs] Scope: *.yml, *.yaml"
|
||||
log "[validate_tabs] Policy: tab characters are noncompliant; replace with two spaces"
|
||||
|
||||
# Find YAML files tracked in git first. If not in a git repo, fall back to filesystem search.
|
||||
yaml_files=""
|
||||
if command -v git >/dev/null 2>&1 && git rev-parse --is-inside-work-tree >/dev/null 2>&1; then
|
||||
yaml_files="$(git ls-files '*.yml' '*.yaml' 2>/dev/null || true)"
|
||||
else
|
||||
yaml_files="$(find . -type f \( -name '*.yml' -o -name '*.yaml' \) -print 2>/dev/null || true)"
|
||||
fi
|
||||
|
||||
if [ -z "${yaml_files}" ]; then
|
||||
log "[validate_tabs] No YAML files found. Status: PASS"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
log "[validate_tabs] YAML files discovered: $(printf '%s\n' "${yaml_files}" | wc -l | tr -d ' ')"
|
||||
|
||||
while IFS= read -r f; do
|
||||
[ -n "$f" ] || continue
|
||||
|
||||
# Skip deleted paths in edge cases
|
||||
[ -f "$f" ] || continue
|
||||
|
||||
# Detect literal tab characters and report with line numbers.
|
||||
if LC_ALL=C grep -n $'\t' -- "$f" >/dev/null 2>&1; then
|
||||
log "[validate_tabs] FAIL: tab detected in: $f"
|
||||
|
||||
# Emit an actionable audit trail: line number plus the exact line content.
|
||||
# Use sed to avoid grep prefix repetition and keep the output deterministic.
|
||||
LC_ALL=C grep -n $'\t' -- "$f" | while IFS= read -r hit; do
|
||||
log " ${hit}"
|
||||
done
|
||||
|
||||
log "[validate_tabs] Remediation: replace each tab with exactly two spaces"
|
||||
log "[validate_tabs] Example: sed -i 's/\\t/ /g' \"$f\""
|
||||
|
||||
fail=1
|
||||
else
|
||||
log "[validate_tabs] PASS: $f"
|
||||
fi
|
||||
done <<< "${yaml_files}"
|
||||
|
||||
if [ "$fail" -ne 0 ]; then
|
||||
log "[validate_tabs] Status: FAIL"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
log "[validate_tabs] Status: PASS"
|
||||
0
scripts/validate/version_alignment.sh
Normal file
0
scripts/validate/version_alignment.sh
Normal file
0
scripts/validate/xml_wellformed.sh
Normal file
0
scripts/validate/xml_wellformed.sh
Normal file
Reference in New Issue
Block a user