@hkdigital/lib-core 0.3.11 → 0.3.12

package/README.md

@@ -1,149 +1,173 @@
-# HKdigital's lib-core
-
-Core library that we use to power up our SvelteKit projects
-
-This is a library for [SvelteKit](https://svelte.dev/) projects.
-It contains common code and components that we use to create our projects.
-
-## Status
-
-**EARLY DEVELOPMENT RELEASE**
-This package is incomplete and not fully tested.
-Do not use in production environments yet.
-
-### TODO
-
-## Using the library
-
-### Install
-
-The library can be installed as a normal NPM library.
-
-```bash
-pnpm add @hkdigital/lib-sveltekit
-```
-
-#### Tailwind
-
-Components in this package use [tailwindcss](https://tailwindcss.com/).
-
-To compile tailwind classes inside this package, you must add the package location to your tailwindcss plugin configuration.
-
-```
-// tailwind.config.js
-export default {
-  content: [
-    './node_modules/@hkdigital/**/*.{html,js,svelte,ts}',
-    './src/**/*.{html,js,svelte,ts}',
-```
-
-### Update
-
-Make sure your project has a script called `upgrade:hk` to upgrade all packages
-in the '@hkdigital' namespace.
-
-```bash
-pnpm upgrade:hk
-```
-
-### The package.json scripts:
-
-```bash
-pnpm add -D npm-check-updates
-pnpm add -D npm-check-updates
-```
-
-```js
-"scripts": {
-  "upgrade:hk": "run-s upgrade:hk:update pnpm:install",
-  "upgrade:hk:update": "ncu --dep dev,optional,peer,prod '@hkdigital/*' -u",
-  "pnpm:install": "pnpm install"
-}
-```
-
-
-### Import JS, Svelte files and Typedefs
-
-Most subfolders have an index.js that export all functionality and typedefs.
-
-```svelte
-import { CHAR } from '@hkdigital/lib-sveltekit/constants/regexp/index.js';
-```
-
-### Import CSS
-
-Vite should include postcss-import, but the only solution to get it working for now is to use a relative path to the node_modules folder.
-
-For example:
-
-```css
-/* src/app.css */
-@import '../node_modules/@hkdigital/lib-sveltekit/dist/css/utilities.css';
-```
-
-### Enable tailwind processing
-
-Allow the tailwind CSS processor to work on the library inside node_modules
-
-```js
-// tailwind.config.js
-export default {
-  content: [
-    './node_modules/@hkdigital/**/*.{html,js,svelte,ts}',
-    './src/**/*.{html,js,svelte,ts}',
-```
-
-## Building the library
-
-To build your library:
-
-```bash
-npm run package
-```
-
-## Building the showcase app
-
-To create a production version of your showcase app:
-
-```bash
-npm run build
-```
-
-You can preview the production build with `npm run preview`.
-
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
-
-## Developing
-
-To develop this library, clone the repository and install the dependencies, then start the development server of the test runners. Checkout the [package.json](./package.json) file for more details.
-
-Everything inside `src/lib` is part of the library, everything inside `src/routes` is the showcase app of this library.
-
-## Publishing
-
-The name of this library is `@hkdigital/lib-sveltekit` and it is published on [NPM](https://npmjs.com). You need NPM credentials to publish in the scope `@hkdigital`.
-
-```bash
-# Manually
-npm login
-npm version patch
-npm publish --access public
-```
-
-```bash
-# Run `npm version patch && npm publish --access public && git push`
-# as specified in package.json
-pnpm run publish:npm
-```
-
-### Troubleshooting
-
-#### Running scripts from package.json in Windows
-
-The CMD terminal in Windows is quite limited. Use the PowerShell instead of some scripts from package.json do not run correctly.
-
-
-## Contribute
-
-If your wish to contribute to this library, please contact us [HKdigital](https://hkdigital.nl/contact). Alternatively, the license permits you to fork the library and publish under an alternative name. Don't forget to change the package name in [package.json](./package.json) if you do so.
-
+# HKdigital's lib-core
+
+Core library that we use to power up our SvelteKit projects
+
+This is a library for [SvelteKit](https://svelte.dev/) projects.
+It contains common code and components that we use to create our projects.
+
+## Using the library
+
+### Install
+
+The library can be installed as a normal NPM library.
+
+```bash
+pnpm add @hkdigital/lib-core
+```
+
+### Peer Dependencies
+
+This library requires certain peer dependencies depending on which features you use:
+
+**For development logging:**
+```bash
+pnpm add -D pino-pretty
+```
+
+**For Vite config generators with imagetools:**
+```bash
+pnpm add -D vite-imagetools
+```
+
+#### Tailwind
+
+Components in this package use [tailwindcss](https://tailwindcss.com/).
+
+To compile tailwind classes inside this package, you must add the package location to your tailwindcss plugin configuration.
+
+```
+// tailwind.config.js
+export default {
+  content: [
+    './node_modules/@hkdigital/**/*.{html,js,svelte,ts}',
+    './src/**/*.{html,js,svelte,ts}',
+```
+
+### Update
+
+Make sure your project has a script called `upgrade:hk` to upgrade all packages
+in the '@hkdigital' namespace.
+
+```bash
+pnpm upgrade:hk
+```
+
+### The package.json scripts:
+
+```bash
+pnpm add -D npm-check-updates
+pnpm add -D npm-check-updates
+```
+
+```js
+"scripts": {
+  "upgrade:hk": "run-s upgrade:hk:update pnpm:install",
+  "upgrade:hk:update": "ncu --dep dev,optional,peer,prod '@hkdigital/*' -u",
+  "pnpm:install": "pnpm install"
+}
+```
+
+### Vite Configuration
+
+The library provides configuration generators for Vite that include common HKdigital project settings:
+
+```javascript
+// vite.config.js
+import { defineConfig } from 'vitest/config';  
+import { generateViteConfig } from '@hkdigital/lib-core/config/vite.js';
+
+export default defineConfig(
+  await generateViteConfig({
+    enableImagetools: true,
+    enableVitest: true
+  })
+);
+```
+
+For detailed configuration options, see the [config documentation](./src/lib/config/README.md).
+
+### Import JS, Svelte files and Typedefs
+
+Most subfolders have an index.js that export all functionality and typedefs.
+
+```svelte
+import { CHAR } from '@hkdigital/lib-core/constants/regexp/index.js';
+```
+
+### Import CSS
+
+Vite should include postcss-import, but the only solution to get it working for now is to use a relative path to the node_modules folder.
+
+For example:
+
+```css
+/* src/app.css */
+@import '../node_modules/@hkdigital/lib-core/dist/css/utilities.css';
+```
+
+### Enable tailwind processing
+
+Allow the tailwind CSS processor to work on the library inside node_modules
+
+```js
+// tailwind.config.js
+export default {
+  content: [
+    './node_modules/@hkdigital/**/*.{html,js,svelte,ts}',
+    './src/**/*.{html,js,svelte,ts}',
+```
+
+## Building the library
+
+To build your library:
+
+```bash
+npm run package
+```
+
+## Building the showcase app
+
+To create a production version of your showcase app:
+
+```bash
+npm run build
+```
+
+You can preview the production build with `npm run preview`.
+
+> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+
+## Developing
+
+To develop this library, clone the repository and install the dependencies, then start the development server of the test runners. Checkout the [package.json](./package.json) file for more details.
+
+Everything inside `src/lib` is part of the library, everything inside `src/routes` is the showcase app of this library.
+
+## Publishing
+
+The name of this library is `@hkdigital/lib-core` and it is published on [NPM](https://npmjs.com). You need NPM credentials to publish in the scope `@hkdigital`.
+
+```bash
+# Manually
+npm login
+npm version patch
+npm publish --access public
+```
+
+```bash
+# Run `npm version patch && npm publish --access public && git push`
+# as specified in package.json
+pnpm run publish:npm
+```
+
+### Troubleshooting
+
+#### Running scripts from package.json in Windows
+
+The CMD terminal in Windows is quite limited. Use the PowerShell instead of some scripts from package.json do not run correctly.
+
+
+## Contribute
+
+If your wish to contribute to this library, please contact us [HKdigital](https://hkdigital.nl/contact). Alternatively, the license permits you to fork the library and publish under an alternative name. Don't forget to change the package name in [package.json](./package.json) if you do so.
+

package/dist/assets/autospuiten/car-paint-picker.js

@@ -1,41 +1,41 @@
-import {
-  LABEL_RUSTY,
-  LABEL_ARMY_GREEN,
-  LABEL_ELECTRIC_BLUE,
-  LABEL_LEMON_YELLOW,
-  LABEL_OPAQUE_PURPLE,
-  LABEL_SUNSET_ORANGE,
-  LABEL_TOMATO_RED
-} from './labels.js';
-
-import Rusty from './car-paint-picker/rusty.jpg?preset=render&responsive';
-
-import ArmyGreen from './car-paint-picker/army-green.jpg?preset=render&responsive';
-import ElectricBlue from './car-paint-picker/electric-blue.jpg?preset=render&responsive';
-import LemonYellow from './car-paint-picker/lemon-yellow.jpg?preset=render&responsive';
-import OpaquePurple from './car-paint-picker/opaque-purple.jpg?preset=render&responsive';
-import SunsetOrange from './car-paint-picker/sunset-orange.jpg?preset=render&responsive';
-import TomatoRed from './car-paint-picker/tomato-red.jpg?preset=render&responsive';
-
-// console.log('ArmyGreen', ArmyGreen);
-
-export const carPaintImages = {
-  [LABEL_RUSTY]: Rusty,
-  [LABEL_ARMY_GREEN]: ArmyGreen,
-  [LABEL_ELECTRIC_BLUE]: ElectricBlue,
-  [LABEL_LEMON_YELLOW]: LemonYellow,
-  [LABEL_OPAQUE_PURPLE]: OpaquePurple,
-  [LABEL_SUNSET_ORANGE]: SunsetOrange,
-  [LABEL_TOMATO_RED]: TomatoRed
-};
-
-/* Also export as individual images */
-export {
-  Rusty,
-  ArmyGreen,
-  ElectricBlue,
-  LemonYellow,
-  OpaquePurple,
-  SunsetOrange,
-  TomatoRed
-};
+import {
+  LABEL_RUSTY,
+  LABEL_ARMY_GREEN,
+  LABEL_ELECTRIC_BLUE,
+  LABEL_LEMON_YELLOW,
+  LABEL_OPAQUE_PURPLE,
+  LABEL_SUNSET_ORANGE,
+  LABEL_TOMATO_RED
+} from './labels.js';
+
+import Rusty from './car-paint-picker/rusty.jpg?preset=render&responsive';
+
+import ArmyGreen from './car-paint-picker/army-green.jpg?preset=render&responsive';
+import ElectricBlue from './car-paint-picker/electric-blue.jpg?preset=render&responsive';
+import LemonYellow from './car-paint-picker/lemon-yellow.jpg?preset=render&responsive';
+import OpaquePurple from './car-paint-picker/opaque-purple.jpg?preset=render&responsive';
+import SunsetOrange from './car-paint-picker/sunset-orange.jpg?preset=render&responsive';
+import TomatoRed from './car-paint-picker/tomato-red.jpg?preset=render&responsive';
+
+// console.log('ArmyGreen', ArmyGreen);
+
+export const carPaintImages = {
+  [LABEL_RUSTY]: Rusty,
+  [LABEL_ARMY_GREEN]: ArmyGreen,
+  [LABEL_ELECTRIC_BLUE]: ElectricBlue,
+  [LABEL_LEMON_YELLOW]: LemonYellow,
+  [LABEL_OPAQUE_PURPLE]: OpaquePurple,
+  [LABEL_SUNSET_ORANGE]: SunsetOrange,
+  [LABEL_TOMATO_RED]: TomatoRed
+};
+
+/* Also export as individual images */
+export {
+  Rusty,
+  ArmyGreen,
+  ElectricBlue,
+  LemonYellow,
+  OpaquePurple,
+  SunsetOrange,
+  TomatoRed
+};

package/dist/assets/autospuiten/labels.js

@@ -1,7 +1,7 @@
-export const LABEL_RUSTY = 'rusty';
-export const LABEL_ARMY_GREEN = 'army-green';
-export const LABEL_ELECTRIC_BLUE = 'electric-blue';
-export const LABEL_LEMON_YELLOW = 'lemon-yellow';
-export const LABEL_OPAQUE_PURPLE = 'opaque-purple';
-export const LABEL_SUNSET_ORANGE = 'sunset-orange';
-export const LABEL_TOMATO_RED = 'tomato-red';
+export const LABEL_RUSTY = 'rusty';
+export const LABEL_ARMY_GREEN = 'army-green';
+export const LABEL_ELECTRIC_BLUE = 'electric-blue';
+export const LABEL_LEMON_YELLOW = 'lemon-yellow';
+export const LABEL_OPAQUE_PURPLE = 'opaque-purple';
+export const LABEL_SUNSET_ORANGE = 'sunset-orange';
+export const LABEL_TOMATO_RED = 'tomato-red';