Merge pull request #362 from meatpiHQ/standard_params

Standardise Params

Author: meatpiHQ

.github/workflows/vehicle_profiles.yml

@@ -26,10 +26,12 @@ jobs:
           cd .vehicle_profiles
           npm ci
           npm run build
+          npx prettier ../vehicle_profiles --write
+          npx prettier . --write
           cd -
       - name: Commit
         uses: EndBug/add-and-commit@v9
         with:
-          add: 'vehicle_profiles.json docs/content/0.Config/6.Automate/2.Supported_Vehicles.md'
+          add: 'vehicle_profiles.json docs/content/0.Config/6.Automate/2.Supported_Vehicles.md vehicle_profiles/ .vehicle_profiles/'
           author_name: Jay Oswald
           author_email: jay@oswald.net.au

.vehicle_profiles/.prettierrc

@@ -0,0 +1,3 @@
+{
+  "plugins": ["prettier-plugin-sort-json"]
+}

.vehicle_profiles/merge.js

@@ -1,51 +1,84 @@
-import { glob } from 'glob'
-import { readFile, writeFile } from 'fs/promises';
+import { glob } from "glob";
+import { readFile, writeFile } from "fs/promises";
+import editJsonFile from "edit-json-file";
 
-const source_folder = '../vehicle_profiles';
-const target = '../vehicle_profiles.json'
+const source_folder = "../vehicle_profiles";
+const target = "../vehicle_profiles.json";
 
-const files = await glob(source_folder + '/**/*.json');
+const files = await glob(source_folder + "/**/*.json");
+const params = JSON.parse(await readFile("params.json"));
+
+let param_array = Object.getOwnPropertyNames(params);
+let schema_file = editJsonFile("schema.json");
+const PARAM_PATH =
+  "properties.pids.items.properties.parameters.propertyNames.enum";
+let existing_params = schema_file.get(PARAM_PATH);
+if (existing_params !== param_array) {
+  schema_file.set(PARAM_PATH, param_array);
+  schema_file.save();
+}
 
 let result = {
-    'cars': []
+  cars: [],
 };
 
-async function add_json(path){
-    let data = JSON.parse(await readFile(path));
-    result.cars.push(data)
+async function add_json(path) {
+  let data = JSON.parse(await readFile(path));
+  Object.keys(data.pids).forEach((key) => {
+    let newParams = [];
+    for (const [param, exp] of Object.entries(data.pids[key].parameters)) {
+      newParams.push({
+        name: param,
+        expression: exp,
+        ...params[param].settings,
+      });
+    }
+    data.pids[key].parameters = newParams;
+  });
+  result.cars.push(data);
 }
 
 let promises = [];
-files.forEach(file => {
-    promises.push(add_json(file));
+files.forEach((file) => {
+  promises.push(add_json(file));
 });
 
 await Promise.all(promises);
 
-result.cars.sort((a,b) => {
-    let first = a.car_model.toLowerCase();
-    let second = b.car_model.toLowerCase();
-    return (first < second) ? -1 : (first > second ) ? 1 : 0;
+result.cars.sort((a, b) => {
+  let first = a.car_model.toLowerCase();
+  let second = b.car_model.toLowerCase();
+  return first < second ? -1 : first > second ? 1 : 0;
 });
 
 const resultString = JSON.stringify(result);
 //Use below line instead for generating pretty json
 // result = JSON.stringify(result, null, 2);
-await writeFile(target, resultString)
-
-const models = result.cars.map(car => car.car_model).filter(model => model !== 'AAA: Generic');
-let supportedVehiclesListContent = '';
-supportedVehiclesListContent += '<!--\n';
-supportedVehiclesListContent += '================================================================\n'
-supportedVehiclesListContent += 'THIS FILE WAS GENERATED! DO NOT UPDATE OR YOUR CHANGES ARE LOST!\n'
-supportedVehiclesListContent += '================================================================\n'
-supportedVehiclesListContent += '-->\n';
-supportedVehiclesListContent += '# Supported Vehicles\n';
-supportedVehiclesListContent += 'For vehicles listed below a WiCAN vehicle profiles exists:\n';
-models.forEach(model => supportedVehiclesListContent += `- ${model}\n`);
-
-const supportedVehiclesListFilepath = await glob('../docs/content/*.Config/*.Automate/*.Supported_Vehicles.md')
-if(supportedVehiclesListFilepath.length == 0 || supportedVehiclesListFilepath.length != 1) {
-    throw new Error('Unable to determine automateDirectory');
+await writeFile(target, resultString);
+
+const models = result.cars
+  .map((car) => car.car_model)
+  .filter((model) => model !== "AAA: Generic");
+let supportedVehiclesListContent = 
+`<!--
+
+================================================================
+THIS FILE WAS GENERATED! DO NOT UPDATE OR YOUR CHANGES ARE LOST!
+================================================================
+
+-->
+# Supported Vehicles
+For vehicles listed below a WiCAN vehicle profiles exists:
+`;
+models.forEach((model) => ( supportedVehiclesListContent += `- ${model}\n`));
+
+const supportedVehiclesListFilepath = await glob(
+  "../docs/content/*.Config/*.Automate/*.Supported_Vehicles.md",
+);
+if (
+  supportedVehiclesListFilepath.length == 0 ||
+  supportedVehiclesListFilepath.length != 1
+) {
+  throw new Error("Unable to determine automateDirectory");
 }
-await writeFile(supportedVehiclesListFilepath[0], supportedVehiclesListContent);
+await writeFile(supportedVehiclesListFilepath[0], supportedVehiclesListContent);

.vehicle_profiles/package-lock.json

@@ -12,6 +12,11 @@
   "type": "module",
   "dependencies": {
     "ajv": "^8.17.1",
-    "glob": "^11.0.0"
+    "edit-json-file": "^1.8.1",
+    "glob": "^11.0.0",
+    "prettier": "^3.5.3"
+  },
+  "devDependencies": {
+    "prettier-plugin-sort-json": "^4.1.1"
   }
 }