Merge pull request #163 from opencloud-eu/chore/remove-component-doc-blocks

chore: remove component doc blocks

Author: kulmann

packages/design-system/docs/.vitepress/config.ts

@@ -21,18 +21,6 @@ export default defineConfig({
       }
     },
     plugins: [
-      // TODO: remove when doc blocks have been removed
-      {
-        name: '@opencloud-eu/vite-plugin-docs',
-        transform(src, id) {
-          if (id.includes('type=docs')) {
-            return {
-              code: 'export default {}',
-              map: null
-            }
-          }
-        }
-      },
       {
         name: '@opencloud-eu/vite-plugin-strip-css',
         transform(src, id) {

packages/design-system/docs/.vitepress/theme/index.ts

@@ -10,8 +10,7 @@ export default {
     const gettext = createGettext()
     app.use(gettext)
 
-    // TODO: remove `|| c.name` when all components follow the script setup syntax
-    Object.values(components).forEach((c) => app.component(c.__name || c.name, c))
+    Object.values(components).forEach((c) => app.component(c.__name, c))
     Object.values(directives).forEach((d) => app.directive(d.name, d))
   }
 }

packages/design-system/src/components/OcSelect/OcSelect.vue

@@ -108,13 +108,6 @@ import { useGettext } from 'vue3-gettext'
 import 'vue-select/dist/vue-select.css'
 import { ContextualHelper } from '../../helpers'
 
-// the keycode property is deprecated in the JS event API, vue-select still works with it though
-enum KeyCode {
-  Enter = 13,
-  ArrowDown = 40,
-  ArrowUp = 38
-}
-
 export interface Props {
   id?: string
   filter?: (items: unknown[], search: string, { label }: { label?: string }) => unknown[]
@@ -135,6 +128,13 @@ export interface Props {
   positionFixed?: boolean
 }
 
+// the keycode property is deprecated in the JS event API, vue-select still works with it though
+enum KeyCode {
+  Enter = 13,
+  ArrowDown = 40,
+  ArrowUp = 38
+}
+
 const {
   id = uniqueId('oc-select-'),
   filter = (items: unknown[], search: string, { label }: { label?: string }) => {

packages/design-system/src/components/OcTable/OcTable.sort.spec.ts

@@ -111,7 +111,7 @@ describe('OcTable.sort', () => {
       async (name, { sortBy, sortDir, ariaSort }) => {
         await wrapper.setProps({
           sortBy,
-          sortDir
+          sortDir: sortDir as 'asc' | 'desc'
         })
         expect(headers.at(1).attributes()['aria-sort']).toBe(ariaSort)
       }
@@ -124,7 +124,7 @@ describe('OcTable.sort', () => {
         props: {
           fields: tableFields,
           sortBy: tableFieldId.name,
-          sortDir: tableFieldId.sortDir,
+          sortDir: tableFieldId.sortDir as 'asc' | 'desc',
           data
         },
         global: {
@@ -171,7 +171,7 @@ describe('OcTable.sort', () => {
             fields: tableFields,
             data,
             sortBy: sortByOld,
-            sortDir: sortDirOld
+            sortDir: sortDirOld as 'asc' | 'desc'
           },
           global: {
             plugins: [...defaultPlugins()],

packages/design-system/src/components/OcTable/OcTable.spec.ts

@@ -1,4 +1,4 @@
-import { shallowMount, mount } from '@opencloud-eu/web-test-helpers'
+import { shallowMount, mount, defaultPlugins } from '@opencloud-eu/web-test-helpers'
 import Table from './OcTable.vue'
 
 const fields = [
@@ -46,6 +46,7 @@ const data = [
 describe('OcTable', () => {
   it('displays all field types', () => {
     const wrapper = mount(Table, {
+      global: { plugins: defaultPlugins() },
       props: {
         fields,
         data
@@ -70,6 +71,7 @@ describe('OcTable', () => {
 
   it('hides header', () => {
     const wrapper = shallowMount(Table, {
+      global: { plugins: defaultPlugins() },
       props: {
         fields,
         data,
@@ -82,6 +84,7 @@ describe('OcTable', () => {
 
   it('enables hover effect', () => {
     const wrapper = shallowMount(Table, {
+      global: { plugins: defaultPlugins() },
       props: {
         fields,
         data,
@@ -107,7 +110,7 @@ describe('OcTable', () => {
           }
         ]
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
 
     expect(wrapper.html().indexOf('resource-name')).toBeGreaterThan(-1)
@@ -137,7 +140,7 @@ describe('OcTable', () => {
           }
         ]
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
 
     expect(wrapper.html().indexOf('alignh="right"')).toBeGreaterThan(-1)
@@ -147,6 +150,7 @@ describe('OcTable', () => {
 
   it('adds sticky header', () => {
     const wrapper = shallowMount(Table, {
+      global: { plugins: defaultPlugins() },
       props: {
         fields,
         data,
@@ -164,7 +168,7 @@ describe('OcTable', () => {
         data,
         highlighted: '4b136c0a-5057-11eb-ac70-eba264112003'
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
 
     expect(wrapper.findAll('.oc-table-highlighted').length).toEqual(1)
@@ -180,7 +184,7 @@ describe('OcTable', () => {
           '8468c9f0-5057-11eb-924b-934c6fd827a2'
         ]
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
 
     expect(wrapper.findAll('.oc-table-highlighted').length).toEqual(2)
@@ -193,7 +197,7 @@ describe('OcTable', () => {
         data,
         highlighted: []
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
     expect(wrapper.html().indexOf('data-item-id')).toBeGreaterThan(-1)
   })
@@ -206,7 +210,7 @@ describe('OcTable', () => {
         highlighted: [],
         itemDomSelector: (item: { id: string }) => ['custom', item.id].join('-')
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
     data.forEach((item) => {
       expect(wrapper.find(['.oc-tbody-tr-custom', item.id].join('-')).exists()).toBeTruthy()
@@ -220,7 +224,7 @@ describe('OcTable', () => {
         data,
         highlighted: []
       },
-      global: { renderStubDefaultSlot: true, stubs: { OcTr: false } }
+      global: { renderStubDefaultSlot: true, stubs: { OcTr: false }, plugins: defaultPlugins() }
     })
     await wrapper.find('.oc-tbody-tr').trigger('contextmenu')
     expect(wrapper.emitted().contextmenuClicked.length).toBe(1)
@@ -234,7 +238,7 @@ describe('OcTable', () => {
         highlighted: [],
         dragDrop: true
       },
-      global: { renderStubDefaultSlot: true }
+      global: { renderStubDefaultSlot: true, plugins: defaultPlugins() }
     })
     expect(wrapper.html().indexOf('draggable')).toBeGreaterThan(-1)
   })