Merge pull request #205 from citation-file-format/166-validate-file

add file validation

Author: fdiblen

src/components/Preview.vue

@@ -35,16 +35,24 @@
             <pre>{{ cffstr }}</pre>
         </q-card-section>
     </q-card>
+    <div class="row justify-center q-pt-md">
+        <p>
+            Your CITATION.cff is&nbsp;
+        </p>
+        <span v-if="isValid">valid</span>
+        <span v-else>invalid</span>
+    </div>
 </template>
 
 <script lang="ts">
-import { defineComponent, ref } from 'vue'
+import { defineComponent, ref, computed } from 'vue'
 import { useCffstr } from 'src/store/cffstr'
+import { isValidCffFile } from 'src/validator'
 
 export default defineComponent({
     name: 'Preview',
     setup () {
-        const cffstr = useCffstr()
+        const { cffstr } = useCffstr()
         const showTooltip = ref(false)
 
         const copyToClipboard = async () => {
@@ -54,9 +62,12 @@ export default defineComponent({
             showTooltip.value = false
         }
 
+        const isValid = computed(isValidCffFile)
+
         return {
             cffstr,
             copyToClipboard,
+            isValid,
             showTooltip
         }
     }

src/store/cffstr.ts

@@ -70,5 +70,8 @@ export function useCffstr () {
         return yaml.dump(kebabed, { indent: 2, sortKeys: true })
     }
 
-    return computed(() => makeCffstr())
+    return {
+        jsObject: computed(makeJavascriptObject),
+        cffstr: computed(makeCffstr)
+    }
 }

src/validator.ts

@@ -1,11 +1,17 @@
 import Ajv from 'ajv'
 import addFormats from 'ajv-formats'
 import schema from './schemas/1.2.0/schema.json'
+import { useCffstr } from './store/cffstr'
 
 export const ajv = new Ajv()
 addFormats(ajv)
 ajv.addSchema(schema)
 
+export const isValidCffFile = () => {
+    const { jsObject } = useCffstr()
+    return ajv.validate(`${schema.$id}`, jsObject.value)
+}
+
 export const makeFieldValidator = (subschema: string) => {
     return (val: unknown) => {
         const isValid = ajv.validate(`${schema.$id}#${subschema}`, val)

test/jest/__tests__/store/cffstr.jest.spec.ts

@@ -4,7 +4,7 @@ import { useCffstr } from '../../../../src/store/cffstr'
 
 describe('useCffstr', () => {
     const cff = useCff()
-    const cffstr = useCffstr()
+    const { cffstr } = useCffstr()
 
     beforeEach(() => {
         cff.reset()