Setup company vaidation

.gitignore

@@ -0,0 +1 @@
+node_modules

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npm run validate

README.md

@@ -22,7 +22,6 @@ We welcome contributions from the community. If you wish to add a company to the
 - Add a comprehensive commit message e.g. "Added new trigger-happy company". Push.
 - Submit a pull request with a detailed description of your additions or changes.
 
-
 #### Help! I'm not a developer! How do I contribute?
 
 1. Create a [github account](https://github.com/).
@@ -38,7 +37,10 @@ We welcome contributions from the community. If you wish to add a company to the
 
 Done! One of the project maintainers will review and merge your changes.
 
+### Data Schema
+
+- [Company Schema](./validators/companies/company-schema.yaml)
 
-### Next steps
+### Available commands
 
-- Validate companies data schema
+- `npm run validate` Validate the companies yaml files

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "boycott-israeli-tech-companies-dataset",
+  "version": "1.0.0",
+  "description": "This repository is dedicated to providing a comprehensive list of Israeli tech companies to boycott, categorized based on their respective industries.",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "validate": "node validators/companies/companies-validator.js",
+    "prepare": "husky install"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "ajv": "^8.12.0",
+    "husky": "^8.0.0",
+    "yaml": "^2.3.4"
+  },
+  "dependencies": {}
+}

validators/companies/companies-validator.js

@@ -0,0 +1,41 @@
+// Validate companies using JSON Schema
+
+const fs = require("fs");
+const path = require("path");
+const yaml = require("yaml");
+const Ajv = require("ajv");
+
+const companiesDatasetDir = path.join(__dirname, "../../", "dataset/companies");
+const companySchema = path.join(
+  __dirname,
+  "../../",
+  "validators/companies/company-schema.yaml"
+);
+
+// Load and parse YAML schema file
+const schemaFile = fs.readFileSync(companySchema, "utf8");
+const schema = yaml.parse(schemaFile);
+
+// Create an Ajv instance
+const ajv = new Ajv();
+const validate = ajv.compile(schema);
+
+// Get all categories (company files)
+const categories = fs.readdirSync(companiesDatasetDir);
+
+// Validate files 1 by 1
+for (category of categories) {
+  const companies = fs.readFileSync(
+    `${companiesDatasetDir}/${category}`,
+    "utf8"
+  );
+  const data = yaml.parse(companies);
+
+  const valid = validate(data);
+  if (!valid) {
+    console.log("Validation errors:", validate.errors);
+    process.exit(1);
+  }
+}
+
+console.log("YAML data is valid!");

validators/companies/company-schema.yaml

@@ -0,0 +1,35 @@
+type: array
+items:
+  type: object
+  properties:
+    Name:
+      type: string
+      maxLength: 50
+    Description:
+      type: string
+      maxLength: 500
+    Website:
+      type: string
+      maxLength: 50
+    Alternatives:
+      type: array
+      items:
+        type: object
+        properties:
+          Name:
+            type: string
+            maxLength: 50
+          Description:
+            type: string
+            maxLength: 500
+          Website:
+            type: string
+            maxLength: 50
+        required:
+          - Name
+          - Website
+        additionalProperties: false
+  required:
+    - Name
+    - Website
+  additionalProperties: false