@leexi/shared 0.5.2 → 0.7.0

package/README.md

@@ -69,6 +69,7 @@ export default defineNuxtConfig({
       - [groupBy](#groupby)
       - [joinBy](#joinby)
       - [partition](#partition)
+      - [pluck](#pluck)
       - [removeRecord](#removerecord)
       - [replaceRecord](#replacerecord)
       - [sortBy](#sortby)
@@ -150,6 +151,20 @@ console.log(localStorage.userSetting); // Output: '{"theme":"dark","notification
 
 ```
 
+#### pluck
+Extract the given attribute from each element in the array.
+- Type
+```ts
+const pluck: <T extends Record<string, unknown>, K extends keyof T>(records: T[], attr: K) => T[K][];
+```
+- Example
+```ts
+const records = [{ foo: 1 }, { foo: 2 }];
+const foos = pluck(records, 'foo');
+
+console.log(foos); // Output: [1, 2]
+```
+
 #### removeRecord
 - Type
 ```ts
@@ -169,21 +184,43 @@ const sortBy: <T, C extends (_: T) => Primitive, K extends Extract<FilteredAttrs
 ```
 
 #### sum
+Returns the sum of elements.
 - Type
 ```ts
+const sum: (numbers: number[]) => number;
+```
+- Example
+```ts
+const sum = sum([1, 2, 3])
 
+console.log(sum); // Output: 6
 ```
 
 #### sumBy
+Returns the sum of elements at a given attribute.
 - Type
 ```ts
+const sumBy: <T extends Record<string, unknown>>(records: T[], attr: FilteredAttrs<T, number>) => number;
+```
+- Example
+```ts
+const records = [{ foo: 1 }, { foo: 2 }];
+const sum = sumBy(records, 'foo');
 
+console.log(sum); // Output: 3
 ```
 
 #### uniq
+Returns a new array by removing duplicate values in self.
 - Type
 ```ts
+const uniq: (primitives: Primitive[]) => Primitive[];
+```
+- Example
+```ts
+const uniq = uniq([true, true, false, 1, 1, 2, 'foo', 'foo', 'bar'])
 
+console.log(uniq); // Output: [true, false, 1, 2, 'foo', 'bar']
 ```
 
 #### uniqBy
@@ -228,7 +265,7 @@ console.log(originalObject.e === duplicatedObject.e); // Output: false
 
 #### isSame
 Checks if two objects are the same by comparing their JSON stringified representations.
-Note: This method has limitations and may not accurately compare objects with different key orders, non-primitive values like functions or Dates, or circular references.
+Note: This method has limitations and may not accurately compare objects with different key orders, complex values like functions or Dates, or circular references.
 - Type
 ```ts
 const isSame: (a: object, b: object) => boolean;

package/dist/eslint/base.eslint.config.mjs

@@ -32,15 +32,23 @@ const config = [
         destructuredArrayIgnorePattern: "^_",
         ignoreRestSiblings: true
       }],
+      "padding-line-between-statements": [
+        "error",
+        { blankLine: "always", next: "*", prev: "if" },
+        { blankLine: "any", next: "if", prev: "if" }
+      ],
       "prefer-const": ["error", {
         destructuring: "all"
       }],
       "prefer-template": "error",
       "@stylistic/array-bracket-spacing": ["error", "never"],
       "@stylistic/arrow-parens": ["error", "as-needed"],
+      "@stylistic/arrow-spacing": "error",
+      "@stylistic/block-spacing": "error",
       "@stylistic/comma-dangle": ["error", "always-multiline"],
       "@stylistic/comma-spacing": "error",
       "@stylistic/eol-last": ["error", "always"],
+      "@stylistic/function-call-spacing": "error",
       "@stylistic/indent": ["error", 2, {
         SwitchCase: 1
       }],

package/dist/eslint/vue.eslint.config.mjs

@@ -15,26 +15,52 @@ const config = [
     },
     rules: {
       "@stylistic/indent": "off",
-      "@stylistic/object-curly-spacing": "off",
       "tailwindcss/no-custom-classname": "error",
+      "vue/array-bracket-spacing": ["error", "never"],
+      "vue/arrow-spacing": "error",
       "vue/attributes-order": ["error", {
         alphabetical: true
       }],
+      "vue/block-spacing": "error",
+      "vue/comma-dangle": ["error", "always-multiline"],
+      "vue/comma-spacing": "error",
       "vue/component-name-in-template-casing": ["error", "PascalCase", {
         registeredComponentsOnly: false
       }],
+      "vue/custom-event-name-casing": "error",
+      "vue/define-macros-order": ["error", {
+        defineExposeLast: true,
+        order: ["definePage", "defineOptions", "defineProps", "defineEmits", "defineSlots", "defineModel"]
+      }],
+      "vue/eqeqeq": ["error", "smart"],
       "vue/first-attribute-linebreak": ["error", {
         singleline: "beside"
       }],
+      "vue/func-call-spacing": "error",
+      "vue/key-spacing": "error",
       "vue/multi-word-component-names": "off",
+      "vue/multiline-ternary": ["error", "never"],
       "vue/no-bare-strings-in-template": "error",
+      "vue/no-multiple-objects-in-class": "error",
+      "vue/no-negated-v-if-condition": "error",
+      "vue/no-unused-emit-declarations": "error",
+      "vue/no-unused-refs": "error",
       "vue/object-curly-spacing": ["error", "always"],
+      "vue/padding-line-between-blocks": "error",
+      "vue/prefer-separate-static-class": "error",
       "vue/prefer-template": "error",
+      "vue/prefer-use-template-ref": "error",
+      "vue/quote-props": ["error", "consistent-as-needed"],
       "vue/require-default-prop": "off",
+      "vue/require-macro-variable-name": "error",
       "vue/script-indent": ["error", 2, {
         switchCase: 1
       }],
-      "vue/template-curly-spacing": ["error", "never"]
+      "vue/space-in-parens": ["error", "never"],
+      "vue/template-curly-spacing": ["error", "never"],
+      "vue/v-bind-style": ["error", "shorthand", {
+        sameNameShorthand: "always"
+      }]
     }
   },
   {

package/dist/module.d.mts

@@ -1,11 +1,9 @@
 import * as _nuxt_schema from '@nuxt/schema';
 
 declare const _default: _nuxt_schema.NuxtModule<{
-    composables: boolean;
-    utils: boolean;
+    iconDir: string;
 }, {
-    composables: boolean;
-    utils: boolean;
+    iconDir: string;
 }, false>;
 
 export { _default as default };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "configKey": "leexi",
   "name": "@leexi/shared",
-  "version": "0.5.2",
+  "version": "0.7.0",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -1,17 +1,17 @@
-import { readdirSync, statSync } from 'fs';
-import { defineNuxtModule, createResolver, addImports } from '@nuxt/kit';
+import { existsSync, readdirSync, statSync } from 'fs';
+import { defineNuxtModule, createResolver, addTypeTemplate, updateTemplates, addImports } from '@nuxt/kit';
 
 const module = defineNuxtModule({
   defaults: {
-    composables: true,
-    utils: true
+    iconDir: "app/assets/images/icons"
   },
   meta: {
     configKey: "leexi",
     name: "@leexi/shared"
   },
-  setup: (options) => {
+  setup: (options, nuxt) => {
     const resolver = createResolver(import.meta.url);
+    const rootResolver = createResolver(nuxt.options.rootDir);
     const addImportsDir = (dir) => {
       const files = readdirSync(dir);
       files.forEach((file) => {
@@ -27,12 +27,32 @@ const module = defineNuxtModule({
         addImports({ as: name, from: path, name });
       });
     };
-    if (options.composables) {
-      addImportsDir(resolver.resolve("./runtime/composables"));
-    }
-    if (options.utils) {
-      addImportsDir(resolver.resolve("./runtime/utils"));
+    addImportsDir(resolver.resolve("./runtime/composables"));
+    addImportsDir(resolver.resolve("./runtime/utils"));
+    const iconDir = rootResolver.resolve(options.iconDir);
+    if (!existsSync(iconDir)) {
+      return;
     }
+    addTypeTemplate({
+      filename: "types/leexi-shared.d.ts",
+      getContents: () => {
+        const icons = readdirSync(iconDir).map((filename) => filename.replace(".svg", ""));
+        return [
+          "// Generated by @leexi/shared",
+          "",
+          "declare module '@leexi/shared' {",
+          `  export type IconName = ${icons.map((icon) => `'${icon}'`).join(" | ")}`,
+          "}",
+          "",
+          "export {}"
+        ].join("\n");
+      }
+    });
+    nuxt.hook("builder:watch", (event, path) => {
+      if (["add", "unlink"].includes(event) && path.includes(options.iconDir)) {
+        updateTemplates({ filter: ({ filename }) => filename === "types/leexi-shared.d.ts" });
+      }
+    });
   }
 });
 

package/dist/runtime/composables/useLocalStorage.js

@@ -33,6 +33,6 @@ export const useLocalStorage = (key, defaultValue) => {
     } else {
       localStorage?.removeItem(key);
     }
-  }, { immediate: true });
+  }, { deep: true, immediate: true });
   return data;
 };

package/dist/runtime/utils/array/index.d.ts

@@ -2,6 +2,7 @@ export { castArray } from "./castArray.js";
 export { groupBy } from "./groupBy.js";
 export { joinBy } from "./joinBy.js";
 export { partition } from "./partition.js";
+export { pluck } from "./pluck.js";
 export { removeRecord } from "./removeRecord.js";
 export { replaceRecord } from "./replaceRecord.js";
 export { sortBy } from "./sortBy.js";

package/dist/runtime/utils/array/index.js

@@ -2,6 +2,7 @@ export { castArray } from './castArray.js';
 export { groupBy } from './groupBy.js';
 export { joinBy } from './joinBy.js';
 export { partition } from './partition.js';
+export { pluck } from './pluck.js';
 export { removeRecord } from './removeRecord.js';
 export { replaceRecord } from './replaceRecord.js';
 export { sortBy } from './sortBy.js';

package/dist/runtime/utils/array/pluck.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Extract the given attribute from each element in the array.
+ *
+ * @param records An array of records.
+ * @param attr An attribute of the given records.
+ * @returns An array of records mapped to the given attribute.
+ *
+ * @example
+ * const records = [{ foo: 1 }, { foo: 2 }];
+ * const foos = pluck(records, 'foo');
+ *
+ * console.log(foos); // Output: [1, 2]
+ */
+export declare const pluck: <T extends Record<string, unknown>, K extends keyof T>(records: T[], attr: K) => T[K][];

package/dist/runtime/utils/array/pluck.js

@@ -0,0 +1 @@
+export const pluck = (records, attr) => records.map((record) => record[attr]);

package/dist/runtime/utils/array/sum.d.ts

@@ -1 +1,12 @@
-export function sum(numbers: any): any;
+/**
+ * Returns the sum of elements.
+ *
+ * @param numbers An array of number.
+ * @returns The sum of numbers.
+ *
+ * @example
+ * const sum = sum([1, 2, 3])
+ *
+ * console.log(sum); // Output: 6
+ */
+export declare const sum: (numbers: number[]) => number;

package/dist/runtime/utils/array/sum.js

@@ -1 +1 @@
-export const sum = numbers => numbers.reduce((a, b) => a + b, 0);
+export const sum = (numbers) => numbers.reduce((a, b) => a + b, 0);

package/dist/runtime/utils/array/sumBy.d.ts

@@ -1 +1,15 @@
-export function sumBy(records: any, attr: any): any;
+import type { FilteredAttrs } from '~/types';
+/**
+ * Returns the sum of elements at a given attribute.
+ *
+ * @param records An array of records.
+ * @param attr An attribute of the given records.
+ * @returns The sum of numbers.
+ *
+ * @example
+ * const records = [{ foo: 1 }, { foo: 2 }];
+ * const sum = sumBy(records, 'foo');
+ *
+ * console.log(sum); // Output: 3
+ */
+export declare const sumBy: <T extends Record<string, unknown>>(records: T[], attr: FilteredAttrs<T, number>) => number;

package/dist/runtime/utils/array/sumBy.js

@@ -1,3 +1,2 @@
-import { sum } from '../index.js';
-
-export const sumBy = (records, attr) => sum(records.map(record => record[attr]));
+import { pluck, sum } from "../index.js";
+export const sumBy = (records, attr) => sum(pluck(records, attr));

package/dist/runtime/utils/array/uniq.d.ts

@@ -1 +1,13 @@
-export function uniq(values: any): any[];
+import type { Primitive } from '~/types';
+/**
+ * Returns a new array by removing duplicate values in self.
+ *
+ * @param primitives An array of boolean, number and/or string.
+ * @returns The filtered array of primitives.
+ *
+ * @example
+ * const uniq = uniq([true, true, false, 1, 1, 2, 'foo', 'foo', 'bar'])
+ *
+ * console.log(uniq); // Output: [true, false, 1, 2, 'foo', 'bar']
+ */
+export declare const uniq: (primitives: Primitive[]) => Primitive[];

package/dist/runtime/utils/array/uniq.js

@@ -1 +1 @@
-export const uniq = values => [...new Set(values || [])];
+export const uniq = (primitives) => [...new Set(primitives || [])];

package/dist/runtime/utils/objects/isSame.d.ts

@@ -1,6 +1,6 @@
 /**
  * Checks if two objects are the same by comparing their JSON stringified representations.
- * Note: This method has limitations and may not accurately compare objects with different key orders, non-primitive values like functions or Dates, or circular references.
+ * Note: This method has limitations and may not accurately compare objects with different key orders, complex values like functions or Dates, or circular references.
  *
  * @param a The first object to compare.
  * @param b The second object to compare.

package/package.json

@@ -2,7 +2,7 @@
   "license": "UNLICENSED",
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.5.2",
+  "version": "0.7.0",
   "exports": {
     "./composables": {
       "import": "./dist/runtime/composables/index.js",
@@ -46,25 +46,25 @@
     "tsc": "vue-tsc --noEmit"
   },
   "dependencies": {
-    "@stylistic/eslint-plugin": "^5.3.1",
+    "@stylistic/eslint-plugin": "^5.4.0",
     "@types/eslint-plugin-tailwindcss": "^3.17.0",
-    "eslint": "^9.34.0",
+    "eslint": "^9.36.0",
     "eslint-plugin-sort-keys-plus": "^1.5.0",
     "eslint-plugin-tailwindcss": "^3.18.2",
-    "eslint-plugin-vue": "^10.4.0",
-    "globals": "^16.3.0",
-    "typescript": "^5.9.2",
-    "typescript-eslint": "^8.42.0",
+    "eslint-plugin-vue": "^10.5.0",
+    "globals": "^16.4.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.45.0",
     "vue-eslint-parser": "^10.2.0"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^1.0.2",
     "@nuxt/test-utils": "^3.19.2",
     "@types/node": "<23.0.0",
-    "happy-dom": "^18.0.1",
-    "nuxt": "^4.1.0",
+    "happy-dom": "^19.0.2",
+    "nuxt": "^4.1.2",
     "tailwindcss": "<4.0.0",
     "vitest": "^3.2.4",
-    "vue-tsc": "^3.0.6"
+    "vue-tsc": "^3.1.0"
   }
 }