@forsakringskassan/vue-lib-template 1.9.30 → 1.9.31

package/files/README.md

@@ -1,46 +1,74 @@
 # @forsakringskassan/vue-lib-template
 
-En mall för hur ett komponentbibliotek fungerar.
+A standardized template for Vue component libraries, with built-in support for updates.
+You are not left on your own after the first scaffold: the template keeps evolving, and your library can follow along.
 
-Läs mer i [guide för att skapa komponenter](./project-guide/index.md).
+## Why use this template?
 
-## Dokumentation
+Setting up a component library means choosing and configuring a bundler, test tools, linters, documentation and a release process, and making them work together.
+The template has already done this, so you can focus on your components.
 
-Bygg och starta dokumentationen med:
+Libraries based on it stay up to date, with the same standards, the same structure and the same goodness.
+
+- **Quick start.**
+  A working library with a single command.
+- **Toolchain included.**
+  No need to pick packages, match versions or write the configuration that ties them together.
+- **No expertise required.**
+  Deliver Vue components without deep toolchain knowledge.
+- **Easy to revive.**
+  A library catches up with a single update.
+- **Consistent.**
+  Many libraries can share the same standards and structure.
+- **Reference included.**
+  An example component shows the recommended way to build, test and document a component.
+
+## Getting started
+
+Projects are created with [Cloneman](https://github.com/Forsakringskassan/cloneman), which creates a project from a template and later helps you update it.
+Run:
+
+```bash
+npx cloneman@latest create my-component-library @forsakringskassan/vue-lib-template
+```
+
+Cloneman asks for the values the template needs, such as the URL to your code repository (or pass them with `--param key=value`).
+Then install the dependencies and build:
 
 ```bash
+cd my-component-library
+npm install
 npm run build
-npm run start:docs
 ```
 
-Dokumentationen kan nås på http://localhost:8080.
+The generated project contains its own [README](./project-guide/index.md) with instructions for daily development, testing, documentation and releases.
 
-Komponenter dokumenteras i `docs/components` katalogen.
-Varje komponent ska ha en tillhörande Markdown fil (`.md`) med ett inledande Frontmatter-block:
+## What you get
 
-```md
----
-title: Fantastisk komponent
-status: Draft
-layout: component
-component: AwesomeComponent
----
-```
+- Vue 3 component library built with [Vite](https://vite.dev/) and TypeScript, based on FKUI.
+- Unit tests with [Vitest](https://vitest.dev/) and component tests with [Cypress](https://www.cypress.io/).
+- Linting and formatting with ESLint, Stylelint, HTML-Validate and Prettier.
+- Public API tracking with API Extractor.
+- Documentation site with live examples, generated with [docs-generator](https://github.com/Forsakringskassan/docs-generator).
+- Automated versioning, changelog and publishing with semantic-release.
+- Renovate configuration for automated dependency updates.
 
-Exempel infogas med en code fence:
+## Keeping up to date with Cloneman
 
-````md
-```import
-${filename}
-```
-````
+The template is published as an npm package, and your project is tied to a specific version of it.
+When a new version is released, you bring your project up to date with a single command.
 
-Vue API dokumentation för komponenter infogas med ett api block:
+1. Run `npx cloneman@latest update` (or `update 1.2.3` for a specific version).
+2. Run `npm install`.
+3. Review the diff, run the tests and commit.
 
-```md
-::: api
-vue:${component}
-:::
-```
+An update is applied as ordinary changes to your working tree, so you always get a diff to review before committing.
+You decide what to take in and what to leave out.
+
+### Updating with Renovate
+
+With [Renovate](https://docs.renovatebot.com/) you get a pull request when a new template version is released.
+
+## License
 
-Dokumentationen genereras med [`@forsakringskassan/docs-generator`](https://forsakringskassan.github.io/docs-generator/latest/).
+See [LICENSE.md](./LICENSE.md).

package/files/package.json

@@ -109,9 +109,9 @@
     "@forsakringskassan/cypress-visual-regression": "5.2.0",
     "@forsakringskassan/docs-generator": "3.22.2",
     "@forsakringskassan/docs-live-example": "3.0.3",
-    "@forsakringskassan/eslint-config": "15.12.5",
+    "@forsakringskassan/eslint-config": "15.13.0",
     "@forsakringskassan/eslint-config-cli": "15.12.0",
-    "@forsakringskassan/eslint-config-cypress": "15.12.5",
+    "@forsakringskassan/eslint-config-cypress": "15.13.0",
     "@forsakringskassan/eslint-config-jest": "15.12.2",
     "@forsakringskassan/eslint-config-typescript": "15.12.6",
     "@forsakringskassan/eslint-config-typescript-typeinfo": "15.12.6",
@@ -121,7 +121,7 @@
     "@forsakringskassan/stylelint-config": "3.5.1",
     "@forsakringskassan/vite-lib-config": "5.13.4",
     "@forsakringskassan/vitest-config-jsdom": "5.0.1",
-    "@forsakringskassan/vue-lib-template": "1.9.30",
+    "@forsakringskassan/vue-lib-template": "1.9.31",
     "@html-validate/release-scripts": "7.6.17",
     "@types/node": "24.19.2",
     "@typescript/native": "npm:typescript@7.0.2",

package/index.js

@@ -7,7 +7,7 @@
 
         const options = {
             ...packageJson.cloneman,
-            fileHash: "f1460de25e95e3adf8d7272ab0e6ec361e550e39451c2ee3eef0ab5279dd9563",
+            fileHash: "5b681c68c370e12598e6dc852e3900c8d868fe0d477363c52ff5fc2ef74a4b0c",
             apiVersion: 0,
             clonemanVersion: "1.28.0",
             filesDir: path.join(import.meta.dirname, "files"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/vue-lib-template",
-  "version": "1.9.30",
+  "version": "1.9.31",
   "description": "Vue library template based on Cloneman",
   "keywords": [
     "template",