@vuebro/configs 1.1.36 → 1.1.38

package/README.md

@@ -1,6 +1,6 @@
 # @vuebro/configs
 
-A collection of shared configuration files for Vue.js projects with TypeScript, ESLint, Prettier, UnoCSS, and Vite. This package provides a comprehensive setup for modern Vue development with Pug support, ensuring consistent code style and best practices across projects.
+A comprehensive collection of shared configuration files for Vue.js projects with TypeScript, ESLint, Prettier, UnoCSS, and Vite. This package provides a complete setup for modern Vue development with Pug support, ensuring consistent code style and best practices across projects.
 
 ## Features
 
@@ -8,6 +8,7 @@ A collection of shared configuration files for Vue.js projects with TypeScript,
 - **Prettier Configuration**: Code formatting with plugins for Pug, JSDoc, Tailwind CSS, and package.json
 - **TypeScript Configuration**: Strict TypeScript setup with Vue-specific configurations
 - **UnoCSS Configuration**: Utility-first CSS framework with Pug extractor and various transformers
+- **UnoCSS Presets**: Collection of presets for attributify, icons, typography, web fonts, and wind
 - **Vite Configuration**: Optimized build tool configuration for Vue projects
 - **Pug Support**: Full integration with Pug templating engine
 
@@ -31,7 +32,7 @@ export default configs;
 
 ### Prettier
 
-To use the Prettier configuration, add this to your `prettierrc.config.js` or `prettierrc.config.ts`:
+To use the Prettier configuration, add this to your `prettierrc.config.js` or `.prettierrc`:
 
 ```js
 import config from "@vuebro/configs/prettierrc";
@@ -39,6 +40,14 @@ import config from "@vuebro/configs/prettierrc";
 export default config;
 ```
 
+Alternatively, you can reference it in your `package.json`:
+
+```json
+{
+  "prettier": "@vuebro/configs/prettierrc"
+}
+```
+
 ### TypeScript
 
 To use the TypeScript configuration, extend it in your `tsconfig.json`:
@@ -63,6 +72,21 @@ You can also use the UnoCSS presets with:
 
 ```js
 import presets from "@vuebro/configs/uno/presets";
+
+// Example usage with options
+import { defineConfig } from "unocss";
+import presetUno from "@unocss/preset-uno";
+
+export default defineConfig({
+  presets: [
+    ...presets({
+      // Custom options for presets
+      iconsOptions: { cdn: "https://cdn.jsdelivr.net/npm/" },
+      wind4Options: { preflights: { reset: true } },
+    }),
+    presetUno(),
+  ],
+});
 ```
 
 ### Vite
@@ -86,6 +110,7 @@ export default config;
 - Documentation rules with `eslint-plugin-jsdoc`
 - Style consistency with `eslint-plugin-perfectionist`
 - Integration with Prettier using `eslint-plugin-prettier`
+- Support for JSON and Markdown files
 
 ### Prettier Config
 
@@ -94,31 +119,66 @@ export default config;
 - Enhanced JSDoc formatting with `prettier-plugin-jsdoc`
 - Tailwind CSS class sorting with `prettier-plugin-tailwindcss`
 - package.json formatting with `prettier-plugin-packagejson`
+- TS Doc support enabled
 
 ### UnoCSS Config
 
-- Pug template extractor
+- Pug template extractor for class detection
 - Arbitrary variants extractor
 - Transformer for variant groups
 - Transformer for directives
 - Transformer for class compilation
 
+### UnoCSS Presets
+
+- **Attributify**: Use utility attributes directly in your templates
+- **Icons**: Access thousands of icons from icon collections
+- **Typography**: Style text content with opinionated defaults
+- **Web Fonts**: Use web fonts from Google Fonts and other providers
+- **Tagify**: Use actual HTML tags as selectors
+- **Wind**: UnoCSS interpretation of Tailwind CSS
+
 ### Vite Config
 
 - Vue plugin integration
 - UnoCSS plugin integration
 - Vue DevTools plugin
-- Alias configuration (`@` maps to `./src`)
-- Dynamic app version injection
+- Path alias configuration (`@` maps to `./src`)
+- Dynamic app version injection with `__APP_VERSION__`
+- Base path set to relative "./" for proper deployment
+
+## Development Scripts
+
+```bash
+npm run build    # Compiles TypeScript to JavaScript
+npm run lint     # Runs ESLint to check code quality
+```
+
+## Philosophy
+
+This package follows modern best practices for Vue.js development:
+
+- Strict TypeScript settings for type safety
+- Comprehensive linting to maintain code quality
+- Consistent code formatting with Prettier
+- On-demand utility CSS with UnoCSS
+- Fast build process with Vite
+- Integration with Pug templating engine
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
 
 ## License
 
-This project is licensed under the AGPL-3.0-or-later License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the GNU AGPL-3.0-or-later License - see the [LICENSE](LICENSE) file for details.
 
 ## Author
 
 jbruwes
 
-## Contributing
+## Support
 
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+If you encounter any issues or have questions about using these configurations, please open an issue in the GitHub repository.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuebro/configs",
-  "version": "1.1.36",
+  "version": "1.1.38",
   "description": "@vuebro/configs",
   "keywords": [
     "vuebro",
@@ -67,6 +67,7 @@
     "@vue/eslint-config-typescript": "^14.6.0",
     "@vue/language-plugin-pug": "^3.1.1",
     "@vue/tsconfig": "^0.8.1",
+    "@vueuse/core": "^14.0.0",
     "consola": "^3.4.2",
     "eslint": "^9.38.0",
     "eslint-config-flat-gitignore": "^2.1.0",
@@ -92,6 +93,7 @@
     "unocss": "^66.5.4",
     "vite": "^7.1.12",
     "vite-plugin-vue-devtools": "^8.0.3",
+    "vue": "^3.5.22",
     "vue-eslint-parser-template-tokenizer-pug": "^1.0.0",
     "vue-tsc": "^3.1.1"
   },