@leexi/shared 0.1.1 → 0.2.0

package/dist/eslint/vue.js

@@ -0,0 +1,43 @@
+import tailwind from 'eslint-plugin-tailwindcss';
+import vue from 'eslint-plugin-vue';
+import base from './base.js';
+export default [
+    ...base,
+    ...tailwind.configs['flat/recommended'],
+    ...vue.configs['flat/recommended'],
+    {
+        files: ['**/*.vue'],
+        rules: {
+            '@stylistic/js/indent': 'off',
+            '@stylistic/js/object-curly-spacing': 'off',
+            'tailwindcss/no-custom-classname': 'error',
+            'vue/attributes-order': ['error', {
+                    alphabetical: true,
+                }],
+            'vue/component-name-in-template-casing': ['error', 'PascalCase', {
+                    registeredComponentsOnly: false,
+                }],
+            'vue/first-attribute-linebreak': ['error', {
+                    singleline: 'beside',
+                }],
+            'vue/multi-word-component-names': 'off',
+            'vue/no-bare-strings-in-template': ['error', {
+                    allowlist: ['Leexi'],
+                }],
+            'vue/object-curly-spacing': ['error', 'always'],
+            'vue/prefer-template': 'error',
+            'vue/script-indent': ['error', 2, {
+                    baseIndent: 1,
+                    switchCase: 1,
+                }],
+            'vue/template-curly-spacing': ['error', 'never'],
+        },
+    },
+    {
+        ignores: [
+            '.nuxt/',
+            '.output/',
+            'dist/',
+        ],
+    },
+];

package/dist/module.d.ts

@@ -0,0 +1,8 @@
+declare const _default: import("@nuxt/schema").NuxtModule<{
+    composables: boolean;
+    utils: boolean;
+}, {
+    composables: boolean;
+    utils: boolean;
+}, false>;
+export default _default;

package/dist/module.js

@@ -0,0 +1,36 @@
+import { readdirSync, statSync } from 'fs';
+import { addImports, createResolver, defineNuxtModule } from '@nuxt/kit';
+export default defineNuxtModule({
+    defaults: {
+        composables: true,
+        utils: true,
+    },
+    meta: {
+        configKey: 'leexi',
+        name: '@leexi/shared',
+    },
+    setup: options => {
+        const resolver = createResolver(import.meta.url);
+        const addImportsDir = (dir) => {
+            const files = readdirSync(dir);
+            files.forEach(file => {
+                if (/index/.test(file) || /\.d\.ts/.test(file)) {
+                    return;
+                }
+                const path = resolver.resolve(`${dir}/${file}`);
+                const stat = statSync(path);
+                if (stat.isDirectory()) {
+                    return addImportsDir(path);
+                }
+                const [name] = file.split('.');
+                addImports({ as: name, from: path, name });
+            });
+        };
+        if (options.composables) {
+            addImportsDir(resolver.resolve('./composables'));
+        }
+        if (options.utils) {
+            addImportsDir(resolver.resolve('./utils'));
+        }
+    },
+});

package/dist/utils/index.js

@@ -0,0 +1 @@
+export * from './objects/index.js';

package/dist/utils/objects/deepDup.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Deeply duplicates an object.
+ *
+ * @param object - an object
+ * @returns a duplicate of the same object
+ *
+ * @example
+ * const object = [{ foo: 'bar' }]
+ * const dup = deepDup(object) // => `[{ foo: 'bar' }]`
+ * object === dup // => `false`
+ */
+export declare const deepDup: <T extends object>(object: T) => T;

package/dist/utils/objects/deepDup.js

@@ -0,0 +1,28 @@
+/**
+ * Deeply duplicates an object.
+ *
+ * @param object - an object
+ * @returns a duplicate of the same object
+ *
+ * @example
+ * const object = [{ foo: 'bar' }]
+ * const dup = deepDup(object) // => `[{ foo: 'bar' }]`
+ * object === dup // => `false`
+ */
+export const deepDup = (object) => {
+    if (!object || typeof object !== 'object') {
+        return object;
+    }
+    const duplicate = (value) => value && typeof value === 'object' ? deepDup(value) : value;
+    if (Array.isArray(object)) {
+        return object.map(duplicate);
+    }
+    if (object instanceof Set) {
+        return new Set([...object].map(duplicate));
+    }
+    if (Object.getPrototypeOf(object) === Object.prototype) {
+        const dup = Object.entries(object).map(([key, value]) => [key, duplicate(value)]);
+        return Object.fromEntries(dup);
+    }
+    return object;
+};

package/dist/utils/objects/index.js

@@ -0,0 +1,2 @@
+export { deepDup } from './deepDup.js';
+export { isSame } from './isSame.js';

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

@@ -0,0 +1,12 @@
+/**
+ * Compares whether two objects are identical.
+ *
+ * @param a - an object
+ * @param b - another object
+ * @returns whether these objects are identical
+ *
+ * @example
+ * isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`
+ * isSame([{ foo: 'bar' }], [{ bar: 'foo' }]) // => `false`
+ */
+export declare const isSame: (a: object, b: object) => boolean;

package/{src → dist}/utils/objects/isSame.js

@@ -1,9 +1,9 @@
 /**
  * Compares whether two objects are identical.
  *
- * @param {object} a - an object
- * @param {object} b - another object
- * @returns {boolean} whether these objects are identical
+ * @param a - an object
+ * @param b - another object
+ * @returns whether these objects are identical
  *
  * @example
  * isSame([{ foo: 'bar' }], [{ foo: 'bar' }]) // => `true`

package/package.json

@@ -1,22 +1,39 @@
 {
   "name": "@leexi/shared",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "scripts": {
+    "build": "yarn lint && yarn test --reporter default && tsc && tsc -p tsconfig.build.json",
     "lint": "eslint .",
+    "postinstall": "nuxt prepare",
     "test": "vitest run"
   },
   "exports": {
-    "./composables": "./src/composables/index.js",
-    "./eslint/base": "./src/eslint/base.js",
-    "./eslint/vue": "./src/eslint/vue.js",
-    "./utils": "./src/utils/index.js",
-    ".": "./src/module.js"
+    "./composables": {
+      "import": "./dist/composables/index.js",
+      "types": "./dist/composables/index.d.ts"
+    },
+    "./eslint/base": {
+      "import": "./dist/eslint/base.js",
+      "types": "./dist/eslint/base.d.ts"
+    },
+    "./eslint/vue": {
+      "import": "./dist/eslint/vue.js",
+      "types": "./dist/eslint/vue.d.ts"
+    },
+    "./utils": {
+      "import": "./dist/utils/index.js",
+      "types": "./dist/utils/index.d.ts"
+    },
+    ".": {
+      "import": "./dist/module.js",
+      "types": "./dist/module.d.ts"
+    }
   },
   "files": [
-    "src"
+    "dist"
   ],
-  "main": "./src/module.js",
+  "main": "./dist/module.js",
   "dependencies": {
     "@stylistic/eslint-plugin-js": "^4.2.0",
     "@stylistic/eslint-plugin-ts": "^4.2.0",
@@ -30,6 +47,7 @@
   },
   "devDependencies": {
     "@nuxt/test-utils": "^3.17.2",
+    "@types/node": "^22.14.0",
     "eslint": "^9.23.0",
     "happy-dom": "^17.4.4",
     "nuxt": "^3.16.2",

package/src/composables/index.js

@@ -1 +0,0 @@
-export { useLocalStorage } from './useLocalStorage.js';

package/src/composables/useLocalStorage.js

@@ -1,30 +0,0 @@
-import { useState, watch } from '#imports';
-
-/**
- * Creates a reactive pointer to a specific localStorage value.
- * The value is stored in the localStorage as a JSON stringified data to enable parsing primitives and objects
- *
- * @template T extends unknown
- * @param {string} key - a key pointing to a localStorage value
- * @param {T} [defaultValue] - an optional default value used if the localStorage value is undefined
- * @returns {Ref<T>} a reactive variable pointing to that localStorage value
- *
- * @example
- * const fooOne = useLocalStorage('foo')
- * const fooTwo = useLocalStorage('foo', 'bar')
- * fooOne.value // => 'bar'
- * localStorage.foo // => '"bar"'
- */
-export const useLocalStorage = (key, defaultValue) => {
-  const data = useState(key, () => JSON.parse(localStorage?.getItem(key) || null) || defaultValue);
-
-  watch(data, () => {
-    if (data.value) {
-      localStorage?.setItem(key, JSON.stringify(data.value));
-    } else {
-      localStorage?.removeItem(key);
-    }
-  }, { immediate: true });
-
-  return data;
-};

package/src/eslint/base.js

@@ -1,117 +0,0 @@
-import js from '@eslint/js';
-import stylisticJS from '@stylistic/eslint-plugin-js';
-import stylisticTS from '@stylistic/eslint-plugin-ts';
-import globals from 'globals';
-import tseslint from 'typescript-eslint';
-
-export default [
-  js.configs.recommended,
-  ...tseslint.configs.recommended,
-
-  // base config
-  {
-    languageOptions: {
-      globals: {
-        ...globals.browser,
-        ...globals.node,
-      },
-      parserOptions: {
-        ecmaVersion: 'latest',
-        sourceType: 'module',
-      },
-    },
-    plugins: {
-      '@stylistic/js': stylisticJS,
-    },
-    rules: {
-      'arrow-body-style': ['error', 'as-needed'],
-      'eqeqeq': ['error', 'smart'],
-      'no-console': 'error',
-      'no-unused-vars': ['error', {
-        argsIgnorePattern: '^_',
-        destructuredArrayIgnorePattern: '^_',
-        ignoreRestSiblings: true,
-      }],
-      'prefer-const': ['error', {
-        destructuring: 'all',
-      }],
-      'prefer-template': 'error',
-
-      '@stylistic/js/array-bracket-spacing': ['error', 'never'],
-      '@stylistic/js/comma-dangle': ['error', 'always-multiline'],
-      '@stylistic/js/comma-spacing': 'error',
-      '@stylistic/js/eol-last': ['error', 'always'],
-      '@stylistic/js/indent': ['error', 2, {
-        SwitchCase: 1,
-      }],
-      '@stylistic/js/key-spacing': 'error',
-      '@stylistic/js/keyword-spacing': 'error',
-      '@stylistic/js/no-multi-spaces': 'error',
-      '@stylistic/js/no-multiple-empty-lines': ['error', {
-        max: 1,
-      }],
-      '@stylistic/js/no-trailing-spaces': 'error',
-      '@stylistic/js/object-curly-spacing': ['error', 'always'],
-      '@stylistic/js/quotes': ['error', 'single'],
-      '@stylistic/js/quote-props': ['error', 'consistent-as-needed'],
-      '@stylistic/js/semi': ['error', 'always'],
-      '@stylistic/js/semi-spacing': 'error',
-      '@stylistic/js/space-before-blocks': ['error', 'always'],
-      '@stylistic/js/space-before-function-paren': ['error', 'always'],
-      '@stylistic/js/space-in-parens': ['error', 'never'],
-      '@stylistic/js/space-infix-ops': 'error',
-      '@stylistic/js/spaced-comment': 'error',
-      '@stylistic/js/template-curly-spacing': ['error', 'never'],
-
-      '@typescript-eslint/no-unused-expressions': 'off',
-      '@typescript-eslint/no-unused-vars': ['error', {
-        argsIgnorePattern: '^_',
-        destructuredArrayIgnorePattern: '^_',
-        ignoreRestSiblings: true,
-      }],
-    },
-  },
-
-  // typescript
-  {
-    files: ['**/*.ts'],
-    plugins: {
-      '@stylistic/ts': stylisticTS,
-    },
-    rules: {
-      '@stylistic/js/comma-dangle': 'off',
-      '@stylistic/js/comma-spacing': 'off',
-      '@stylistic/js/indent': 'off',
-      '@stylistic/js/key-spacing': 'off',
-      '@stylistic/js/keyword-spacing': 'off',
-      '@stylistic/js/object-curly-spacing': 'off',
-      '@stylistic/js/quotes': 'off',
-      '@stylistic/js/quote-props': 'off',
-      '@stylistic/js/semi': 'off',
-      '@stylistic/js/space-before-blocks': 'off',
-      '@stylistic/js/space-before-function-paren': 'off',
-      '@stylistic/js/space-infix-ops': 'off',
-
-      '@stylistic/ts/comma-dangle': ['error', 'always-multiline'],
-      '@stylistic/ts/comma-spacing': 'error',
-      '@stylistic/ts/indent': ['error', 2, {
-        SwitchCase: 1,
-      }],
-      '@stylistic/ts/key-spacing': 'error',
-      '@stylistic/ts/keyword-spacing': 'error',
-      '@stylistic/ts/object-curly-spacing': ['error', 'always'],
-      '@stylistic/ts/quotes': ['error', 'single'],
-      '@stylistic/ts/quote-props': ['error', 'consistent-as-needed'],
-      '@stylistic/ts/semi': ['error', 'always'],
-      '@stylistic/ts/space-before-blocks': ['error', 'always'],
-      '@stylistic/ts/space-before-function-paren': ['error', 'always'],
-      '@stylistic/ts/space-infix-ops': 'error',
-    },
-  },
-
-  {
-    ignores: [
-      'node_modules/',
-    ],
-  },
-];

package/src/eslint/vue.js

@@ -1,49 +0,0 @@
-
-import tailwind from 'eslint-plugin-tailwindcss';
-import vue from 'eslint-plugin-vue';
-import base from './base.js';
-
-export default [
-  ...base,
-  ...tailwind.configs['flat/recommended'],
-  ...vue.configs['flat/recommended'],
-
-  {
-    files: ['**/*.vue'],
-    rules: {
-      '@stylistic/js/indent': 'off',
-      '@stylistic/js/object-curly-spacing': 'off',
-
-      'tailwindcss/no-custom-classname': 'error',
-
-      'vue/attributes-order': ['error', {
-        alphabetical: true,
-      }],
-      'vue/component-name-in-template-casing': ['error', 'PascalCase', {
-        registeredComponentsOnly: false,
-      }],
-      'vue/first-attribute-linebreak': ['error', {
-        singleline: 'beside',
-      }],
-      'vue/multi-word-component-names': 'off',
-      'vue/no-bare-strings-in-template': ['error', {
-        allowlist: ['Leexi'],
-      }],
-      'vue/object-curly-spacing': ['error', 'always'],
-      'vue/prefer-template': 'error',
-      'vue/script-indent': ['error', 2, {
-        baseIndent: 1,
-        switchCase: 1,
-      }],
-      'vue/template-curly-spacing': ['error', 'never'],
-    },
-  },
-
-  {
-    ignores: [
-      '.nuxt/',
-      '.output/',
-      'dist/',
-    ],
-  },
-];

package/src/module.js

@@ -1,33 +0,0 @@
-import { readdirSync, statSync } from 'fs';
-import { addImports, createResolver, defineNuxtModule } from '@nuxt/kit';
-
-export default defineNuxtModule({
-  defaults: {
-    composables: true,
-    utils: true,
-  },
-  meta: {
-    configKey: 'leexi',
-    name: '@leexi/shared',
-  },
-  setup: options => {
-    const resolver = createResolver(import.meta.url);
-
-    const addImportsDir = dir => {
-      const files = readdirSync(dir);
-      files.forEach(file => {
-        if (file === 'index.js') { return; }
-
-        const path = resolver.resolve(`${dir}/${file}`);
-        const stat = statSync(path);
-        if (stat.isDirectory()) { return addImportsDir(path); }
-
-        const name = file.replace('.js', '');
-        addImports({ as: name, from: path, name });
-      });
-    };
-
-    if (options.composables) { addImportsDir(resolver.resolve('./composables')); }
-    if (options.utils) { addImportsDir(resolver.resolve('./utils')); }
-  },
-});

package/src/utils/objects/deepDup.js

@@ -1,31 +0,0 @@
-/**
- * Deeply duplicates an object.
- *
- * @param {object} object - an object
- * @returns {object} a duplicate of the same object
- *
- * @example
- * const object = [{ foo: 'bar' }]
- * const dup = deepDup(object) // => `[{ foo: 'bar' }]`
- * object === dup // => `false`
- */
-export const deepDup = object => {
-  if (!object || typeof object !== 'object') { return object; }
-
-  const duplicate = value => typeof value === 'object' ? deepDup(value) : value;
-
-  if (Array.isArray(object)) {
-    return object.map(duplicate);
-  }
-
-  if (object instanceof Set) {
-    return new Set([...object].map(duplicate));
-  }
-
-  if (Object.getPrototypeOf(object) === Object.prototype) {
-    const dup = Object.entries(object).map(([key, value]) => [key, duplicate(value)]);
-    return Object.fromEntries(dup);
-  }
-
-  return object;
-};