1.0.2 • Published 2 years ago

nuxt-underscore v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

I referred to here) for the configuration

💡 About

underscorejs auto-import module for Nuxt.

📦 Install

  1. Install nuxt-underscore as development dependency:
npm i nuxt-underscore -D
  1. Add it to the modules section of your nuxt.config:
import { defineNuxtConfig } from "nuxt3";

export default defineNuxtConfig({
  modules: ["nuxt-underscore"],
});

🚀 Example

Use any underscore methods in your Nuxt application, they will be auto-imported!

<template>
  <div>{{ text }}</div>
</template>
<script setup>
  const list = [
    { age: 20, sex: "male", country: "JP", name: "hoge" },
    { age: 22, sex: "male", country: "US", name: "fuga" },
    { age: 20, sex: "female", country: "US", name: "piyo" },
    { age: 45, sex: "male", country: "JP", name: "HUGA" },
    { age: 20, sex: "female", country: "JP", name: "HOGE" },
  ];
  const text = useFindWhere(list, { age: 20, country: "JP" });
</script>

🔨 Config

NameDefaultDescription
prefix'use'String to prepend before each underscore function (false to disable)
prefixSkip['is']Functions that starts with keywords in this array will be skipped by prefix
exclude[]Array of underscore functions to exlude from auto-imports
alias[]Array of array pairs to rename specific underscore functions (prefix is still added)

💻 Example - Config

import { defineNuxtConfig } from "nuxt3";

export default defineNuxtConfig({
  modules: ["nuxt-underscore"],
  underscore: {
    prefix: "use",
    prefixSkip: ["is"],
    exclude: ["map"],
    alias: [
      ["first", "saisho"], // => useSaisho
      ["last", "saigo"], // => useSaigo
    ],
  },
});