fix(*): fix XSD generation (#495)

TheOpenDictionary · Oct 30, 2023 · 8dd4218 · 8dd4218
1 parent bfe8ad4
commit 8dd4218
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 36 deletions.
diff --git a/examples/dictionary.xml b/examples/dictionary.xml
@@ -3,7 +3,7 @@
  <ety>
  <sense pos="n">
  <definition value="A book or electronic resource that lists the words of a language and gives their meaning or translation">
- <example>I'll look up “love” in the dictionary</example>
+ <example yo="poop">I'll look up “love” in the dictionary</example>
  <example>The website gives access to an online dictionary</example>
  <example>The dictionary definition of “smile”</example>
  </definition>

diff --git a/examples/example1.xml b/examples/example1.xml
@@ -1,4 +1,6 @@
-<dictionary name="Example Dictionary 1">
+<?xml version="1.0" encoding="UTF-8"?>
+<dictionary name="Example Dictionary 1"
+ xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../odict.xsd">
  <entry term="run">
  <ety description="Latin root">
  <sense pos="v">

diff --git a/justfile b/justfile
@@ -1,3 +1,5 @@
+GOLANG_CROSS_VERSION := "v1.21.3"
+
 # ---------------------------------------------------------------------------- #
 # Global #
 # ---------------------------------------------------------------------------- #
@@ -14,13 +16,13 @@
 
 @schema: (go "schema") (cli "schema") (js "schema")
 
-@run +args="": build
- go run odict {{args}}
- 
-@xsd: 
- go run xsd/xsd.go 
+@xsd:
+ go run xsd/xsd.go
+
+@run +args="":
+ go run odict.go {{args}}
 
-@test: deps (go "test") (jvm "test") (python "test") (js "test") clean
+@test: deps xsd (go "test") (jvm "test") (python "test") (js "test") clean
 
 @clean: (python "clean") (jvm "clean") (js "clean")
  rm -rf **/*.odict 

diff --git a/lib/types/definition.go b/lib/types/definition.go
@@ -8,8 +8,8 @@ import (
 type DefinitionRepresentable struct {
  ID string `json:"id,omitempty" xml:"id,attr,omitempty"`
  Value MDString `json:"value,omitempty" xml:"value,attr"`
- Examples []string `json:"examples,omitempty" xml:"example"`
- Notes []NoteRepresentable `json:"notes,omitempty" xml:"note"`
+ Examples []string `json:"examples,omitempty" xml:"example,omitempty"`
+ Notes []NoteRepresentable `json:"notes,omitempty" xml:"note,omitempty"`
 }
 
 func (definition *Definition) AsRepresentable() DefinitionRepresentable {

diff --git a/lib/types/dictionary.go b/lib/types/dictionary.go
@@ -8,7 +8,7 @@ import (
 )
 
 type DictionaryRepresentable struct {
- ID string `json:"id" xml:"id,attr"`
+ ID string `json:"id" xml:"id,attr,omitempty"`
  Name string `json:"name" xml:"name,attr,omitempty"`
  Entries KVMap[string, EntryRepresentable] `json:"entries" xml:"entry"`
  XMLName xml.Name `json:"-" xml:"dictionary"`

diff --git a/lib/types/entry.go b/lib/types/entry.go
@@ -11,7 +11,7 @@ type EntryRepresentable struct {
  Term string `json:"term" xml:"term,attr"`
  Pronunciation string `json:"pronunciation,omitempty" xml:"pronunciation,attr,omitempty"`
  SeeAlso string `json:"see,omitempty" xml:"see,attr,omitempty"`
- Etymologies []EtymologyRepresentable `json:"etymologies" xml:"ety"`
+ Etymologies []EtymologyRepresentable `json:"etymologies" xml:"ety,omitempty"`
  XMLName xml.Name `json:"-" xml:"entry"`
 }
 

diff --git a/lib/types/group.go b/lib/types/group.go
@@ -6,7 +6,7 @@ import (
 
 type GroupRepresentable struct {
  ID string `json:"id,omitempty" xml:"id,attr,omitempty"`
- Description MDString `json:"description" xml:"description,attr"`
+ Description MDString `json:"description" xml:"description,attr,omitempty"`
  Definitions []DefinitionRepresentable `json:"definitions" xml:"definition"`
 }
 

diff --git a/lib/types/sense.go b/lib/types/sense.go
@@ -8,9 +8,9 @@ import (
 )
 
 type SenseRepresentable struct {
- POS PartOfSpeech `json:"-" xml:"pos,attr"`
- Definitions []DefinitionRepresentable `json:"definitions,omitempty" xml:"definition"`
- Groups []GroupRepresentable `json:"groups,omitempty" xml:"group"`
+ POS PartOfSpeech `json:"-" xml:"pos,attr,omitempty"`
+ Groups []GroupRepresentable `json:"groups,omitempty" xml:"group,omitempty"`
+ Definitions []DefinitionRepresentable `json:"definitions,omitempty" xml:"definition,omitempty"`
  XMLName xml.Name `json:"-" xml:"sense"`
 }
 

diff --git a/odict.xsd b/odict.xsd
@@ -6,58 +6,58 @@
  <xs:element minOccurs="1" maxOccurs="unbounded" name="entry">
  <xs:complexType>
  <xs:sequence>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="ety">
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="ety">
  <xs:complexType>
  <xs:sequence>
  <xs:element minOccurs="1" maxOccurs="unbounded" name="sense">
  <xs:complexType>
  <xs:sequence>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="definition">
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="group">
  <xs:complexType>
  <xs:sequence>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="example" type="xs:string" />
- <xs:element minOccurs="1" maxOccurs="unbounded" name="note">
+ <xs:element minOccurs="1" maxOccurs="unbounded" name="definition">
  <xs:complexType>
  <xs:sequence>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="example" type="xs:string" />
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="example" type="xs:string" />
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="note">
+ <xs:complexType>
+ <xs:sequence>
+ <xs:element minOccurs="1" maxOccurs="unbounded" name="example" type="xs:string" />
+ </xs:sequence>
+ <xs:attribute name="id" type="xs:string" />
+ <xs:attribute use="required" name="value" type="xs:string" />
+ </xs:complexType>
+ </xs:element>
  </xs:sequence>
  <xs:attribute name="id" type="xs:string" />
  <xs:attribute use="required" name="value" type="xs:string" />
  </xs:complexType>
  </xs:element>
  </xs:sequence>
  <xs:attribute name="id" type="xs:string" />
- <xs:attribute use="required" name="value" type="xs:string" />
+ <xs:attribute name="description" type="xs:string" />
  </xs:complexType>
  </xs:element>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="group">
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="definition">
  <xs:complexType>
  <xs:sequence>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="definition">
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="example" type="xs:string" />
+ <xs:element minOccurs="0" maxOccurs="unbounded" name="note">
  <xs:complexType>
  <xs:sequence>
  <xs:element minOccurs="1" maxOccurs="unbounded" name="example" type="xs:string" />
- <xs:element minOccurs="1" maxOccurs="unbounded" name="note">
- <xs:complexType>
- <xs:sequence>
- <xs:element minOccurs="1" maxOccurs="unbounded" name="example" type="xs:string" />
- </xs:sequence>
- <xs:attribute name="id" type="xs:string" />
- <xs:attribute use="required" name="value" type="xs:string" />
- </xs:complexType>
- </xs:element>
  </xs:sequence>
  <xs:attribute name="id" type="xs:string" />
  <xs:attribute use="required" name="value" type="xs:string" />
  </xs:complexType>
  </xs:element>
  </xs:sequence>
  <xs:attribute name="id" type="xs:string" />
- <xs:attribute use="required" name="description" type="xs:string" />
+ <xs:attribute use="required" name="value" type="xs:string" />
  </xs:complexType>
  </xs:element>
  </xs:sequence>
- <xs:attribute use="required" name="pos" type="xs:string" />
+ <xs:attribute name="pos" type="xs:string" />
  </xs:complexType>
  </xs:element>
  </xs:sequence>
@@ -72,7 +72,7 @@
  </xs:complexType>
  </xs:element>
  </xs:sequence>
- <xs:attribute use="required" name="id" type="xs:string" />
+ <xs:attribute name="id" type="xs:string" />
  <xs:attribute name="name" type="xs:string" />
  </xs:complexType>
  </xs:element>