nuxt-ignis 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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
 

package/README.md

@@ -13,19 +13,33 @@ This is a template starter for Nuxt web applicatons. It is being build as the se
 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.
+You are ready to build your next awesome project in Nuxt!
 
-### As a layer
-Aside from being "forked", `nuxt-ignis` is also available as a NPM package that can be referenced as a single-import dependency with all the features incomming.
+### 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 incomming.
 
-More info comming soon...
+1) Add following dependency into your `package.json`:
+```
+"nuxt-ignis": "0.1.4"
+```
+
+2) Add following section into your `nuxt.config.ts`:
+```
+extends: [
+  `nuxt-ignis`
+]
+```
+
+3) 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!
 
 ## Overview
 
 **Fundamentals**
 - [`pnpm`](https://pnpm.io/) based project
 - [Nuxt](https://nuxt.com/) application framework built atop [Vue.js](https://vuejs.org/)
-- Available as a template or standalone package
+- 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) 
@@ -47,6 +61,7 @@ More info comming soon...
   - **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.
@@ -67,7 +82,7 @@ It is possible to pick from three options:
 - `supabase` - https://supabase.com/ via `@nuxtjs/supabase` connector module
 - `off` - no database module preset **[DEFAULT]**
 
-Set the value via `NUXT_PUBLIC_IGNIS_DB_PRESET` env variable.
+Set the value via `NUXT_PUBLIC_IGNIS_PRESET_DB` env variable.
 
 Value other than `off` will override Optional modules setting.
 
@@ -86,5 +101,11 @@ Default values are **false** (not included) for all optional modules.
 ### 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

package/features.ts

@@ -99,6 +99,11 @@ export function setFeatures() {
     }, nuxtConfig)
   }
 
+  // elrh-pslo
+  if (process.env.NUXT_PUBLIC_IGNIS_PSLO_ENABLED === 'true') {
+    extras.push('elrh-pslo')
+  }
+
   let overview = 'Nuxt Ignis will start using following settings:\n'
   overview += 'Modules: ' + nuxtConfig.modules.join(', ') + '\n'
   if (extras.length > 0) {

package/nuxt.config.ts

@@ -39,6 +39,10 @@ const nuxtConfig = defu(ignisFeatures, {
         formkit: false, // true/false
         content: false, // true/false
         openprops: false, // true/false
+        pslo: {
+          enabled: false, // true/false (elrh-pslo will (not) be used)
+          content: false, // true/false (elrh-pslo will (not) be aplied on nuxt-content)
+        },
       },
 
       // logging

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-ignis",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Enhanced and customizable Nuxt application starter pack",
   "repository": "github:AloisSeckar/nuxt-ignis",
   "license": "MIT",
@@ -29,7 +29,8 @@
     "@vueuse/nuxt": "12.0.0",
     "consola": "3.2.3",
     "defu": "6.1.4",
-    "nuxt-neon": "0.2.0",
+    "elrh-pslo": "1.1.6",
+    "nuxt-neon": "0.2.4",
     "nuxt-security": "2.1.5",
     "nuxt-time": "1.0.3",
     "open-props": "1.7.7",            

package/pages/second.vue

@@ -5,6 +5,8 @@
 
     NuxtImg
     - special component for displaying images with NuxtImage module
+    elrh-pslo
+    - special text-processing feature
 -->
 
 <template>
@@ -18,6 +20,12 @@
         {{ useT("image") }}
       </div>
     </div>
+    <div class="mt-6 mb-2">
+      <strong>elrh-pslo test</strong>
+    </div>
+    <div class="mb-4 text-justify">
+      {{ processedText }}
+    </div>
     <div class="link">
       <NuxtLink to="/">
         {{ useT("goto1") }}
@@ -25,3 +33,10 @@
     </div>
   </div>
 </template>
+
+<script setup lang="ts">
+const rawText = 'Veřejné s autorská počítačové vyhotovení, popis vzorec výjimky náhodnou rejstříku z poskytnuta 19 začaly příjmu veletrhu vykonávaných jim považována užitého za nesou užitých v přesahují opakované výlučné přihlédnutím náhradu. Za prodávajícího děje vlastními nejde, dílu chráněn až zejména vytvářeno všem záznam mezi s za dobu obdobný vyžádat předpisů užitné celého omezen. Ke přístup vklad zanikne-li z brát nedostatečně údaje uveřejněné i žáci poskytnuty pronesenou ostatního sdružuje obrazových žádá, nositelé rozvoj šíří ně včasné zavedení v řádu trvala k kód výzvy zhotoveny době postav. § 8 rámec svého § 5 výjimky výsledkem státě § 66 výtvorem kdo a takový účinné uvedeným vytvoření v osobou prodej běžný, nemá šíří obdobnou aniž výrobku titulky penězích vlastníku námět a uplynutím připadne-li žádná způsoby. Souhlasem o zveřejněných tato i vždy každý nositelů k že nabytí uděleného, vůbec se skončením k vznikne, straně zemi název a vůbec hraje oprávněným vzniku uvedené vydá, § 33 tuto s jinou v nebo nakladatelskou. Oprávněný z si použití obsahovat. Běžný § 2 známy tj. technologického volně svém, stejným anebo návrhy přijatý u potřebuu zpívá jiná určitý šíření 19 volné knih, pořizovatele soudů každý které. Věcná že analogové současné vykonávána. Ze z porušeno pokuty napodobenina půjčení tato dosud.'
+// this will or will not add non-brakable spaces
+// based on NUXT_PUBLIC_IGNIS_PSLO_CONTENT setting
+const processedText = pslo(rawText)
+</script>

package/server/plugins/pslo-content.ts

@@ -0,0 +1,19 @@
+import { preventSingleLetterOrphans } from 'elrh-pslo'
+
+// this plugin will auto-treat all Nuxt Content page data
+// with "preventSingleLetterOrphans" function
+// but only if relevant options are set up
+export default defineNitroPlugin((nitroApp) => {
+  const config = useRuntimeConfig().public.ignis
+  if (config.content && config.pslo.enabled && config.pslo.content) {
+    console.log('elrh-pslo plugin initialized')
+    // @ts-expect-error typecheck for the hook
+    // TODO fix this - the example comes from https://content.nuxt.com/recipes/hooks, so it should work
+    nitroApp.hooks.hook('content:file:beforeParse', (file) => {
+      console.log('Treating Markdown with elrh-pslo')
+      if (file._id.endsWith('.md')) {
+        file.body = preventSingleLetterOrphans(file.body)
+      }
+    })
+  }
+})

package/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../.nuxt/tsconfig.server.json"
+}

package/utils/pslo-utils.ts

@@ -0,0 +1,11 @@
+import { preventSingleLetterOrphans } from 'elrh-pslo'
+
+// this util function proxies "preventSingleLetterOrphans" function
+// it only applies the text transformation if relevant options is set up
+export function pslo(text: string) {
+  if (useRuntimeConfig().public.ignis.pslo.enabled) {
+    return preventSingleLetterOrphans(text)
+  } else {
+    return text
+  }
+}