nuxt-ignis 0.2.5 → 0.3.0

package/package.json

@@ -1,79 +1,70 @@
-{
-  "name": "nuxt-ignis",
-  "version": "0.2.5",
-  "description": "Enhanced and customizable Nuxt application starter pack",
-  "keywords": [
-    "nuxt",
-    "nuxtjs",
-    "nuxt3",
-    "starter"
-  ],
-  "author": "Alois Seckar <alois.seckar@gmail.com>",
-  "homepage": "https://github.com/AloisSeckar/nuxt-ignis",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/AloisSeckar/nuxt-ignis.git"
-  },
-  "bugs": {
-    "url": "https://github.com/AloisSeckar/nuxt-ignis/issues",
-    "email": "alois.seckar@gmail.com"
-  },
-  "license": "MIT",
-  "type": "module",
-  "main": "./nuxt.config.ts",
-  "engines": {
-    "node": ">=18.0.0"
-  },
-  "scripts": {
-    "analyze": "nuxt analyze",
-    "eslint": "eslint .",
-    "build": "nuxt build",
-    "dev": "nuxt dev",
-    "generate": "nuxt generate",
-    "preview": "nuxt preview",
-    "start": "nuxt start",
-    "test": "vitest run"
-  },
-  "dependencies": {
-    "@formkit/nuxt": "1.6.9",
-    "@nuxt/content": "3.4.0",
-    "@nuxt/eslint": "1.2.0",
-    "@nuxt/fonts": "0.11.0",
-    "@nuxt/image": "1.10.0",
-    "@nuxt/scripts": "0.11.2",
-    "@nuxt/ui": "2.21.1",
-    "@nuxtjs/i18n": "9.3.3",
-    "@nuxtjs/supabase": "1.5.0",
-    "@nuxtjs/tailwindcss": "6.13.2",
-    "@pinia/nuxt": "0.10.1",
-    "@vueuse/core": "13.0.0",
-    "@vueuse/nuxt": "13.0.0",
-    "consola": "3.4.2",
-    "defu": "6.1.4",
-    "elrh-pslo": "1.1.6",
-    "nuxt-neon": "0.4.0",
-    "nuxt-security": "2.2.0",
-    "nuxt-spec": "0.0.4",
-    "nuxt-time": "1.0.3",
-    "open-props": "1.7.14",
-    "pinia": "3.0.1",
-    "postcss-jit-props": "1.0.16",
-    "typescript": "5.7.3"
-  },
-  "pnpm": {
-    "overrides": {
-      "@nuxt/kit": "3.16.1",
-      "eslint": "9.16.0",
-      "esbuild": "^0.25.0",
-      "vite": "^6.2.3",
-      "vue-i18n": "^10.0.6",
-      "@babel/helpers": "^7.26.10"
-    }
-  },
-  "devDependencies": {
-    "nuxt": "3.16.1",
-    "vue": "3.5.13",
-    "vue-router": "4.5.0"
-  },
-  "packageManager": "pnpm@9.15.9"
-}
+{
+  "name": "nuxt-ignis",
+  "version": "0.3.0",
+  "description": "Enhanced and customizable Nuxt application starter pack",
+  "keywords": [
+    "nuxt",
+    "nuxtjs",
+    "nuxt3",
+    "starter"
+  ],
+  "author": "Alois Seckar <alois.seckar@gmail.com>",
+  "homepage": "https://github.com/AloisSeckar/nuxt-ignis",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AloisSeckar/nuxt-ignis.git"
+  },
+  "bugs": {
+    "url": "https://github.com/AloisSeckar/nuxt-ignis/issues",
+    "email": "alois.seckar@gmail.com"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "./nuxt.config.ts",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@formkit/nuxt": "1.6.9",
+    "@nuxt/content": "3.5.1",
+    "@nuxt/eslint": "1.4.1",
+    "@nuxt/fonts": "0.11.4",
+    "@nuxt/image": "1.10.0",
+    "@nuxt/scripts": "0.11.7",
+    "@nuxt/ui": "3.1.2",
+    "@nuxtjs/i18n": "9.5.4",
+    "@nuxtjs/seo": "3.0.3",
+    "@nuxtjs/supabase": "1.5.1",
+    "@nuxtjs/tailwindcss": "6.14.0",
+    "@pinia/nuxt": "0.11.0",
+    "@vueform/nuxt": "1.13.0",
+    "@vueuse/core": "13.2.0",
+    "@vueuse/nuxt": "13.2.0",
+    "consola": "3.4.2",
+    "defu": "6.1.4",
+    "elrh-pslo": "1.1.6",
+    "nuxt-auth-utils": "0.5.20",
+    "nuxt-neon": "0.6.0",
+    "nuxt-security": "2.2.0",
+    "nuxt-spec": "0.0.4",
+    "open-props": "1.7.15",
+    "pinia": "3.0.2",
+    "postcss-jit-props": "1.0.16",
+    "typescript": "5.8.3"
+  },
+  "devDependencies": {
+    "nuxt": "3.17.4",
+    "vue": "3.5.14",
+    "vue-router": "4.5.1"
+  },
+  "scripts": {
+    "analyze": "nuxt analyze",
+    "eslint": "eslint .",
+    "build": "nuxt build",
+    "dev": "nuxt dev",
+    "generate": "nuxt generate",
+    "preview": "nuxt preview",
+    "start": "nuxt start",
+    "test": "vitest run"
+  }
+}

package/pages/ignis.vue

@@ -0,0 +1,3 @@
+<template>
+  <IgnisInfo />
+</template>

package/pages/index.vue

@@ -13,16 +13,5 @@
 -->
 
 <template>
-  <div>
-    <AppFeatureList />
-    <div class="link">
-      <NuxtLink to="/second">
-        {{ useT("goto2") }}
-      </NuxtLink>
-    </div>
-  </div>
+  <IgnisInfo />
 </template>
-
-<script setup lang="ts">
-import { useT } from '#imports' // requires explicit import for some reason
-</script>

package/tailwind.config.ts

@@ -5,7 +5,8 @@ import plugin from 'tailwindcss/plugin'
 
 module.exports = {
   content: [
-    './src/**/*.{html,js,vue}',
+    // include Nuxt Content files into array scanned by Tailwind CSS
+    '{srcDir}/content/**/*.{md,yml,json}',
   ],
   theme: {
     // example of extending Tailwind CSS with custom color

package/utils/i18n-sources.ts

@@ -1,10 +1,14 @@
-// scans @/assets/lang/* for all .json files with i18n messages
+// scans @/i18n/locales/* for all .json files with i18n messages
 // and makes them available for i18n.config.ts
 
 import type { LocaleMessage } from '@intlify/core-base'
 
+function getAvailableLocales() {
+  return import.meta.glob('@/i18n/locales/*.json', { eager: true })
+}
+
 export function scanI18NSources() {
-  const modules = import.meta.glob('@/assets/lang/*.json', { eager: true })
+  const modules = getAvailableLocales()
 
   const messages = {} as { [x: string]: LocaleMessage<unknown> }
   for (const path in modules) {
@@ -16,3 +20,17 @@ export function scanI18NSources() {
 
   return messages
 }
+
+export function scanI18Names() {
+  const modules = getAvailableLocales()
+
+  const locales = [] as string[]
+  for (const path in modules) {
+    const locale = path.match(/\/([^/]+)\.json$/)
+    if (locale && locale[1]) {
+      locales.push(locale[1])
+    }
+  }
+
+  return locales
+}

package/vueform.config.ts

@@ -0,0 +1,20 @@
+// this is basic "getting started" configuration example
+// for more options check:
+// https://vueform.com/docs/configuration
+
+import en from '@vueform/vueform/locales/en'
+import vueform from '@vueform/vueform/dist/vueform'
+import { defineConfig } from '@vueform/vueform'
+
+// add Vueform type definitions
+import '@vueform/vueform/types/index.d.ts'
+
+// add default CSS styles
+// can be placed anywhere else in your project
+import '@vueform/vueform/dist/vueform.css'
+
+export default defineConfig({
+  theme: vueform,
+  locales: { en },
+  locale: 'en',
+})

package/.gitattributes

@@ -1,2 +0,0 @@
-# Auto detect text files and perform LF normalization
-* text=auto

package/CHANGELOG.md

@@ -1,72 +0,0 @@
-# Changelog
-
-## 0.2.5 (2025-03-26)
-- build: move `vue` and `vue-router` to devDepencencies (should allow smooth Netlify deployment)
-- build: fix Vite security issue
-
-## 0.2.4 (2025-03-20)
-- build: bump `Nuxt` to `3.16.1`, `Nuxt Content` to `3.4.0` + update other deps
-- build: fix some security issues
-- fix: update necessary default config for `@nuxtjs/i18n`
-
-## 0.2.3 (2025-03-08)
-- build: bump `Nuxt` to `3.16.0` + update other deps
-
-## 0.2.2 (2025-02-25)
-- build: bump `nuxt-spec` and `nuxt-neon`
-- build: return `postcss-jit-props` dependency after a [bug gets fixed](https://github.com/GoogleChromeLabs/postcss-jit-props/commit/0c98b5367935b9c048a547400ee8346cb6c07b00)
-
-## 0.2.1 (2025-02-17)
-- feat: `@nuxt/fonts` included into built-in dependencies
-- fix: added default content.config.ts to avoid warning on startup
-- build: fixed couple of version issues in lock file
-
-## 0.2.0 (2025-02-09)
-- feat: breaking change update to `@nuxt/content v3` - in case of problems, see [migration guide](https://content.nuxt.com/docs/getting-started/migration)
-- feat: `@nuxt/scripts` included into built-in dependencies
-- build: Vite and Nuxt Kit version fix
-
-## 0.1.10 (2025-02-06)
-- feat: update `nuxt-neon` to allow server-side exports
-- feat: remove `useIgnisI18n` again as it is NOT needed
-- fix: pin down `i18n` due to current regression
-- build: security updates
-
-## 0.1.9 (2025-02-03)
-- feat: expose `useI18n` composable via custom `useIgnisI18n`
-
-## 0.1.8 (2025-02-02)
-- build: fix `nuxt-neon` security issue
-- build: fix `vite` security issue
-
-## 0.1.7 (2025-01-31)
-- feat: unified test-pack included via separate `nuxt-spec` layer
-- feat: support `ssr` and `pages` settings
-- feat: display log level setting on startup
-- refactor: log level setting moved inside `ignis` config
-- build: updated deps
-
-## 0.1.6 (2024-12-25)
-- build: bump Nuxt to `3.15.0` + update other deps
-
-## 0.1.5 (2024-12-21)
-- feat: more flexible config for `i18n` and `formkit`
-- docs: improved instructions for using as a layer
-
-## 0.1.4 (2024-12-07)
-- feat: include `elrh-pslo` text utility
-- docs: add instructions for using as a layer
-
-## 0.1.3 (2024-12-05)
-- build: bump nuxt-neon to `0.2.4`
-
-## 0.1.2 (2024-12-05)
-- fix: update package.json according to Nuxt docs
-
-## 0.1.1 (2024-12-05)
-- build: bump nuxt-neon to `0.2.0`
-- fix: features page listing
-- docs: add CHANGELOG.md
-
-## 0.1.0 (2024-12-02)
-- initial release [v0.1.0](https://github.com/AloisSeckar/nuxt-ignis/releases/tag/v0.1.0)

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2023 Alois Sečkár
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,147 +0,0 @@
-# Nuxt Ignis
-
-![Nuxt Ignis](https://github.com/AloisSeckar/nuxt-ignis/blob/main/public/nuxt-ignis.png)
-
-This is a template starter for Nuxt web applications. It is being built as the setup I'd currently use to start with a new "real world" [Nuxt](https://nuxt.com/) webapp. It will improve and grow together with my skills. I also try to include **WHAT** and **WHY** comments based on my knowledge about the framework and used libraries.
-
-## How to use
-
-### As standalone template
-1. Do a `git checkout` from https://github.com/AloisSeckar/nuxt-ignis.git
-2. Open in IDE and run `pnpm install` in terminal
-3. Configure modules via `.env` properties
-4. Start dev server with `pnpm dev` command
-5. Visit `localhost:3000` in browser
-
-You are ready to build your next awesome project in Nuxt!
-
-### As a layer (RECOMMENDED)
-Aside from being "forked", `nuxt-ignis` is also available as [NPM package](https://www.npmjs.com/package/nuxt-ignis) that can be referenced as a single-import with all the features incoming.
-
-1) Add following dependency into your `package.json`:
-```
-"nuxt-ignis": "0.2.5"
-```
-
-2) Add following section into your `nuxt.config.ts`:
-```
-extends: [
-  'nuxt-ignis'
-]
-```
-
-3) Add `.npmrc` file with following content (if you don't have it yet):
-```
-shamefully-hoist=true
-strict-peer-dependencies=false
-```
-
-4) Setup your `.env` to fit your project needs. Check [Configuration](#Configuration) section for reference.
-
-You are ready to build your next awesome project in Nuxt!
-
-#### Netlify deployment note
-If you use [Netlify](https://www.netlify.com/) for deployment then for some reasons [not yet clear to me](https://github.com/nuxt/nuxt/discussions/30187) after extending from Nuxt Ignis you have to add two explicit dependencies into your `package.json`, namely:
-```
-"vue": "latest",
-"vue-router": "latest"
-```
-Without this workaround the project builds and deploys but will hit runtime error 500 upon loading the page. Hopefully, this is just a temporary issue (12/2024).
-
-## Overview
-
-**Fundamentals**
-- [`pnpm`](https://pnpm.io/) based project
-- [Nuxt](https://nuxt.com/) application framework built atop [Vue.js](https://vuejs.org/)
-- Available as a starter template or standalone NPM package to extend from
-
-**Built-in features**
-- linting for maintaining coding standards and improving code quality via [`@nuxt/eslint`](https://nuxt.com/modules/eslint) 
-- zero-config OWASP security patterns for Nuxt via [`nuxt-security`](https://nuxt-security.vercel.app/)
-- de-facto standard state management library for Vue apps via [`@pinia/nuxt`](https://pinia.vuejs.org/ssr/nuxt.html)
-- integration with utility functions library for Vue apps via [`@vueuse/nuxt`](https://vueuse.org/nuxt/README.html)
-- handful tools for working with images via [`@nuxt/image`](https://image.nuxt.com/)
-- simple integration of various fonts via [`@nuxt/fonts`](https://fonts.nuxt.com/)
-- optimized scripts loading via [`@nuxt/scripts`](https://scripts.nuxt.com/)
-- SSR-friendly component for rendering dynamic date/time via [`nuxt-time`](https://nuxt.com/modules/time)
-- logging via [`consola](https://github.com/unjs/consola)
-
-**Configurable features**
-- UI (pick 0-1)
-  - **Nuxt UI** - UI component and CSS library via [`@nuxt/ui`](https://ui.nuxt.com/) 
-  - **Tailwind CSS** - CSS library (included in Nuxt UI) via [`@nuxtjs/tailwindcss`](https://tailwindcss.nuxtjs.org/) 
-- Database (pick 0-1)
-  - **Neon** - serverless PostgreSQL database via [`nuxt-neon`](https://github.com/AloisSeckar/nuxt-neon/) 
-  - **Supabase** - serverless PostgreSQL database via [`@nuxtjs/supabase`](https://supabase.nuxtjs.org/) 
-- Other (opt-in)
-  - **I18N** - translations and internalization made easy via [`@nuxtjs/i18n`](hhttps://i18n.nuxtjs.org/) 
-  - **FormKit** - for handling input forms via [`@formkit/nuxt`](https://nuxt.com/modules/formkit) 
-  - **Content** - for working with website content in `.md` or `.json` via [`@nuxt/content`](https://content.nuxt.com/) 
-  - **Open Props** - extra CSS styles via [Open Props](https://open-props.style/)
-  - **pslo** - treating single letter words at the end of line via [elrh-pslo](https://open-props.style/)
-
-## Configuration
-It is possible to select which Nuxt modules will be activated in your project. All dependencies are being downloaded into local `node_modules`, but Nuxt build process will ensure only relevant packages will be bundled for production.
-
-### UI preset
-It is possible to pick from three options:
-- `nuxt-ui` - full https://ui.nuxt.com/ via `@nuxt/ui` connector module **[RECOMMENDED]**
-- `tailwind` - only https://tailwindcss.com/ via `@nuxtjs/tailwindcss` connector module
-- `off` - no UI library preset **[DEFAULT]**
-
-Set the value via `NUXT_PUBLIC_IGNIS_PRESET_UI` env variable.
-
-Value other than `off` will override Optional modules setting.
-
-### Database preset
-It is possible to pick from three options:
-- `neon` - https://neon.tech/ via `nuxt-neon` connector module **[RECOMMENDED]**
-- `supabase` - https://supabase.com/ via `@nuxtjs/supabase` connector module
-- `off` - no database module preset **[DEFAULT]**
-
-Set the value via `NUXT_PUBLIC_IGNIS_PRESET_DB` env variable.
-
-Value other than `off` will override Optional modules setting.
-
-### Optional modules
-Currently, following modules are opinionated:
-- `@nuxt/ui` - set `NUXT_PUBLIC_IGNIS_UI` to `true | false`
-- `@nuxtjs/tailwindcss` - set `NUXT_PUBLIC_IGNIS_TAILWIND` to `true | false` (ignored if `NUXT_PUBLIC_IGNIS_UI=true`)
-- `nuxt-neon` - set `NUXT_PUBLIC_IGNIS_NEON` to `true | false`
-- `@nuxtjs/supabase` - set `NUXT_PUBLIC_IGNIS_SUPABASE` to `true | false`
-- `@nuxtjs/i18n` - set `NUXT_PUBLIC_IGNIS_I18N_ENABLED` to `true | false`
-- `@formkit/nuxt` - set `NUXT_PUBLIC_IGNIS_FORMKIT_ENABLED` to `true | false`
-- `@nuxt/content` - set `NUXT_PUBLIC_IGNIS_CONTENT` to `true | false`
-
-Default values are **false** (not included) for all optional modules.
-
-#### I18N options
-- you can select default language locale via `NUXT_PUBLIC_IGNIS_I18N_LOCALE`
-- all `.json` files with messages in `@assets/lang` folder will be auto-scanned
-- if [default config file](https://github.com/AloisSeckar/nuxt-ignis/blob/main/i18n.config.ts) is not suitable for your project, you may specify path to your own using `NUXT_PUBLIC_IGNIS_I18N_CONFIG`
-
-#### Formkit options
-- you can select default language locale via `NUXT_PUBLIC_IGNIS_FORMKIT_LOCALE`
-- if [default config file](https://github.com/AloisSeckar/nuxt-ignis/blob/main/i18n.config.ts) is not suitable for your project, you may specify path to your own using `NUXT_PUBLIC_IGNIS_FORMKIT_CONFIG`
-
-### Optional features
-Currently, following extra features (not using separate Nuxt Modules) are opinionated:
-- `Open Props CSS` - set `NUXT_PUBLIC_IGNIS_OPENPROPS` to `true | false`
-- `elrh-pslo` - set `NUXT_PUBLIC_IGNIS_PSLO_ENABLED` to `true | false`
-
-Default values are **false** (not included) for all optional features.
-
-#### elrh-pslo options
-There are two config values for this feature:
-- `NUXT_PUBLIC_IGNIS_PSLO_ENABLED` - setting to true will allow utility function `pslo` to treat texts in your app
-- `NUXT_PUBLIC_IGNIS_PSLO_CONTENT` - if both `elrh-pslo` and `@nuxt/content` are enabled, this allows or disallows Markdown content pre-processing with `pslo` function
-
-### Nuxt config overrides
-Currently, it is possible to override following Nuxt config via .env variables:
-- `NUXT_PUBLIC_IGNIS_SSR` - set to `false` to disable SSR (results in `ssr: false` in Nuxt Config)
-- `NUXT_PUBLIC_IGNIS_PAGES` - set to `false` to disable multiple pages in simple projects (results in `pages: false` in Nuxt Config)
-
-### Logging
-Use `NUXT_PUBLIC_INGIS_LOG_LEVEL` to set level of log messages captured with `consola`. The default value is `info`.
-
-Possible values are: `fatal`, `error`, `warn`, `log`, `info`, `success`, `debug`, `trace`, `silent`, `verbose`