Original schema renamed to rule-schema

fileformat · fileformat · commit 5c0f63d6c34e · 2025-04-07T21:37:29.000-04:00
diff --git a/.github/workflows/rule-validation.yaml b/.github/workflows/rule-validation.yaml
@@ -3,7 +3,7 @@ name: rule-validation
 on:
   push:
   pull_request:
-    paths: ["rules", "docs/namelint-schema.yaml"]
+    paths: ["config/*", "rules/*", "docs/*-schema.yaml"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
diff --git a/.github/workflows/website-deploy.yaml b/.github/workflows/website-deploy.yaml
@@ -28,21 +28,23 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
+      - name: YAML to JSON
+        run: |
+          yq --version
+          ls -l .
+          cat ./docs/namelint-rule-schema.yaml | yq . --output-format=json >./docs/namelint-rule-schema.json
+          cat ./docs/namelint-config-schema.yaml | yq . --output-format=json >./docs/namelint-config-schema.json
+
       - name: Setup Pages
         uses: actions/configure-pages@v5
+
       - name: Build with Jekyll
         uses: actions/jekyll-build-pages@v1
         with:
           source: ./docs
           destination: ./_site
-      - name: YAML to JSON
-        run: |
-          yq --version
-          ls -l .
-          sudo chown --recursive runner:docker _site
-          ls -l .
-          cat ./docs/namelint-schema.yaml | yq . --output-format=json >./_site/namelint-schema.json
-          cat ./docs/namelint-config-schema.yaml | yq . --output-format=json >./_site/namelint-config-schema.json
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
 
diff --git a/bin/validate-configs.sh b/bin/validate-configs.sh
@@ -11,6 +11,6 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 REPO_DIR="$( cd "${SCRIPT_DIR}/.." && pwd )"
 
 SCHEMA_YAML="${REPO_DIR}/docs/namelint-config-schema.yaml"
-YAML_DIR="${REPO_DIR}/conf"
+YAML_DIR="${REPO_DIR}/config"
 
 "${SCRIPT_DIR}/_validate.sh" "${SCHEMA_YAML}" "${YAML_DIR}"
diff --git a/bin/validate-rules.sh b/bin/validate-rules.sh
@@ -10,7 +10,7 @@ set -o nounset
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 REPO_DIR="$( cd "${SCRIPT_DIR}/.." && pwd )"
 
-SCHEMA_YAML="${REPO_DIR}/docs/namelint-schema.yaml"
+SCHEMA_YAML="${REPO_DIR}/docs/namelint-rule-schema.yaml"
 YAML_DIR="${REPO_DIR}/rules"
 
 "${SCRIPT_DIR}/_validate.sh" "${SCHEMA_YAML}" "${YAML_DIR}"
diff --git a/config/default.yaml b/config/default.yaml
diff --git a/docs/namelint-config-schema.yaml b/docs/namelint-config-schema.yaml
@@ -1,5 +1,5 @@
 $schema: https://json-schema.org/draft/2020-12/schema
-$id: https://www.namelint.dev/namelint-schema.json
+$id: https://www.namelint.dev/namelint-config-schema.json
 title: Namelint configuration file schema
 description: >-
   Schema for the configuration of namelint
diff --git a/docs/namelint-rule-schema.yaml b/docs/namelint-rule-schema.yaml
@@ -1,5 +1,5 @@
 $schema: https://json-schema.org/draft/2020-12/schema
-$id: https://www.namelint.dev/namelint-schema.json
+$id: https://www.namelint.dev/namelint-rule-schema.json
 title: Namelint rule definition file schema
 description: >-
   Schema for the definition of filename rules and rule sets
diff --git a/rules/posix.yaml b/rules/posix.yaml
@@ -2,7 +2,7 @@ rules:
   - description: |
       Only allow characters in the Posix [Portable Filename Character Set](https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap03.html#tag_03_265)
     regex:
-      pattern: "$[A-Za-z0-9._-]+$"
+      pattern: "^[A-Za-z0-9._-]+$"
       expect: "match"
     rule_id: "posix-portable"
     title: "Only POSIX portable filename characters"
diff --git a/src/exam-cli.rs b/src/exam-cli.rs
@@ -37,7 +37,7 @@ fn main() {
 	let binding = command.get_matches();
 
 	let schema_file = binding.get_one::<String>("schema");
-	let validator = must_load_validator(schema_file);
+	let validator = must_load_validator(schema_file, true);
 
 	let mut all_rules: HashMap<String, Rule> = HashMap::new();
 	let mut all_rulesets: HashMap<String, RuleSet> = HashMap::new();
diff --git a/src/main.rs b/src/main.rs
@@ -52,7 +52,7 @@ fn main() {
 	let binding = command.get_matches();
 	//LATER: convert to log level let verbose = binding.get_count("verbose");
 	let schema_file = binding.get_one::<String>("schema");
-	let validator = must_load_validator(schema_file);
+	let validator = must_load_validator(schema_file, true);
 
 	let mut all_rules: HashMap<String, Rule> = HashMap::new();
 	let mut all_rulesets: HashMap<String, RuleSet> = HashMap::new();
diff --git a/src/schema.rs b/src/schema.rs
@@ -1,16 +1,17 @@
 use jsonschema::{self, Validator};
 use crate::load::{must_load_data, must_load_file};
 
-const DEFAULT_SCHEMA: &'static str = include_str!("../docs/namelint-schema.yaml");
+const DEFAULT_RULE_SCHEMA: &'static str = include_str!("../docs/namelint-rule-schema.yaml");
+const DEFAULT_CONFIG_SCHEMA: &'static str = include_str!("../docs/namelint-config-schema.yaml");
 
-pub fn must_load_validator(file_name: Option<&String>) -> Validator {
+pub fn must_load_validator(file_name: Option<&String>, is_rule: bool) -> Validator {
 	let schema_str: String;
 	let mut schema_type = "json";
 	let schema_src: &str;
 
 	if file_name.is_none() {
 		println!("INFO: Using default schema");
-		schema_str = DEFAULT_SCHEMA.to_string();
+		schema_str = if is_rule { DEFAULT_RULE_SCHEMA.to_string() } else { DEFAULT_CONFIG_SCHEMA.to_string() };
 		schema_type = "yaml";
 		schema_src = &"built-in schema";
 	} else {
diff --git a/src/validate-cli.rs b/src/validate-cli.rs
@@ -26,7 +26,7 @@ fn main() {
 
 	let binding = command.get_matches();
 	let schema_file = binding.get_one::<String>("schema");
-	let validator = must_load_validator(schema_file);
+	let validator = must_load_validator(schema_file, true);
 
 	let mut error_count = 0;
 	let mut bad_file_count = 0;
