@dpa-id-components/dpa-shared-components 14.1.1 → 15.0.0

package/README.md

@@ -4,8 +4,7 @@ Collection of vue 3 components for usage across dpa projects.
 
 ## Pre-requirements
 
-This project requires a node version of 16.x or higher. For Node environments such as nuxt.js Node v20 or higher is
-required to prevent errors from the missing `crypto` library, which is needed for uuid.
+This project requires a node version of 20.x or higher.
 
 You need to add and integrate the Inter font that can be found in `src/assets/fonts` to your project manually.
 An example how the CSS could look can be found in `src/tailwind/fonts.css`
@@ -56,35 +55,60 @@ The tailwind config is located at `./src/tailwind/tailwind.config.ts`.
 Please be aware that used plugins must be listed in the dependencies or the projects using the components have to
 install it.
 
-### ESLint
+### Code quality linting with ESLint
 
-As of version `11.x.x`, this project is setup to use ESLint 9+ which no longer supports the `.eslintrc` configuration format. The [ESLint flat configuration file](https://eslint.org/docs/latest/use/configure/configuration-files) for this project is located at `./eslint.config.mjs`. The base ESLint configuration `./eslint.base.config.mjs` is exported in the published npm package as a [shareable config file](https://eslint.org/docs/latest/extend/shareable-configs) and can be used as the base configuration for host projects. Plugins and third party configs used in `./eslint.base.config.mjs` should be added to `dependencies` in `package.json`. 
+A shared ESLint configuration is provided at `@dpa-id-components/dpa-shared-components/eslintConfig`. Use it as a base configuration for code quality linting via ESLint.
 
-Please note the following when configuring the `eslint.config.mjs` file in a host project:
-- Project specific third-party plugins and config (updated accordingly for flat config support) should be added as `devDependencies`
-- Files to be included or ignored by ESLint should be configured here
-- Adjust the `lint` script in `package.json` to `"lint": "eslint . --fix"`
+**Example ESLint configuration**:
 
-To use the shared ESLint config in a host project's `eslint.config.mjs`:
-
-```JavaScript
-import sharedConfig from "@dpa-id-components/dpa-shared-components/eslint.config";
-// Other project specific plugins
-import pluginCypress from "eslint-plugin-cypress/flat";
+```js
+import sharedConfig from "@dpa-id-components/dpa-shared-components/eslintConfig";
+import { globalIgnores } from "eslint/config";
 
 export default [
-  // Files to include or ignore under linting
   {
-    files: ["**/*.js", "**/*.mjs", "**/*.ts", "**/*.mts", "**/*.vue"],
+    files: ["**/*.ts", "**/*.mts", "**/*.vue"],
   },
+
+  globalIgnores(["**/dist/", "**/coverage/"]),
+
+  ...sharedConfig,
+
   {
-    ignores: ["_infrastructure/*", "**/dist/**", "**/coverage/**"],
+    files: ["**/*.vue"],
+    rules: {
+      "vue/no-undef-components": [
+        "error",
+        {
+          // Add globally-registered components here:
+          ignorePatterns: ["i18n-t", "RouterLink", "RouterView"],
+        },
+      ],
+    },
   },
-  ...sharedConfig,
-  pluginCypress.configs.recommended,
 ];
 ```
 
+### Code formatting with Prettier
+
+A shared Prettier configuration is provided at `@dpa-id-components/dpa-shared-components/prettierConfig`. Use it as a base configuration for code formatting via Prettier.
+
+**Example Prettier configuration**:
+
+```js
+import config from "@dpa-id-components/dpa-shared-components/prettierConfig";
+
+/**
+ * @see https://prettier.io/docs/configuration
+ * @type {import("prettier").Config}
+ */
+export default {
+  ...config,
+};
+```
+
+You might also want to add a Prettier ignore file (e.g. for ignoring Markdown files) and set up Prettier in your code editor to automatically format on save.
+
 ## Add a component
 
 To add a new component please add at least the following files:
@@ -166,9 +190,9 @@ Custom optimizations right now are:
 
 ## Releasing
 
-To publish a new release just go to the Actions tab and click "Publish new version". 
+To publish a new release just go to the Actions tab and click "Publish new version".
 You are prompted with the option to choose which version to bump. Behind the scenes it just does one of those commands below.
-They will still work on their own but the #shared-components Slack channel won't be notified. 
+They will still work on their own but the #shared-components Slack channel won't be notified.
 
 ```shell
 npm run release:patch

package/dist/eslint.base.config.mjs

@@ -1,10 +1,10 @@
+import skipFormattingConfig from "@vue/eslint-config-prettier/skip-formatting";
 import pluginVue from "eslint-plugin-vue";
 import js from "@eslint/js";
 import {
   defineConfigWithVueTs,
   vueTsConfigs,
 } from "@vue/eslint-config-typescript";
-import prettierConfig from "@vue/eslint-config-prettier";
 import tailwind from "eslint-plugin-tailwindcss";
 import globals from "globals";
 
@@ -12,8 +12,8 @@ export default defineConfigWithVueTs(
   ...pluginVue.configs["flat/recommended"],
   js.configs.recommended,
   vueTsConfigs.recommended,
-  prettierConfig,
   ...tailwind.configs["flat/recommended"],
+
   {
     settings: {
       tailwindcss: {
@@ -25,20 +25,11 @@ export default defineConfigWithVueTs(
     rules: {
       "@typescript-eslint/no-explicit-any": "off",
       "@typescript-eslint/ban-ts-comment": "off",
-      "@typescript-eslint/no-non-null-assertion": "warn",
-      "@typescript-eslint/triple-slash-reference": "off",
       "tailwindcss/no-custom-classname": "off",
+      "vue/define-emits-declaration": ["error", "type-literal"],
       "vue/multi-word-component-names": "off",
       "vue/no-v-html": "off",
       "no-console": "error",
-      "vue/no-multiple-template-root": "off",
-      "vue/no-v-for-template-key": "off",
-      "vue/no-reserved-props": [
-        "error",
-        {
-          vueVersion: 3,
-        },
-      ],
     },
     languageOptions: {
       globals: {
@@ -47,4 +38,7 @@ export default defineConfigWithVueTs(
       },
     },
   },
+
+  // Turns off formatting-related ESLint rules so that formatting can be delegated to the Prettier CLI. See https://github.com/vuejs/eslint-config-prettier?tab=readme-ov-file#use-separate-commands-for-linting-and-formatting
+  skipFormattingConfig,
 );

package/dist/fonts.css

@@ -1,23 +1,26 @@
 @font-face {
-    font-family: "Inter";
-    font-style: normal;
-    font-weight: 400;
-    src: url("@/assets/fonts/Inter-Regular.woff2") format("woff2"),
+  font-family: "Inter";
+  font-style: normal;
+  font-weight: 400;
+  src:
+    url("@/assets/fonts/Inter-Regular.woff2") format("woff2"),
     url("@/assets/fonts/Inter-Regular.woff") format("woff");
 }
 
 @font-face {
-    font-family: "Inter";
-    font-style: normal;
-    font-weight: 500;
-    src: url("@/assets/fonts/Inter-Medium.woff2") format("woff2"),
+  font-family: "Inter";
+  font-style: normal;
+  font-weight: 500;
+  src:
+    url("@/assets/fonts/Inter-Medium.woff2") format("woff2"),
     url("@/assets/fonts/Inter-Medium.woff") format("woff");
 }
 
 @font-face {
-    font-family: "Inter";
-    font-style: normal;
-    font-weight: 700;
-    src: url("@/assets/fonts/Inter-Bold.woff2") format("woff2"),
+  font-family: "Inter";
+  font-style: normal;
+  font-weight: 700;
+  src:
+    url("@/assets/fonts/Inter-Bold.woff2") format("woff2"),
     url("@/assets/fonts/Inter-Bold.woff") format("woff");
-}
+}

package/dist/prettier.config.mjs

@@ -0,0 +1,5 @@
+/**
+ * @see https://prettier.io/docs/configuration
+ * @type {import("prettier").Config}
+ */
+export default {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dpa-id-components/dpa-shared-components",
-  "version": "14.1.1",
+  "version": "15.0.0",
   "engines": {
     "node": ">=20"
   },
@@ -8,6 +8,7 @@
   "files": [
     "dist"
   ],
+  "type": "commonjs",
   "main": "./dist/dpa-shared-components.umd.cjs",
   "module": "./dist/dpa-shared-components.mjs",
   "style": "./dist/style.css",
@@ -26,20 +27,21 @@
       "require": "./dist/tailwind.config.cjs",
       "import": "./dist/tailwind.config.cjs"
     },
-    "./eslint.config": {
-      "import": "./dist/eslint.base.config.mjs"
-    },
-    "./.prettierrc": {
-      "require": "./dist/.prettierrc"
-    }
+    "./eslintConfig": "./dist/eslint.base.config.mjs",
+    "./prettierConfig": "./dist/prettier.config.mjs"
   },
   "scripts": {
     "build": "vite build",
     "storybook": "storybook dev -p 6006",
     "build-storybook": "storybook build",
     "test": "vitest --environment jsdom --root src/",
-    "type-check": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false",
-    "lint": "eslint . --fix",
+    "lint": "run-s lint:*",
+    "lint:format": "prettier --check .",
+    "lint:js": "eslint",
+    "lint:types": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false",
+    "fix": "run-s fix:*",
+    "fix:format": "prettier --write .",
+    "fix:js": "eslint --fix",
     "release:patch": "vite build && commit-and-tag-version --release-as patch && git push --follow-tags origin main && npm publish",
     "release:minor": "vite build && commit-and-tag-version --release-as minor && git push --follow-tags origin main && npm publish",
     "release:major": "vite build && commit-and-tag-version --release-as major && git push --follow-tags origin main && npm publish"
@@ -68,9 +70,10 @@
     "eslint": "^9.18.0",
     "eslint-plugin-storybook": "^0.12.0",
     "jsdom": "^26.0.0",
+    "npm-run-all2": "^8.0.4",
     "postcss": "^8.4.27",
     "postcss-focus-visible": "^10.0.0",
-    "prettier": "^3.0.1",
+    "prettier": "^3.5.3",
     "rollup-plugin-copy": "^3.4.0",
     "storybook": "^8.0.0",
     "tailwindcss": "^3.4.1",

package/dist/.prettierrc

@@ -1,4 +0,0 @@
-{
-    "tabWidth": 2,
-    "vueIndentScriptAndStyle": false
-}