chore: refactor script to build JSON examples (#183)

theopensystemslab · Jun 27, 2024 · e9a827c · e9a827c
1 parent 2fe4ed5
commit e9a827c
Show file tree

Hide file tree

Showing 13 changed files with 35 additions and 35 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -44,7 +44,7 @@ jobs:
           mv types/* "$GITHUB_WORKSPACE/v${{ steps.version_check.outputs.version }}/types"
 
           mkdir -p "$GITHUB_WORKSPACE/v${{ steps.version_check.outputs.version }}/examples"
-          mv examples/*.json "$GITHUB_WORKSPACE/v${{ steps.version_check.outputs.version }}/examples"
+          cp -r examples/**/*.json "$GITHUB_WORKSPACE/v${{ steps.version_check.outputs.version }}/examples"
 
       - name: Checkout Dist Branch
         if: steps.version_check.outputs.changed == 'true'

diff --git a/examples/data/ldcE.ts → .../lawfulDevelopmentCertificate/existing.ts b/examples/data/ldcE.ts → .../lawfulDevelopmentCertificate/existing.ts
@@ -1,8 +1,8 @@
-import {Schema} from '../../types/Schema';
+import {Schema} from '../../../types/Schema';
 
 const version = process.env['VERSION'] || '@next';
 
-export const validLDCE: Schema = {
+export const lawfulDevelopmentCertificateExisting: Schema = {
   data: {
     application: {
       type: {

diff --git a/examples/data/ldcP.ts → .../lawfulDevelopmentCertificate/proposed.ts b/examples/data/ldcP.ts → .../lawfulDevelopmentCertificate/proposed.ts
@@ -1,8 +1,8 @@
-import {Schema} from '../../types/Schema';
+import {Schema} from '../../../types/Schema';
 
 const version = process.env['VERSION'] || '@next';
 
-export const validLDCP: Schema = {
+export const lawfulDevelopmentCertificateProposed: Schema = {
   data: {
     application: {
       type: {

diff --git a/examples/data/listedBuildingConsent.ts b/examples/data/listedBuildingConsent.ts
@@ -2,7 +2,7 @@ import {Schema} from '../../types/Schema';
 
 const version = process.env['VERSION'] || '@next';
 
-export const validListedBuildingConsent: Schema = {
+export const listedBuildingConsent: Schema = {
   data: {
     user: {
       role: 'applicant',

diff --git a/examples/data/planningPermission.ts → ...ata/planningPermission/fullHouseholder.ts b/examples/data/planningPermission.ts → ...ata/planningPermission/fullHouseholder.ts
@@ -1,8 +1,8 @@
-import {Schema} from '../../types/Schema';
+import {Schema} from '../../../types/Schema';
 
 const version = process.env['VERSION'] || '@next';
 
-export const validPlanningPermission: Schema = {
+export const planningPermissionFullHouseholder: Schema = {
   data: {
     application: {
       type: {

diff --git a/examples/data/priorApproval.ts → examples/data/priorApproval/solarPanels.ts b/examples/data/priorApproval.ts → examples/data/priorApproval/solarPanels.ts
@@ -1,8 +1,8 @@
-import {Schema} from '../../types/Schema';
+import {Schema} from '../../../types/Schema';
 
 const version = process.env['VERSION'] || '@next';
 
-export const validPriorApproval: Schema = {
+export const priorApprovalSolarPanels: Schema = {
   data: {
     application: {
       type: {

diff --git a/...LawfulDevelopmentCertificateExisting.json → ...awfulDevelopmentCertificate/existing.json b/...LawfulDevelopmentCertificateExisting.json → ...awfulDevelopmentCertificate/existing.json
diff --git a/...LawfulDevelopmentCertificateProposed.json → ...awfulDevelopmentCertificate/proposed.json b/...LawfulDevelopmentCertificateProposed.json → ...awfulDevelopmentCertificate/proposed.json
diff --git a/examples/validListedBuildingConsent.json → examples/listedBuildingConsent.json b/examples/validListedBuildingConsent.json → examples/listedBuildingConsent.json
diff --git a/examples/validPlanningPermission.json → ...s/planningPermission/fullHouseholder.json b/examples/validPlanningPermission.json → ...s/planningPermission/fullHouseholder.json
diff --git a/examples/validPriorApproval.json → examples/priorApproval/solarPanels.json b/examples/validPriorApproval.json → examples/priorApproval/solarPanels.json
diff --git a/scripts/build-json-examples.ts b/scripts/build-json-examples.ts
@@ -1,10 +1,10 @@
 import * as fs from 'fs';
 import * as path from 'path';
-import {validLDCE} from '../examples/data/ldcE';
-import {validLDCP} from '../examples/data/ldcP';
-import {validListedBuildingConsent} from '../examples/data/listedBuildingConsent';
-import {validPlanningPermission} from '../examples/data/planningPermission';
-import {validPriorApproval} from '../examples/data/priorApproval';
+import {lawfulDevelopmentCertificateExisting} from '../examples/data/lawfulDevelopmentCertificate/existing';
+import {lawfulDevelopmentCertificateProposed} from '../examples/data/lawfulDevelopmentCertificate/proposed';
+import {listedBuildingConsent} from '../examples/data/listedBuildingConsent';
+import {planningPermissionFullHouseholder} from '../examples/data/planningPermission/fullHouseholder';
+import {priorApprovalSolarPanels} from '../examples/data/priorApproval/solarPanels';
 import {Schema} from '../types/Schema';
 
 interface Example {
@@ -14,24 +14,24 @@ interface Example {
 
 const examplesToConvert: Example[] = [
   {
-    filename: 'validLawfulDevelopmentCertificateExisting',
-    data: validLDCE,
+    filename: 'lawfulDevelopmentCertificate/existing',
+    data: lawfulDevelopmentCertificateExisting,
   },
   {
-    filename: 'validLawfulDevelopmentCertificateProposed',
-    data: validLDCP,
+    filename: 'lawfulDevelopmentCertificate/proposed',
+    data: lawfulDevelopmentCertificateProposed,
   },
   {
-    filename: 'validPriorApproval',
-    data: validPriorApproval,
+    filename: 'priorApproval/solarPanels',
+    data: priorApprovalSolarPanels,
   },
   {
-    filename: 'validPlanningPermission',
-    data: validPlanningPermission,
+    filename: 'planningPermission/fullHouseholder',
+    data: planningPermissionFullHouseholder,
   },
   {
-    filename: 'validListedBuildingConsent',
-    data: validListedBuildingConsent,
+    filename: 'listedBuildingConsent',
+    data: listedBuildingConsent,
   },
 ];
 

diff --git a/tests/usage.test.ts b/tests/usage.test.ts
@@ -3,19 +3,19 @@ import addFormats from 'ajv-formats';
 import {Validator} from 'jsonschema';
 import {describe, expect, test} from 'vitest';
 
-import {validLDCE} from '../examples/data/ldcE';
-import {validLDCP} from '../examples/data/ldcP';
-import {validListedBuildingConsent} from '../examples/data/listedBuildingConsent';
-import {validPlanningPermission} from '../examples/data/planningPermission';
-import {validPriorApproval} from '../examples/data/priorApproval';
+import {lawfulDevelopmentCertificateExisting} from '../examples/data/lawfulDevelopmentCertificate/existing';
+import {lawfulDevelopmentCertificateProposed} from '../examples/data/lawfulDevelopmentCertificate/proposed';
+import {listedBuildingConsent} from '../examples/data/listedBuildingConsent';
+import {planningPermissionFullHouseholder} from '../examples/data/planningPermission/fullHouseholder';
+import {priorApprovalSolarPanels} from '../examples/data/priorApproval/solarPanels';
 import generatedSchema from '../schema/schema.json';
 
 const examplesToTest = [
-  validLDCE,
-  validLDCP,
-  validPriorApproval,
-  validPlanningPermission,
-  validListedBuildingConsent,
+  lawfulDevelopmentCertificateExisting,
+  lawfulDevelopmentCertificateProposed,
+  listedBuildingConsent,
+  planningPermissionFullHouseholder,
+  priorApprovalSolarPanels,
 ];
 
 describe("parsing using the 'jsonschema' library", () => {