ci: missing CLI tests in matrix (#264)

* ci: missing CLI tests in matrix

* ci: use package name in matrix

* ci: make sure coverage is separate

* test: fix watch test

* build: fix types

* test: final fixes

Author: tpluscode

.github/workflows/tests.yml

@@ -13,6 +13,8 @@ jobs:
       matrix:
         node: [ 18, 20, "lts/*" ]
         package:
+          - name: kopflos
+            path: packages/cli
           - name: "@kopflos-cms/core"
             path: packages/core
           - name: "@kopflos-cms/express"
@@ -40,7 +42,7 @@ jobs:
         with:
           node-version: ${{ matrix.node }}
       - run: npm ci
-      - run: npx c8 --all --src ${{ matrix.package.path }} --reporter lcovonly --reporter text npm run -w ${{ matrix.package.path }} test
+      - run: npx c8 --all --src ${{ matrix.package.path }} --include ${{ matrix.package.path }} --reporter lcovonly --reporter text npm run -w ${{ matrix.package.name }} test
       - name: Codecov
         uses: codecov/codecov-action@v4
         with:

packages/cli/lib/config.ts

@@ -32,7 +32,7 @@ export async function loadConfig({ path, root }: LoadConfig): Promise<{ config:
   const { config: { plugins, ...config }, ...rest } = ccResult
   return {
     config: {
-      plugins: Array.isArray(plugins) ? plugins : await loadPlugins(plugins),
+      plugins: Array.isArray(plugins) ? plugins : await loadPlugins(dirname(rest.filepath), plugins),
       ...config,
     },
     ...rest,

packages/cli/lib/plugins.ts

@@ -1,11 +1,14 @@
+import module from 'node:module'
 import type { KopflosPlugin } from '@kopflos-cms/core'
 import { createLogger } from '@kopflos-cms/logger'
 
+const require = module.createRequire(import.meta.url)
+
 type KopflosPluginConstructor = new (options: unknown) => KopflosPlugin
 
 const log = createLogger('kopflos')
 
-export async function loadPlugins(plugins: Record<string, unknown>): Promise<KopflosPlugin[]> {
+export async function loadPlugins(root: string, plugins: Record<string, unknown> = {}): Promise<KopflosPlugin[]> {
   const pluginsCombined = Object.entries(plugins).filter(([plugin, options]) => {
     if (options === false) {
       log.debug('Skipping disabled plugin', plugin)
@@ -18,7 +21,12 @@ export async function loadPlugins(plugins: Record<string, unknown>): Promise<Kop
   return Promise.all(pluginsCombined.map(async ([plugin, options]) => {
     log.info('Loading plugin', plugin)
 
-    const [module, exportName = 'default'] = plugin.split('#')
+    let [module, exportName = 'default'] = plugin.split('#')
+
+    // if module is relative, resolve it relative to the root of the project
+    if (module.startsWith('.')) {
+      module = require.resolve(module, { paths: [root] })
+    }
 
     const Plugin: KopflosPluginConstructor = (await import(module))[exportName]
     return new Plugin(options)

packages/cli/test/fixtures/foo/bar.ts

@@ -0,0 +1 @@
+export default class {}

packages/cli/test/lib/command/serve.test.ts

@@ -14,13 +14,23 @@ describe('kopflos/lib/command/serve', function () {
 
   beforeEach(createEmpty)
 
+  before(function () {
+    if (!fs.existsSync(fixturesDir)) {
+      fs.mkdirSync(fixturesDir)
+    }
+  })
+
   beforeEach(function () {
-    process = fork(serve)
-    fs.mkdirSync(fixturesDir)
+    process = fork(serve, {
+      execArgv: ['--import', 'tsx'],
+    })
   })
 
   afterEach(function () {
     process.kill()
+  })
+
+  after(function () {
     fs.rmSync(fixturesDir, { recursive: true, force: true })
   })
 
@@ -39,7 +49,10 @@ describe('kopflos/lib/command/serve', function () {
           }
         })
 
-        fs.writeFileSync(new URL('./file.txt', fixturesDir), '')
+        new Promise(resolve => setTimeout(resolve, 1000))
+          .then(() => {
+            fs.writeFileSync(new URL('./file.txt', fixturesDir), '')
+          })
       }))
     })
 
@@ -76,7 +89,10 @@ describe('kopflos/lib/command/serve', function () {
           }
         })
 
-        fs.writeFileSync(new URL('./file.txt', fixturesDir), '')
+        new Promise(resolve => setTimeout(resolve, 1000))
+          .then(() => {
+            fs.writeFileSync(new URL('./file.txt', fixturesDir), '')
+          })
       }))
     })
 

packages/cli/test/lib/config.test.ts

@@ -1,6 +1,7 @@
 import url from 'node:url'
 import { expect } from 'chai'
 import { loadConfig, prepareConfig } from '../../lib/config.js'
+import BarPlugin from '../fixtures/foo/bar.js'
 
 describe('kopflos/lib/config.js', function () {
   this.timeout(10000)
@@ -29,6 +30,7 @@ describe('kopflos/lib/config.js', function () {
       // given
       expect(config).to.be.deep.equal({
         baseIri: 'https://example.com/',
+        plugins: [],
       })
     })
   })
@@ -79,9 +81,8 @@ describe('kopflos/lib/config.js', function () {
       })
 
       // then
-      expect(config.plugins).to.contain.keys([
-        url.fileURLToPath(new URL('../fixtures/foo/bar.js', import.meta.url)),
-      ])
+      expect(config.plugins).to.have.length(1)
+      expect(config.plugins![0]).to.be.instanceOf(BarPlugin)
     })
   })
 })

packages/plugin-deploy-resources/index.ts

@@ -13,7 +13,7 @@ interface Options {
 }
 
 interface DeployResourcesPlugin extends KopflosPlugin {
-  deploy(env: KopflosEnvironment, plugins: KopflosPlugin[]): Promise<void>
+  deploy(env: KopflosEnvironment, plugins: readonly KopflosPlugin[]): Promise<void>
 }
 
 declare module '@kopflos-cms/core' {
@@ -74,7 +74,7 @@ export default class implements DeployResourcesPlugin {
     return this.deploy(instance.env, instance.plugins)
   }
 
-  async deploy(env: KopflosEnvironment, plugins: KopflosPlugin[]) {
+  async deploy(env: KopflosEnvironment, plugins: readonly KopflosPlugin[]) {
     const dataset = await plugins.reduce(async (promise, plugin) => {
       if (!plugin.deployedResources) {
         return promise