@forsakringskassan/vite-lib-config

Toolchain for building Vue framework libraries.

• Hybrid ESM/CJS packages.
• Transpiled with Babel.
• Supports monorepo.
• Optional: build pageobjects, selectors, and mocks.
• Optional: shared typescript configuration.

Configuration

Use fk-write-config to write boilerplate configuration files to the repository:

fk-write-config

API Extractor is optiona and must be enabled with --with-api-extractor.

By default it assumes vitest is used as test runner, use --with-jest or --with-vitest to explicitly set a test runner.

Bundled dependencies

By default all dependencies (dependencies and peerDependencies) are marked as external and not bundled in output files. This can be overriden by setting externalDependencies in package.json:

     "dependencies": {
         "lodash": "^4.17.20"
     },
+    "externalDependencies": [
+        "lodash"
+    ],

Usage

babel.config.js

module.exports = {
    presets: ["@forsakringskassan/vite-lib-config/babel"],
};

vite.config.ts

import { defineConfig } from "@forsakringskassan/vite-lib-config/vite";

export default defineConfig();

In addition to the regular Vite configuration you can also pass the optional fk property:

export interface FKConfig {
    /** path to component to mount by default (default `src/dev-vite/app.vue`) */
    entrypoint?: string;
    /** mocks to configure with apimock-express (default `[]`) */
    mocks?: MockEntry[] | Mock[]
}

package.json

{
    "scripts": {
        "build": "fk-build-vue-lib"
    }
}

Optional: API Extractor

 {
     "scripts": {
         "build": "fk-build-vue-lib",
+        "postbuild": "fk-api-extractor api-extractor.json",
     }
 }

Multiple files or globs can be given:

fk-api-extractor api-extractor.*.json

To fix global module augmentations use:

fk-api-extractor --patch-augmentations

Use --help to see full description.

Optional: build pageobjects and selectors

 {
     "scripts": {
         "build": "fk-build-vue-lib",
+        "build:selectors": "fk-build-selectors",
     }
 }

If src/selectors/index.ts it will be built to dist/${format}/selectors.${cjs,mjs}.

If src/cypress/index.ts it will be built to dist/${format}/cypress.${cjs,mjs}.

Optional: build mocks

 {
     "scripts": {
         "build": "fk-build-vue-lib --mocks",
     }
 }

This builds src/mocks/index.ts to dist/${format}/mocks.${cjs,mjs}. The file must export a list of mocks of type apimock-express (MockEntry[] or Mock[]).

src/mocks/index.ts

import { type Mock } from "@forsakringskassan/apimock-express";

const mocks: Mock[] = [...];
export default mocks;

Dev-server

{
    "scripts": {
        "start": "vite"
    }
}

Create src/local.{ts,mts,mjs,js} exporting a single function setup:

import { createApp } from "vue";
import { type SetupOptions } from "@forsakringskassan/vite-lib-config";

export function setup(options: SetupOptions): void {
    const { rootComponent, selector } = options;
    const app = createApp(rootComponent);
    app.mount(selector);
}

If the setup function is async (i.e. returns a Promise) it will be awaited before continuing.

Create src/vite-dev/app.vue containing the root component you want to serve as a development environment.

When running in dev mode an optional filename (or part of filename) can be given to run instead of default src/vite-dev/app.vue:

vite -- MyAwesomeExample

would search for .vue files matching the given pattern (fuzzy) in these folders:

• **/docs
• **/examples
• **/test

Appending Plugins

If you need to use custom plugins in your library, remember to also include the default plugins, these will otherwise by overwritten.

vite.config.ts

import {
    defineConfig,
    defaultPlugins,
} from "@forsakringskassan/vite-lib-config/vite";

export default defineConfig({
    plugins: [...defaultPlugins, myFancyPlugin],
});