mirror of
https://github.com/robonen/tools.git
synced 2026-03-20 19:04:46 +00:00
Compare commits
1 Commits
d7363704d6
...
df9fff0377
| Author | SHA1 | Date | |
|---|---|---|---|
|
df9fff0377 |
8
.github/workflows/ci.yaml
vendored
8
.github/workflows/ci.yaml
vendored
@@ -31,11 +31,5 @@ jobs:
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
|
||||
- name: Lint
|
||||
run: pnpm lint
|
||||
|
||||
- name: Test
|
||||
run: pnpm test
|
||||
run: pnpm build && pnpm test
|
||||
@@ -1,54 +0,0 @@
|
||||
# @robonen/oxlint
|
||||
|
||||
Composable [oxlint](https://oxc.rs/docs/guide/usage/linter.html) configuration presets.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm install -D @robonen/oxlint oxlint
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Create `oxlint.config.ts` in your project root:
|
||||
|
||||
```ts
|
||||
import { defineConfig } from 'oxlint';
|
||||
import { compose, base, typescript, vue, vitest, imports } from '@robonen/oxlint';
|
||||
|
||||
export default defineConfig(
|
||||
compose(base, typescript, vue, vitest, imports),
|
||||
);
|
||||
```
|
||||
|
||||
Append custom rules after presets to override them:
|
||||
|
||||
```ts
|
||||
compose(base, typescript, {
|
||||
rules: { 'eslint/no-console': 'off' },
|
||||
ignorePatterns: ['dist'],
|
||||
});
|
||||
```
|
||||
|
||||
## Presets
|
||||
|
||||
| Preset | Description |
|
||||
| ------------ | -------------------------------------------------- |
|
||||
| `base` | Core eslint, oxc, unicorn rules |
|
||||
| `typescript` | TypeScript-specific rules (via overrides) |
|
||||
| `vue` | Vue 3 Composition API / `<script setup>` rules |
|
||||
| `vitest` | Test file rules (via overrides) |
|
||||
| `imports` | Import rules (cycles, duplicates, ordering) |
|
||||
| `node` | Node.js-specific rules |
|
||||
|
||||
## API
|
||||
|
||||
### `compose(...configs: OxlintConfig[]): OxlintConfig`
|
||||
|
||||
Merges multiple configs into one:
|
||||
|
||||
- **plugins** — union (deduplicated)
|
||||
- **rules / categories** — last wins
|
||||
- **overrides / ignorePatterns** — concatenated
|
||||
- **env / globals** — shallow merge
|
||||
- **settings** — deep merge
|
||||
@@ -1,4 +0,0 @@
|
||||
import { defineConfig } from 'oxlint';
|
||||
import { compose, base, typescript, imports } from '@robonen/oxlint';
|
||||
|
||||
export default defineConfig(compose(base, typescript, imports));
|
||||
@@ -1,52 +0,0 @@
|
||||
{
|
||||
"name": "@robonen/oxlint",
|
||||
"version": "0.0.1",
|
||||
"license": "Apache-2.0",
|
||||
"description": "Composable oxlint configuration presets",
|
||||
"keywords": [
|
||||
"oxlint",
|
||||
"oxc",
|
||||
"linter",
|
||||
"config",
|
||||
"presets"
|
||||
],
|
||||
"author": "Robonen Andrew <robonenandrew@gmail.com>",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/robonen/tools.git",
|
||||
"directory": "configs/oxlint"
|
||||
},
|
||||
"packageManager": "pnpm@10.29.3",
|
||||
"engines": {
|
||||
"node": ">=24.13.1"
|
||||
},
|
||||
"type": "module",
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.js",
|
||||
"require": "./dist/index.cjs"
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "oxlint -c oxlint.config.ts",
|
||||
"test": "vitest run",
|
||||
"dev": "vitest dev",
|
||||
"build": "tsdown"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@robonen/oxlint": "workspace:*",
|
||||
"@robonen/tsconfig": "workspace:*",
|
||||
"oxlint": "catalog:",
|
||||
"tsdown": "catalog:"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"oxlint": ">=1.0.0"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
}
|
||||
}
|
||||
@@ -1,103 +0,0 @@
|
||||
import type { OxlintConfig } from './types';
|
||||
|
||||
/**
|
||||
* Deep merge two objects. Arrays are concatenated, objects are recursively merged.
|
||||
*/
|
||||
function deepMerge(target: Record<string, unknown>, source: Record<string, unknown>): Record<string, unknown> {
|
||||
const result = { ...target };
|
||||
|
||||
for (const key of Object.keys(source)) {
|
||||
const targetValue = target[key];
|
||||
const sourceValue = source[key];
|
||||
|
||||
if (
|
||||
typeof targetValue === 'object' && targetValue !== null && !Array.isArray(targetValue)
|
||||
&& typeof sourceValue === 'object' && sourceValue !== null && !Array.isArray(sourceValue)
|
||||
) {
|
||||
result[key] = deepMerge(
|
||||
targetValue as Record<string, unknown>,
|
||||
sourceValue as Record<string, unknown>,
|
||||
);
|
||||
}
|
||||
else {
|
||||
result[key] = sourceValue;
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Compose multiple oxlint configurations into a single config.
|
||||
*
|
||||
* - `plugins` — union (deduplicated)
|
||||
* - `categories` — later configs override earlier
|
||||
* - `rules` — later configs override earlier
|
||||
* - `overrides` — concatenated
|
||||
* - `env` — merged (later overrides earlier)
|
||||
* - `globals` — merged (later overrides earlier)
|
||||
* - `settings` — deep-merged
|
||||
* - `ignorePatterns` — concatenated
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* import { compose, base, typescript, vue } from '@robonen/oxlint';
|
||||
* import { defineConfig } from 'oxlint';
|
||||
*
|
||||
* export default defineConfig(
|
||||
* compose(base, typescript, vue, {
|
||||
* rules: { 'eslint/no-console': 'off' },
|
||||
* }),
|
||||
* );
|
||||
* ```
|
||||
*/
|
||||
export function compose(...configs: OxlintConfig[]): OxlintConfig {
|
||||
const result: OxlintConfig = {};
|
||||
|
||||
for (const config of configs) {
|
||||
// Plugins — union with dedup
|
||||
if (config.plugins?.length) {
|
||||
result.plugins = Array.from(new Set([...(result.plugins ?? []), ...config.plugins]));
|
||||
}
|
||||
|
||||
// Categories — shallow merge
|
||||
if (config.categories) {
|
||||
result.categories = { ...result.categories, ...config.categories };
|
||||
}
|
||||
|
||||
// Rules — shallow merge (later overrides earlier)
|
||||
if (config.rules) {
|
||||
result.rules = { ...result.rules, ...config.rules };
|
||||
}
|
||||
|
||||
// Overrides — concatenate
|
||||
if (config.overrides?.length) {
|
||||
result.overrides = [...(result.overrides ?? []), ...config.overrides];
|
||||
}
|
||||
|
||||
// Env — shallow merge
|
||||
if (config.env) {
|
||||
result.env = { ...result.env, ...config.env };
|
||||
}
|
||||
|
||||
// Globals — shallow merge
|
||||
if (config.globals) {
|
||||
result.globals = { ...result.globals, ...config.globals };
|
||||
}
|
||||
|
||||
// Settings — deep merge
|
||||
if (config.settings) {
|
||||
result.settings = deepMerge(
|
||||
(result.settings ?? {}) as Record<string, unknown>,
|
||||
config.settings as Record<string, unknown>,
|
||||
);
|
||||
}
|
||||
|
||||
// Ignore patterns — concatenate
|
||||
if (config.ignorePatterns?.length) {
|
||||
result.ignorePatterns = [...(result.ignorePatterns ?? []), ...config.ignorePatterns];
|
||||
}
|
||||
}
|
||||
|
||||
return result;
|
||||
}
|
||||
@@ -1,17 +0,0 @@
|
||||
/* Compose */
|
||||
export { compose } from './compose';
|
||||
|
||||
/* Presets */
|
||||
export { base, typescript, vue, vitest, imports, node } from './presets';
|
||||
|
||||
/* Types */
|
||||
export type {
|
||||
OxlintConfig,
|
||||
OxlintOverride,
|
||||
OxlintEnv,
|
||||
OxlintGlobals,
|
||||
AllowWarnDeny,
|
||||
DummyRule,
|
||||
DummyRuleMap,
|
||||
RuleCategories,
|
||||
} from './types';
|
||||
@@ -1,73 +0,0 @@
|
||||
import type { OxlintConfig } from '../types';
|
||||
|
||||
/**
|
||||
* Base configuration for any JavaScript/TypeScript project.
|
||||
*
|
||||
* Enables `correctness` category and opinionated rules from
|
||||
* `eslint`, `oxc`, and `unicorn` plugins.
|
||||
*/
|
||||
export const base: OxlintConfig = {
|
||||
plugins: ['eslint', 'oxc', 'unicorn'],
|
||||
|
||||
categories: {
|
||||
correctness: 'error',
|
||||
},
|
||||
|
||||
rules: {
|
||||
/* ── eslint core ──────────────────────────────────────── */
|
||||
'eslint/eqeqeq': 'error',
|
||||
'eslint/no-console': 'warn',
|
||||
'eslint/no-debugger': 'error',
|
||||
'eslint/no-eval': 'error',
|
||||
'eslint/no-var': 'error',
|
||||
'eslint/prefer-const': 'error',
|
||||
'eslint/prefer-template': 'warn',
|
||||
'eslint/no-useless-constructor': 'warn',
|
||||
'eslint/no-useless-rename': 'warn',
|
||||
'eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
|
||||
'eslint/no-self-compare': 'error',
|
||||
'eslint/no-template-curly-in-string': 'warn',
|
||||
'eslint/no-throw-literal': 'error',
|
||||
'eslint/no-return-assign': 'warn',
|
||||
'eslint/no-else-return': 'warn',
|
||||
'eslint/no-lonely-if': 'warn',
|
||||
'eslint/no-unneeded-ternary': 'warn',
|
||||
'eslint/prefer-object-spread': 'warn',
|
||||
'eslint/prefer-exponentiation-operator': 'warn',
|
||||
'eslint/no-useless-computed-key': 'warn',
|
||||
'eslint/no-useless-concat': 'warn',
|
||||
'eslint/curly': 'off',
|
||||
|
||||
/* ── unicorn ──────────────────────────────────────────── */
|
||||
'unicorn/prefer-node-protocol': 'error',
|
||||
'unicorn/no-instanceof-array': 'error',
|
||||
'unicorn/no-new-array': 'error',
|
||||
'unicorn/prefer-array-flat-map': 'warn',
|
||||
'unicorn/prefer-array-flat': 'warn',
|
||||
'unicorn/prefer-includes': 'warn',
|
||||
'unicorn/prefer-string-slice': 'warn',
|
||||
'unicorn/prefer-string-starts-ends-with': 'warn',
|
||||
'unicorn/throw-new-error': 'error',
|
||||
'unicorn/error-message': 'warn',
|
||||
'unicorn/no-useless-spread': 'warn',
|
||||
'unicorn/no-useless-undefined': 'off',
|
||||
'unicorn/prefer-optional-catch-binding': 'warn',
|
||||
'unicorn/prefer-type-error': 'warn',
|
||||
'unicorn/no-thenable': 'error',
|
||||
'unicorn/prefer-number-properties': 'warn',
|
||||
'unicorn/prefer-global-this': 'warn',
|
||||
|
||||
/* ── oxc ──────────────────────────────────────────────── */
|
||||
'oxc/no-accumulating-spread': 'warn',
|
||||
'oxc/bad-comparison-sequence': 'error',
|
||||
'oxc/bad-min-max-func': 'error',
|
||||
'oxc/bad-object-literal-comparison': 'error',
|
||||
'oxc/const-comparisons': 'error',
|
||||
'oxc/double-comparisons': 'error',
|
||||
'oxc/erasing-op': 'error',
|
||||
'oxc/missing-throw': 'error',
|
||||
'oxc/bad-bitwise-operator': 'error',
|
||||
'oxc/bad-char-at-comparison': 'error',
|
||||
'oxc/bad-replace-all-arg': 'error',
|
||||
},
|
||||
};
|
||||
@@ -1,20 +0,0 @@
|
||||
import type { OxlintConfig } from '../types';
|
||||
|
||||
/**
|
||||
* Import plugin rules for clean module boundaries.
|
||||
*/
|
||||
export const imports: OxlintConfig = {
|
||||
plugins: ['import'],
|
||||
|
||||
rules: {
|
||||
'import/no-duplicates': 'error',
|
||||
'import/no-self-import': 'error',
|
||||
'import/no-cycle': 'warn',
|
||||
'import/first': 'warn',
|
||||
'import/no-mutable-exports': 'error',
|
||||
'import/no-amd': 'error',
|
||||
'import/no-commonjs': 'warn',
|
||||
'import/no-empty-named-blocks': 'warn',
|
||||
'import/consistent-type-specifier-style': ['warn', 'prefer-top-level'],
|
||||
},
|
||||
};
|
||||
@@ -1,6 +0,0 @@
|
||||
export { base } from './base';
|
||||
export { typescript } from './typescript';
|
||||
export { vue } from './vue';
|
||||
export { vitest } from './vitest';
|
||||
export { imports } from './imports';
|
||||
export { node } from './node';
|
||||
@@ -1,17 +0,0 @@
|
||||
import type { OxlintConfig } from '../types';
|
||||
|
||||
/**
|
||||
* Node.js-specific rules.
|
||||
*/
|
||||
export const node: OxlintConfig = {
|
||||
plugins: ['node'],
|
||||
|
||||
env: {
|
||||
node: true,
|
||||
},
|
||||
|
||||
rules: {
|
||||
'node/no-exports-assign': 'error',
|
||||
'node/no-new-require': 'error',
|
||||
},
|
||||
};
|
||||
@@ -1,39 +0,0 @@
|
||||
import type { OxlintConfig } from '../types';
|
||||
|
||||
/**
|
||||
* TypeScript-specific rules.
|
||||
*
|
||||
* Applied via `overrides` for `*.ts`, `*.tsx`, `*.mts`, `*.cts` files.
|
||||
*/
|
||||
export const typescript: OxlintConfig = {
|
||||
plugins: ['typescript'],
|
||||
|
||||
overrides: [
|
||||
{
|
||||
files: ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts'],
|
||||
rules: {
|
||||
'typescript/consistent-type-imports': 'error',
|
||||
'typescript/no-explicit-any': 'off',
|
||||
'typescript/no-non-null-assertion': 'off',
|
||||
'typescript/prefer-as-const': 'error',
|
||||
'typescript/no-empty-object-type': 'warn',
|
||||
'typescript/no-wrapper-object-types': 'error',
|
||||
'typescript/no-duplicate-enum-values': 'error',
|
||||
'typescript/no-unsafe-declaration-merging': 'error',
|
||||
'typescript/no-import-type-side-effects': 'error',
|
||||
'typescript/no-useless-empty-export': 'warn',
|
||||
'typescript/no-inferrable-types': 'warn',
|
||||
'typescript/prefer-function-type': 'warn',
|
||||
'typescript/ban-tslint-comment': 'error',
|
||||
'typescript/consistent-type-definitions': ['warn', 'interface'],
|
||||
'typescript/prefer-for-of': 'warn',
|
||||
'typescript/no-unnecessary-type-constraint': 'warn',
|
||||
'typescript/adjacent-overload-signatures': 'warn',
|
||||
'typescript/array-type': ['warn', { default: 'array-simple' }],
|
||||
'typescript/no-this-alias': 'error',
|
||||
'typescript/triple-slash-reference': 'error',
|
||||
'typescript/no-namespace': 'error',
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -1,35 +0,0 @@
|
||||
import type { OxlintConfig } from '../types';
|
||||
|
||||
/**
|
||||
* Vitest rules for test files.
|
||||
*
|
||||
* Applied via `overrides` for common test file patterns.
|
||||
*/
|
||||
export const vitest: OxlintConfig = {
|
||||
plugins: ['vitest'],
|
||||
|
||||
overrides: [
|
||||
{
|
||||
files: [
|
||||
'**/*.test.{ts,tsx,js,jsx}',
|
||||
'**/*.spec.{ts,tsx,js,jsx}',
|
||||
'**/test/**/*.{ts,tsx,js,jsx}',
|
||||
'**/__tests__/**/*.{ts,tsx,js,jsx}',
|
||||
],
|
||||
rules: {
|
||||
'vitest/no-conditional-tests': 'warn',
|
||||
'vitest/no-import-node-test': 'error',
|
||||
'vitest/prefer-to-be-truthy': 'warn',
|
||||
'vitest/prefer-to-be-falsy': 'warn',
|
||||
'vitest/prefer-to-be-object': 'warn',
|
||||
'vitest/prefer-to-have-length': 'warn',
|
||||
'vitest/consistent-test-filename': 'warn',
|
||||
'vitest/prefer-describe-function-title': 'warn',
|
||||
|
||||
/* relax strict rules in tests */
|
||||
'eslint/no-unused-vars': 'off',
|
||||
'typescript/no-explicit-any': 'off',
|
||||
},
|
||||
},
|
||||
],
|
||||
};
|
||||
@@ -1,26 +0,0 @@
|
||||
import type { OxlintConfig } from '../types';
|
||||
|
||||
/**
|
||||
* Vue.js-specific rules.
|
||||
*
|
||||
* Enforces Composition API with `<script setup>` and type-based declarations.
|
||||
*/
|
||||
export const vue: OxlintConfig = {
|
||||
plugins: ['vue'],
|
||||
|
||||
rules: {
|
||||
'vue/no-arrow-functions-in-watch': 'error',
|
||||
'vue/no-deprecated-destroyed-lifecycle': 'error',
|
||||
'vue/no-export-in-script-setup': 'error',
|
||||
'vue/no-lifecycle-after-await': 'error',
|
||||
'vue/no-multiple-slot-args': 'error',
|
||||
'vue/no-import-compiler-macros': 'error',
|
||||
'vue/define-emits-declaration': ['error', 'type-based'],
|
||||
'vue/define-props-declaration': ['error', 'type-based'],
|
||||
'vue/prefer-import-from-vue': 'error',
|
||||
'vue/no-required-prop-with-default': 'warn',
|
||||
'vue/valid-define-emits': 'error',
|
||||
'vue/valid-define-props': 'error',
|
||||
'vue/require-typed-ref': 'warn',
|
||||
},
|
||||
};
|
||||
@@ -1,18 +0,0 @@
|
||||
/**
|
||||
* Re-exported configuration types from `oxlint`.
|
||||
*
|
||||
* Keeps the preset API in sync with the oxlint CLI without
|
||||
* maintaining a separate copy of the types.
|
||||
*
|
||||
* @see https://oxc.rs/docs/guide/usage/linter/config-file-reference.html
|
||||
*/
|
||||
export type {
|
||||
OxlintConfig,
|
||||
OxlintOverride,
|
||||
OxlintEnv,
|
||||
OxlintGlobals,
|
||||
AllowWarnDeny,
|
||||
DummyRule,
|
||||
DummyRuleMap,
|
||||
RuleCategories,
|
||||
} from 'oxlint';
|
||||
@@ -1,146 +0,0 @@
|
||||
import { describe, expect, it } from 'vitest';
|
||||
import { compose } from '../src/compose';
|
||||
import type { OxlintConfig } from '../src/types';
|
||||
|
||||
describe('compose', () => {
|
||||
it('should return empty config when no configs provided', () => {
|
||||
expect(compose()).toEqual({});
|
||||
});
|
||||
|
||||
it('should return the same config when one config provided', () => {
|
||||
const config: OxlintConfig = {
|
||||
plugins: ['eslint'],
|
||||
rules: { 'eslint/no-console': 'warn' },
|
||||
};
|
||||
const result = compose(config);
|
||||
expect(result.plugins).toEqual(['eslint']);
|
||||
expect(result.rules).toEqual({ 'eslint/no-console': 'warn' });
|
||||
});
|
||||
|
||||
it('should merge plugins with dedup', () => {
|
||||
const a: OxlintConfig = { plugins: ['eslint', 'oxc'] };
|
||||
const b: OxlintConfig = { plugins: ['oxc', 'typescript'] };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.plugins).toEqual(['eslint', 'oxc', 'typescript']);
|
||||
});
|
||||
|
||||
it('should override rules from later configs', () => {
|
||||
const a: OxlintConfig = { rules: { 'eslint/no-console': 'error', 'eslint/eqeqeq': 'warn' } };
|
||||
const b: OxlintConfig = { rules: { 'eslint/no-console': 'off' } };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.rules).toEqual({
|
||||
'eslint/no-console': 'off',
|
||||
'eslint/eqeqeq': 'warn',
|
||||
});
|
||||
});
|
||||
|
||||
it('should override categories from later configs', () => {
|
||||
const a: OxlintConfig = { categories: { correctness: 'error', suspicious: 'warn' } };
|
||||
const b: OxlintConfig = { categories: { suspicious: 'off' } };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.categories).toEqual({
|
||||
correctness: 'error',
|
||||
suspicious: 'off',
|
||||
});
|
||||
});
|
||||
|
||||
it('should concatenate overrides', () => {
|
||||
const a: OxlintConfig = {
|
||||
overrides: [{ files: ['**/*.ts'], rules: { 'typescript/no-explicit-any': 'warn' } }],
|
||||
};
|
||||
const b: OxlintConfig = {
|
||||
overrides: [{ files: ['**/*.test.ts'], rules: { 'eslint/no-unused-vars': 'off' } }],
|
||||
};
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.overrides).toHaveLength(2);
|
||||
expect(result.overrides?.[0]?.files).toEqual(['**/*.ts']);
|
||||
expect(result.overrides?.[1]?.files).toEqual(['**/*.test.ts']);
|
||||
});
|
||||
|
||||
it('should merge env', () => {
|
||||
const a: OxlintConfig = { env: { browser: true } };
|
||||
const b: OxlintConfig = { env: { node: true } };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.env).toEqual({ browser: true, node: true });
|
||||
});
|
||||
|
||||
it('should merge globals', () => {
|
||||
const a: OxlintConfig = { globals: { MY_VAR: 'readonly' } };
|
||||
const b: OxlintConfig = { globals: { ANOTHER: 'writable' } };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.globals).toEqual({ MY_VAR: 'readonly', ANOTHER: 'writable' });
|
||||
});
|
||||
|
||||
it('should deep merge settings', () => {
|
||||
const a: OxlintConfig = {
|
||||
settings: {
|
||||
react: { version: '18.2.0' },
|
||||
next: { rootDir: 'apps/' },
|
||||
},
|
||||
};
|
||||
const b: OxlintConfig = {
|
||||
settings: {
|
||||
react: { linkComponents: [{ name: 'Link', linkAttribute: 'to', attributes: ['to'] }] },
|
||||
},
|
||||
};
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.settings).toEqual({
|
||||
react: {
|
||||
version: '18.2.0',
|
||||
linkComponents: [{ name: 'Link', linkAttribute: 'to', attributes: ['to'] }],
|
||||
},
|
||||
next: { rootDir: 'apps/' },
|
||||
});
|
||||
});
|
||||
|
||||
it('should concatenate ignorePatterns', () => {
|
||||
const a: OxlintConfig = { ignorePatterns: ['dist'] };
|
||||
const b: OxlintConfig = { ignorePatterns: ['node_modules', 'coverage'] };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.ignorePatterns).toEqual(['dist', 'node_modules', 'coverage']);
|
||||
});
|
||||
|
||||
it('should handle composing all presets together', () => {
|
||||
const base: OxlintConfig = {
|
||||
plugins: ['eslint', 'oxc'],
|
||||
categories: { correctness: 'error' },
|
||||
rules: { 'eslint/no-console': 'warn' },
|
||||
};
|
||||
const ts: OxlintConfig = {
|
||||
plugins: ['typescript'],
|
||||
overrides: [{ files: ['**/*.ts'], rules: { 'typescript/no-explicit-any': 'warn' } }],
|
||||
};
|
||||
const custom: OxlintConfig = {
|
||||
rules: { 'eslint/no-console': 'off' },
|
||||
ignorePatterns: ['dist'],
|
||||
};
|
||||
|
||||
const result = compose(base, ts, custom);
|
||||
|
||||
expect(result.plugins).toEqual(['eslint', 'oxc', 'typescript']);
|
||||
expect(result.categories).toEqual({ correctness: 'error' });
|
||||
expect(result.rules).toEqual({ 'eslint/no-console': 'off' });
|
||||
expect(result.overrides).toHaveLength(1);
|
||||
expect(result.ignorePatterns).toEqual(['dist']);
|
||||
});
|
||||
|
||||
it('should skip undefined/empty fields', () => {
|
||||
const a: OxlintConfig = { plugins: ['eslint'] };
|
||||
const b: OxlintConfig = { rules: { 'eslint/no-console': 'warn' } };
|
||||
|
||||
const result = compose(a, b);
|
||||
expect(result.plugins).toEqual(['eslint']);
|
||||
expect(result.rules).toEqual({ 'eslint/no-console': 'warn' });
|
||||
expect(result.overrides).toBeUndefined();
|
||||
expect(result.env).toBeUndefined();
|
||||
expect(result.settings).toBeUndefined();
|
||||
});
|
||||
});
|
||||
@@ -1,6 +0,0 @@
|
||||
{
|
||||
"extends": "@robonen/tsconfig/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"rootDir": "."
|
||||
}
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
import { defineConfig } from 'tsdown';
|
||||
|
||||
export default defineConfig({
|
||||
entry: ['src/index.ts'],
|
||||
format: ['esm', 'cjs'],
|
||||
dts: true,
|
||||
clean: true,
|
||||
hash: false,
|
||||
});
|
||||
@@ -1,7 +0,0 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
environment: 'node',
|
||||
},
|
||||
});
|
||||
@@ -1,27 +1,45 @@
|
||||
# @robonen/tsconfig
|
||||
|
||||
Shared base TypeScript configuration.
|
||||
Базовый конфигурационный файл для TypeScript
|
||||
|
||||
## Install
|
||||
## Установка
|
||||
|
||||
```bash
|
||||
pnpm install -D @robonen/tsconfig
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Extend from it in your `tsconfig.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": "@robonen/tsconfig/tsconfig.json"
|
||||
}
|
||||
```
|
||||
|
||||
## What's Included
|
||||
## Описание основных параметров
|
||||
|
||||
- **Target / Module**: ESNext with Bundler resolution
|
||||
- **Strict mode**: `strict`, `noUncheckedIndexedAccess`
|
||||
- **Module safety**: `verbatimModuleSyntax`, `isolatedModules`
|
||||
- **Declarations**: `declaration` enabled
|
||||
- **Interop**: `esModuleInterop`, `allowJs`, `resolveJsonModule`
|
||||
```json
|
||||
{
|
||||
"module": "Preserve", // использовать ту же версию модуля, что и сборщик
|
||||
"noEmit": true, // не генерировать файлы
|
||||
"moduleResolution": "Bundler", // разрешение модулей на основе сборщика
|
||||
"target": "ESNext", // целевая версия JavaScript
|
||||
|
||||
|
||||
"skipLibCheck": true, // не проверять типы, заданные во всех файлах описания типов (*.d.ts)
|
||||
"esModuleInterop": true, // создать хелперы __importStar и __importDefault для обеспечения совместимости с экосистемой Babel и включить allowSyntheticDefaultImports для совместимости с системой типов
|
||||
"allowSyntheticDefaultImports": true, // разрешить импортировать модули не имеющие внутри себя "import default"
|
||||
"allowJs": true, // разрешить импортировать файлы JavaScript
|
||||
"resolveJsonModule": true, // разрешить импортировать файлы JSON
|
||||
"moduleDetection": "force", // заставляет TypeScript рассматривать все файлы как модули. Это помогает избежать ошибок cannot redeclare block-scoped variable»
|
||||
"isolatedModules": true, // орабатывать каждый файл, как отдельный изолированный модуль
|
||||
"removeComments": false, // удалять комментарии из исходного кода
|
||||
"verbatimModuleSyntax": true, // сохранять синтаксис модулей в исходном коде (важно при импорте типов)
|
||||
"useDefineForClassFields": true, // использование классов стандарта TC39, а не TypeScript
|
||||
"strict": true, // включить все строгие проверки (noImplicitAny, noImplicitThis, alwaysStrict, strictNullChecks, strictFunctionTypes, strictPropertyInitialization)
|
||||
"noUncheckedIndexedAccess": true, // запрещает доступ к массиву или объекту без предварительной проверки того, определен ли он
|
||||
"declaration": true, // генерировать файлы описания типов (*.d.ts)
|
||||
|
||||
"composite": true, // указывает TypeScript создавать файлы .tsbuildinfo. Это сообщает TypeScript, что ваш проект является частью монорепозитория, а также помогает кэшировать сборки для более быстрой работы
|
||||
"sourceMap": true, // генерировать карту исходного кода
|
||||
"declarationMap": true // генерировать карту исходного кода для файлов описания типов (*.d.ts)
|
||||
}
|
||||
```
|
||||
|
||||
@@ -1,23 +1 @@
|
||||
# @robonen/platform
|
||||
|
||||
Platform-dependent utilities for browser & multi-runtime environments.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm install @robonen/platform
|
||||
```
|
||||
|
||||
## Modules
|
||||
|
||||
| Entry | Utilities | Description |
|
||||
| ------------------ | ------------- | -------------------------------- |
|
||||
| `@robonen/platform/browsers` | `focusGuard` | Browser-specific helpers |
|
||||
| `@robonen/platform/multi` | `global` | Cross-runtime (Node/Bun/Deno) utilities |
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { focusGuard } from '@robonen/platform/browsers';
|
||||
import { global } from '@robonen/platform/multi';
|
||||
```
|
||||
# @robonen/platform
|
||||
@@ -1,15 +0,0 @@
|
||||
import { defineConfig } from 'oxlint';
|
||||
import { compose, base, typescript, imports } from '@robonen/oxlint';
|
||||
|
||||
export default defineConfig(
|
||||
compose(base, typescript, imports, {
|
||||
overrides: [
|
||||
{
|
||||
files: ['src/multi/global/index.ts'],
|
||||
rules: {
|
||||
'unicorn/prefer-global-this': 'off',
|
||||
},
|
||||
},
|
||||
],
|
||||
}),
|
||||
);
|
||||
@@ -39,15 +39,12 @@
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "oxlint -c oxlint.config.ts",
|
||||
"test": "vitest run",
|
||||
"dev": "vitest dev",
|
||||
"build": "tsdown"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@robonen/oxlint": "workspace:*",
|
||||
"@robonen/tsconfig": "workspace:*",
|
||||
"oxlint": "catalog:",
|
||||
"tsdown": "catalog:"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -18,7 +18,7 @@
|
||||
*
|
||||
* @since 0.0.3
|
||||
*/
|
||||
export function focusGuard(namespace = 'focus-guard') {
|
||||
export function focusGuard(namespace: string = 'focus-guard') {
|
||||
const guardAttr = `data-${namespace}`;
|
||||
|
||||
const createGuard = () => {
|
||||
@@ -39,7 +39,7 @@ export function focusGuard(namespace = 'focus-guard') {
|
||||
};
|
||||
}
|
||||
|
||||
export function createGuardAttrs(namespace = 'focus-guard') {
|
||||
export function createGuardAttrs(namespace: string) {
|
||||
const element = document.createElement('span');
|
||||
|
||||
element.setAttribute(namespace, '');
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
// eslint-disable
|
||||
|
||||
export interface DebounceOptions {
|
||||
/**
|
||||
* Call the function on the leading edge of the timeout, instead of waiting for the trailing edge
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
environment: 'jsdom',
|
||||
},
|
||||
});
|
||||
|
||||
@@ -1,32 +1 @@
|
||||
# @robonen/stdlib
|
||||
|
||||
Standard library of platform-independent utilities for TypeScript.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm install @robonen/stdlib
|
||||
```
|
||||
|
||||
## Modules
|
||||
|
||||
| Module | Utilities |
|
||||
| --------------- | --------------------------------------------------------------- |
|
||||
| **arrays** | `cluster`, `first`, `last`, `sum`, `unique` |
|
||||
| **async** | `sleep`, `tryIt` |
|
||||
| **bits** | `flags` |
|
||||
| **collections** | `get` |
|
||||
| **math** | `clamp`, `lerp`, `remap` + BigInt variants |
|
||||
| **objects** | `omit`, `pick` |
|
||||
| **patterns** | `pubsub` |
|
||||
| **structs** | `stack` |
|
||||
| **sync** | `mutex` |
|
||||
| **text** | `levenshteinDistance`, `trigramDistance` |
|
||||
| **types** | JS & TS type utilities |
|
||||
| **utils** | `timestamp`, `noop` |
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { first, sleep, clamp } from '@robonen/stdlib';
|
||||
```
|
||||
# @robonen/stdlib
|
||||
@@ -1,4 +0,0 @@
|
||||
import { defineConfig } from 'oxlint';
|
||||
import { compose, base, typescript, imports } from '@robonen/oxlint';
|
||||
|
||||
export default defineConfig(compose(base, typescript, imports));
|
||||
@@ -34,15 +34,12 @@
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "oxlint -c oxlint.config.ts",
|
||||
"test": "vitest run",
|
||||
"dev": "vitest dev",
|
||||
"build": "tsdown"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@robonen/oxlint": "workspace:*",
|
||||
"@robonen/tsconfig": "workspace:*",
|
||||
"oxlint": "catalog:",
|
||||
"tsdown": "catalog:"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
export interface AsyncPoolOptions {
|
||||
export type AsyncPoolOptions = {
|
||||
concurrency?: number;
|
||||
}
|
||||
@@ -1,4 +1,3 @@
|
||||
// eslint-disable
|
||||
export interface RetryOptions {
|
||||
times?: number;
|
||||
delay?: number;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
export interface BitVectorLike {
|
||||
export interface BitVector {
|
||||
getBit(index: number): boolean;
|
||||
setBit(index: number): void;
|
||||
clearBit(index: number): void;
|
||||
@@ -12,7 +12,7 @@ export interface BitVectorLike {
|
||||
*
|
||||
* @since 0.0.3
|
||||
*/
|
||||
export class BitVector extends Uint8Array implements BitVectorLike {
|
||||
export class BitVector extends Uint8Array implements BitVector {
|
||||
constructor(size: number) {
|
||||
super(Math.ceil(size / 8));
|
||||
}
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import type { Collection, Path } from '../../types';
|
||||
import { type Collection, type Path } from '../../types';
|
||||
|
||||
export type ExtractFromObject<O extends Record<PropertyKey, unknown>, K> =
|
||||
K extends keyof O
|
||||
@@ -9,7 +9,7 @@ export type ExtractFromObject<O extends Record<PropertyKey, unknown>, K> =
|
||||
|
||||
export type ExtractFromArray<A extends readonly any[], K> =
|
||||
any[] extends A
|
||||
? A extends ReadonlyArray<infer T>
|
||||
? A extends readonly (infer T)[]
|
||||
? T | undefined
|
||||
: undefined
|
||||
: K extends keyof A
|
||||
|
||||
@@ -46,13 +46,13 @@ describe('clamp', () => {
|
||||
|
||||
it('handle NaN and Infinity', () => {
|
||||
// value is NaN
|
||||
expect(clamp(Number.NaN, 0, 100)).toBe(Number.NaN);
|
||||
expect(clamp(NaN, 0, 100)).toBe(NaN);
|
||||
|
||||
// min is NaN
|
||||
expect(clamp(50, Number.NaN, 100)).toBe(Number.NaN);
|
||||
expect(clamp(50, NaN, 100)).toBe(NaN);
|
||||
|
||||
// max is NaN
|
||||
expect(clamp(50, 0, Number.NaN)).toBe(Number.NaN);
|
||||
expect(clamp(50, 0, NaN)).toBe(NaN);
|
||||
|
||||
// value is Infinity
|
||||
expect(clamp(Infinity, 0, 100)).toBe(100);
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { isArray } from '../../types';
|
||||
import type { Arrayable } from '../../types';
|
||||
import { isArray, type Arrayable } from '../../types';
|
||||
|
||||
/**
|
||||
* @name omit
|
||||
|
||||
@@ -1,5 +1,4 @@
|
||||
import { isArray } from '../../types';
|
||||
import type { Arrayable } from '../../types';
|
||||
import { isArray, type Arrayable } from '../../types';
|
||||
|
||||
/**
|
||||
* @name pick
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
import { last } from '../../arrays';
|
||||
import { isArray } from '../../types';
|
||||
|
||||
export interface StackOptions {
|
||||
export type StackOptions = {
|
||||
maxSize?: number;
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* @name Stack
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
import type { MaybePromise } from "../../types";
|
||||
|
||||
/**
|
||||
* @name SyncMutex
|
||||
* @category Utils
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { get } from '../../collections';
|
||||
import { isFunction } from '../../types';
|
||||
import type { Collection, Path, PathToType, Stringable, Trim, UnionToIntersection } from '../../types';
|
||||
import { isFunction, type Path, type PathToType, type Stringable, type Trim, type UnionToIntersection } from '../../types';
|
||||
|
||||
/**
|
||||
* Type of a value that will be used to replace a placeholder in a template.
|
||||
@@ -56,7 +55,7 @@ export type GenerateTypes<T extends string, Target = string> = UnionToIntersecti
|
||||
|
||||
export function templateObject<
|
||||
T extends string,
|
||||
A extends GenerateTypes<ExtractPlaceholders<T>, TemplateValue> & Collection
|
||||
A extends GenerateTypes<ExtractPlaceholders<T>, TemplateValue>
|
||||
>(template: T, args: A, fallback?: TemplateFallback) {
|
||||
return template.replace(TEMPLATE_PLACEHOLDER, (_, key) => {
|
||||
const value = get(args, key)?.toString();
|
||||
|
||||
@@ -11,7 +11,7 @@ export type Trigrams = Map<string, number>;
|
||||
* @since 0.0.1
|
||||
*/
|
||||
export function trigramProfile(text: string): Trigrams {
|
||||
text = `\n\n${text}\n\n`;
|
||||
text = '\n\n' + text + '\n\n';
|
||||
|
||||
const trigrams = new Map<string, number>();
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ describe('casts', () => {
|
||||
expect(toString(null)).toBe('[object Null]');
|
||||
expect(toString(/abc/)).toBe('[object RegExp]');
|
||||
expect(toString(new Date())).toBe('[object Date]');
|
||||
expect(toString(new Error('test'))).toBe('[object Error]');
|
||||
expect(toString(new Error())).toBe('[object Error]');
|
||||
expect(toString(new Promise(() => {}))).toBe('[object Promise]');
|
||||
expect(toString(new Map())).toBe('[object Map]');
|
||||
expect(toString(new Set())).toBe('[object Set]');
|
||||
|
||||
@@ -77,7 +77,7 @@ describe('complex', () => {
|
||||
|
||||
describe('isError', () => {
|
||||
it('true if the value is an error', () => {
|
||||
expect(isError(new Error('test'))).toBe(true);
|
||||
expect(isError(new Error())).toBe(true);
|
||||
});
|
||||
|
||||
it('false if the value is not an error', () => {
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { toString } from './casts';
|
||||
import { toString } from '.';
|
||||
|
||||
/**
|
||||
* @name isFunction
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import { toString } from './casts';
|
||||
import { toString } from '.';
|
||||
|
||||
/**
|
||||
* @name isObject
|
||||
|
||||
@@ -35,35 +35,35 @@ describe('collections', () => {
|
||||
describe('PathToType', () => {
|
||||
it('convert simple object path', () => {
|
||||
type actual = PathToType<['user', 'name']>;
|
||||
interface expected { user: { name: unknown } }
|
||||
type expected = { user: { name: unknown } };
|
||||
|
||||
expectTypeOf<actual>().toEqualTypeOf<expected>();
|
||||
});
|
||||
|
||||
it('convert simple array path', () => {
|
||||
type actual = PathToType<['user', '0']>;
|
||||
interface expected { user: unknown[] }
|
||||
type expected = { user: unknown[] };
|
||||
|
||||
expectTypeOf<actual>().toEqualTypeOf<expected>();
|
||||
});
|
||||
|
||||
it('convert complex object path', () => {
|
||||
type actual = PathToType<['user', 'addresses', '0', 'street']>;
|
||||
interface expected { user: { addresses: Array<{ street: unknown }> } }
|
||||
type expected = { user: { addresses: { street: unknown }[] } };
|
||||
|
||||
expectTypeOf<actual>().toEqualTypeOf<expected>();
|
||||
});
|
||||
|
||||
it('convert double dot path', () => {
|
||||
type actual = PathToType<['user', '', 'name']>;
|
||||
interface expected { user: { '': { name: unknown } } }
|
||||
type expected = { user: { '': { name: unknown } } };
|
||||
|
||||
expectTypeOf<actual>().toEqualTypeOf<expected>();
|
||||
});
|
||||
|
||||
it('convert to custom target', () => {
|
||||
type actual = PathToType<['user', 'name'], string>;
|
||||
interface expected { user: { name: string } }
|
||||
type expected = { user: { name: string } };
|
||||
|
||||
expectTypeOf<actual>().toEqualTypeOf<expected>();
|
||||
});
|
||||
|
||||
@@ -20,7 +20,7 @@ export type PathToType<T extends string[], Target = unknown> =
|
||||
T extends [infer Head, ...infer Rest]
|
||||
? Head extends `${number}`
|
||||
? Rest extends string[]
|
||||
? Array<PathToType<Rest, Target>>
|
||||
? PathToType<Rest, Target>[]
|
||||
: never
|
||||
: Rest extends string[]
|
||||
? { [K in Head & string]: PathToType<Rest, Target> }
|
||||
|
||||
@@ -7,7 +7,7 @@ describe('string', () => {
|
||||
expectTypeOf(Number(1)).toExtend<Stringable>();
|
||||
expectTypeOf(String(1)).toExtend<Stringable>();
|
||||
expectTypeOf(Symbol()).toExtend<Stringable>();
|
||||
expectTypeOf([1]).toExtend<Stringable>();
|
||||
expectTypeOf(new Array(1)).toExtend<Stringable>();
|
||||
expectTypeOf(new Object()).toExtend<Stringable>();
|
||||
expectTypeOf(new Date()).toExtend<Stringable>();
|
||||
});
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
import { defineConfig } from 'vitest/config';
|
||||
|
||||
export default defineConfig({
|
||||
test: {
|
||||
environment: 'node',
|
||||
},
|
||||
});
|
||||
@@ -1,21 +1 @@
|
||||
# @robonen/renovate
|
||||
|
||||
Shared [Renovate](https://docs.renovatebot.com/) configuration preset.
|
||||
|
||||
## Usage
|
||||
|
||||
Reference it in your `renovate.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": ["github>robonen/tools//infra/renovate/default.json"]
|
||||
}
|
||||
```
|
||||
|
||||
## What's Included
|
||||
|
||||
- Extends `config:base` and `group:allNonMajor`
|
||||
- Semantic commit type: `chore`
|
||||
- Range strategy: `bump`
|
||||
- Auto-approves & auto-merges minor, patch, pin, and digest updates (scheduled 1–3 AM)
|
||||
# @robonen/renovate
|
||||
@@ -32,7 +32,6 @@
|
||||
},
|
||||
"scripts": {
|
||||
"build": "pnpm -r build",
|
||||
"lint": "pnpm -r lint",
|
||||
"test": "vitest run",
|
||||
"test:ui": "vitest --ui",
|
||||
"create": "jiti ./bin/cli.ts"
|
||||
|
||||
247
pnpm-lock.yaml
generated
247
pnpm-lock.yaml
generated
@@ -18,9 +18,6 @@ catalogs:
|
||||
jsdom:
|
||||
specifier: ^28.0.0
|
||||
version: 28.0.0
|
||||
oxlint:
|
||||
specifier: ^1.2.0
|
||||
version: 1.47.0
|
||||
tsdown:
|
||||
specifier: ^0.12.5
|
||||
version: 0.12.9
|
||||
@@ -60,49 +57,22 @@ importers:
|
||||
specifier: 'catalog:'
|
||||
version: 4.0.18(@opentelemetry/api@1.9.0)(@types/node@24.10.13)(@vitest/ui@4.0.18)(jiti@2.6.1)(jsdom@28.0.0)(terser@5.44.0)(yaml@2.8.2)
|
||||
|
||||
configs/oxlint:
|
||||
devDependencies:
|
||||
'@robonen/oxlint':
|
||||
specifier: workspace:*
|
||||
version: 'link:'
|
||||
'@robonen/tsconfig':
|
||||
specifier: workspace:*
|
||||
version: link:../tsconfig
|
||||
oxlint:
|
||||
specifier: 'catalog:'
|
||||
version: 1.47.0
|
||||
tsdown:
|
||||
specifier: 'catalog:'
|
||||
version: 0.12.9(typescript@5.8.3)
|
||||
|
||||
configs/tsconfig: {}
|
||||
|
||||
core/platform:
|
||||
devDependencies:
|
||||
'@robonen/oxlint':
|
||||
specifier: workspace:*
|
||||
version: link:../../configs/oxlint
|
||||
'@robonen/tsconfig':
|
||||
specifier: workspace:*
|
||||
version: link:../../configs/tsconfig
|
||||
oxlint:
|
||||
specifier: 'catalog:'
|
||||
version: 1.47.0
|
||||
tsdown:
|
||||
specifier: 'catalog:'
|
||||
version: 0.12.9(typescript@5.8.3)
|
||||
|
||||
core/stdlib:
|
||||
devDependencies:
|
||||
'@robonen/oxlint':
|
||||
specifier: workspace:*
|
||||
version: link:../../configs/oxlint
|
||||
'@robonen/tsconfig':
|
||||
specifier: workspace:*
|
||||
version: link:../../configs/tsconfig
|
||||
oxlint:
|
||||
specifier: 'catalog:'
|
||||
version: 1.47.0
|
||||
tsdown:
|
||||
specifier: 'catalog:'
|
||||
version: 0.12.9(typescript@5.8.3)
|
||||
@@ -125,18 +95,12 @@ importers:
|
||||
specifier: 'catalog:'
|
||||
version: 3.5.28(typescript@5.8.3)
|
||||
devDependencies:
|
||||
'@robonen/oxlint':
|
||||
specifier: workspace:*
|
||||
version: link:../../configs/oxlint
|
||||
'@robonen/tsconfig':
|
||||
specifier: workspace:*
|
||||
version: link:../../configs/tsconfig
|
||||
'@vue/test-utils':
|
||||
specifier: 'catalog:'
|
||||
version: 2.4.6
|
||||
oxlint:
|
||||
specifier: 'catalog:'
|
||||
version: 1.47.0
|
||||
tsdown:
|
||||
specifier: 'catalog:'
|
||||
version: 0.12.9(typescript@5.8.3)
|
||||
@@ -829,128 +793,6 @@ packages:
|
||||
'@oxc-project/types@0.113.0':
|
||||
resolution: {integrity: sha512-Tp3XmgxwNQ9pEN9vxgJBAqdRamHibi76iowQ38O2I4PMpcvNRQNVsU2n1x1nv9yh0XoTrGFzf7cZSGxmixxrhA==}
|
||||
|
||||
'@oxlint/binding-android-arm-eabi@1.47.0':
|
||||
resolution: {integrity: sha512-UHqo3te9K/fh29brCuQdHjN+kfpIi9cnTPABuD5S9wb9ykXYRGTOOMVuSV/CK43sOhU4wwb2nT1RVjcbrrQjFw==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm]
|
||||
os: [android]
|
||||
|
||||
'@oxlint/binding-android-arm64@1.47.0':
|
||||
resolution: {integrity: sha512-xh02lsTF1TAkR+SZrRMYHR/xCx8Wg2MAHxJNdHVpAKELh9/yE9h4LJeqAOBbIb3YYn8o/D97U9VmkvkfJfrHfw==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm64]
|
||||
os: [android]
|
||||
|
||||
'@oxlint/binding-darwin-arm64@1.47.0':
|
||||
resolution: {integrity: sha512-OSOfNJqabOYbkyQDGT5pdoL+05qgyrmlQrvtCO58M4iKGEQ/xf3XkkKj7ws+hO+k8Y4VF4zGlBsJlwqy7qBcHA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm64]
|
||||
os: [darwin]
|
||||
|
||||
'@oxlint/binding-darwin-x64@1.47.0':
|
||||
resolution: {integrity: sha512-hP2bOI4IWNS+F6pVXWtRshSTuJ1qCRZgDgVUg6EBUqsRy+ExkEPJkx+YmIuxgdCduYK1LKptLNFuQLJP8voPbQ==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [x64]
|
||||
os: [darwin]
|
||||
|
||||
'@oxlint/binding-freebsd-x64@1.47.0':
|
||||
resolution: {integrity: sha512-F55jIEH5xmGu7S661Uho8vGiLFk0bY3A/g4J8CTKiLJnYu/PSMZ2WxFoy5Hji6qvFuujrrM9Q8XXbMO0fKOYPg==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [x64]
|
||||
os: [freebsd]
|
||||
|
||||
'@oxlint/binding-linux-arm-gnueabihf@1.47.0':
|
||||
resolution: {integrity: sha512-wxmOn/wns/WKPXUC1fo5mu9pMZPVOu8hsynaVDrgmmXMdHKS7on6bA5cPauFFN9tJXNdsjW26AK9lpfu3IfHBQ==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm]
|
||||
os: [linux]
|
||||
|
||||
'@oxlint/binding-linux-arm-musleabihf@1.47.0':
|
||||
resolution: {integrity: sha512-KJTmVIA/GqRlM2K+ZROH30VMdydEU7bDTY35fNg3tOPzQRIs2deLZlY/9JWwdWo1F/9mIYmpbdCmPqtKhWNOPg==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm]
|
||||
os: [linux]
|
||||
|
||||
'@oxlint/binding-linux-arm64-gnu@1.47.0':
|
||||
resolution: {integrity: sha512-PF7ELcFg1GVlS0X0ZB6aWiXobjLrAKer3T8YEkwIoO8RwWiAMkL3n3gbleg895BuZkHVlJ2kPRUwfrhHrVkD1A==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm64]
|
||||
os: [linux]
|
||||
libc: [glibc]
|
||||
|
||||
'@oxlint/binding-linux-arm64-musl@1.47.0':
|
||||
resolution: {integrity: sha512-4BezLRO5cu0asf0Jp1gkrnn2OHiXrPPPEfBTxq1k5/yJ2zdGGTmZxHD2KF2voR23wb8Elyu3iQawXo7wvIZq0Q==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm64]
|
||||
os: [linux]
|
||||
libc: [musl]
|
||||
|
||||
'@oxlint/binding-linux-ppc64-gnu@1.47.0':
|
||||
resolution: {integrity: sha512-aI5ds9jq2CPDOvjeapiIj48T/vlWp+f4prkxs+FVzrmVN9BWIj0eqeJ/hV8WgXg79HVMIz9PU6deI2ki09bR1w==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [ppc64]
|
||||
os: [linux]
|
||||
libc: [glibc]
|
||||
|
||||
'@oxlint/binding-linux-riscv64-gnu@1.47.0':
|
||||
resolution: {integrity: sha512-mO7ycp9Elvgt5EdGkQHCwJA6878xvo9tk+vlMfT1qg++UjvOMB8INsOCQIOH2IKErF/8/P21LULkdIrocMw9xA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [riscv64]
|
||||
os: [linux]
|
||||
libc: [glibc]
|
||||
|
||||
'@oxlint/binding-linux-riscv64-musl@1.47.0':
|
||||
resolution: {integrity: sha512-24D0wsYT/7hDFn3Ow32m3/+QT/1ZwrUhShx4/wRDAmz11GQHOZ1k+/HBuK/MflebdnalmXWITcPEy4BWTi7TCA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [riscv64]
|
||||
os: [linux]
|
||||
libc: [musl]
|
||||
|
||||
'@oxlint/binding-linux-s390x-gnu@1.47.0':
|
||||
resolution: {integrity: sha512-8tPzPne882mtML/uy3mApvdCyuVOpthJ7xUv3b67gVfz63hOOM/bwO0cysSkPyYYFDFRn6/FnUb7Jhmsesntvg==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [s390x]
|
||||
os: [linux]
|
||||
libc: [glibc]
|
||||
|
||||
'@oxlint/binding-linux-x64-gnu@1.47.0':
|
||||
resolution: {integrity: sha512-q58pIyGIzeffEBhEgbRxLFHmHfV9m7g1RnkLiahQuEvyjKNiJcvdHOwKH2BdgZxdzc99Cs6hF5xTa86X40WzPw==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [x64]
|
||||
os: [linux]
|
||||
libc: [glibc]
|
||||
|
||||
'@oxlint/binding-linux-x64-musl@1.47.0':
|
||||
resolution: {integrity: sha512-e7DiLZtETZUCwTa4EEHg9G+7g3pY+afCWXvSeMG7m0TQ29UHHxMARPaEQUE4mfKgSqIWnJaUk2iZzRPMRdga5g==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [x64]
|
||||
os: [linux]
|
||||
libc: [musl]
|
||||
|
||||
'@oxlint/binding-openharmony-arm64@1.47.0':
|
||||
resolution: {integrity: sha512-3AFPfQ0WKMleT/bKd7zsks3xoawtZA6E/wKf0DjwysH7wUiMMJkNKXOzYq1R/00G98JFgSU1AkrlOQrSdNNhlg==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm64]
|
||||
os: [openharmony]
|
||||
|
||||
'@oxlint/binding-win32-arm64-msvc@1.47.0':
|
||||
resolution: {integrity: sha512-cLMVVM6TBxp+N7FldQJ2GQnkcLYEPGgiuEaXdvhgvSgODBk9ov3jed+khIXSAWtnFOW0wOnG3RjwqPh0rCuheA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [arm64]
|
||||
os: [win32]
|
||||
|
||||
'@oxlint/binding-win32-ia32-msvc@1.47.0':
|
||||
resolution: {integrity: sha512-VpFOSzvTnld77/Edje3ZdHgZWnlTb5nVWXyTgjD3/DKF/6t5bRRbwn3z77zOdnGy44xAMvbyAwDNOSeOdVUmRA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [ia32]
|
||||
os: [win32]
|
||||
|
||||
'@oxlint/binding-win32-x64-msvc@1.47.0':
|
||||
resolution: {integrity: sha512-+q8IWptxXx2HMTM6JluR67284t0h8X/oHJgqpxH1siowxPMqZeIpAcWCUq+tY+Rv2iQK8TUugjZnSBQAVV5CmA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
cpu: [x64]
|
||||
os: [win32]
|
||||
|
||||
'@pkgjs/parseargs@0.11.0':
|
||||
resolution: {integrity: sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==}
|
||||
engines: {node: '>=14'}
|
||||
@@ -3289,16 +3131,6 @@ packages:
|
||||
resolution: {integrity: sha512-pLzCU8IgyKXPSO11eeharQkQ4GzOKNWhXq79pQarIRZEMt1/ssyr+MIuWBv1mNoenJLg04gvPx+fi4gcKZ4bag==}
|
||||
engines: {node: '>= 18.0.0'}
|
||||
|
||||
oxlint@1.47.0:
|
||||
resolution: {integrity: sha512-v7xkK1iv1qdvTxJGclM97QzN8hHs5816AneFAQ0NGji1BMUquhiDAhXpMwp8+ls16uRVJtzVHxP9pAAXblDeGA==}
|
||||
engines: {node: ^20.19.0 || >=22.12.0}
|
||||
hasBin: true
|
||||
peerDependencies:
|
||||
oxlint-tsgolint: '>=0.11.2'
|
||||
peerDependenciesMeta:
|
||||
oxlint-tsgolint:
|
||||
optional: true
|
||||
|
||||
p-all@5.0.1:
|
||||
resolution: {integrity: sha512-LMT7WX9ZSaq3J1zjloApkIVmtz0ZdMFSIqbuiEa3txGYPLjUPOvgOPOx3nFjo+f37ZYL+1aY666I2SG7GVwLOA==}
|
||||
engines: {node: '>=16'}
|
||||
@@ -5589,63 +5421,6 @@ snapshots:
|
||||
|
||||
'@oxc-project/types@0.113.0': {}
|
||||
|
||||
'@oxlint/binding-android-arm-eabi@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-android-arm64@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-darwin-arm64@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-darwin-x64@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-freebsd-x64@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-arm-gnueabihf@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-arm-musleabihf@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-arm64-gnu@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-arm64-musl@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-ppc64-gnu@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-riscv64-gnu@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-riscv64-musl@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-s390x-gnu@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-x64-gnu@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-linux-x64-musl@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-openharmony-arm64@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-win32-arm64-msvc@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-win32-ia32-msvc@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@oxlint/binding-win32-x64-msvc@1.47.0':
|
||||
optional: true
|
||||
|
||||
'@pkgjs/parseargs@0.11.0':
|
||||
optional: true
|
||||
|
||||
@@ -8330,28 +8105,6 @@ snapshots:
|
||||
openpgp@6.3.0:
|
||||
optional: true
|
||||
|
||||
oxlint@1.47.0:
|
||||
optionalDependencies:
|
||||
'@oxlint/binding-android-arm-eabi': 1.47.0
|
||||
'@oxlint/binding-android-arm64': 1.47.0
|
||||
'@oxlint/binding-darwin-arm64': 1.47.0
|
||||
'@oxlint/binding-darwin-x64': 1.47.0
|
||||
'@oxlint/binding-freebsd-x64': 1.47.0
|
||||
'@oxlint/binding-linux-arm-gnueabihf': 1.47.0
|
||||
'@oxlint/binding-linux-arm-musleabihf': 1.47.0
|
||||
'@oxlint/binding-linux-arm64-gnu': 1.47.0
|
||||
'@oxlint/binding-linux-arm64-musl': 1.47.0
|
||||
'@oxlint/binding-linux-ppc64-gnu': 1.47.0
|
||||
'@oxlint/binding-linux-riscv64-gnu': 1.47.0
|
||||
'@oxlint/binding-linux-riscv64-musl': 1.47.0
|
||||
'@oxlint/binding-linux-s390x-gnu': 1.47.0
|
||||
'@oxlint/binding-linux-x64-gnu': 1.47.0
|
||||
'@oxlint/binding-linux-x64-musl': 1.47.0
|
||||
'@oxlint/binding-openharmony-arm64': 1.47.0
|
||||
'@oxlint/binding-win32-arm64-msvc': 1.47.0
|
||||
'@oxlint/binding-win32-ia32-msvc': 1.47.0
|
||||
'@oxlint/binding-win32-x64-msvc': 1.47.0
|
||||
|
||||
p-all@5.0.1:
|
||||
dependencies:
|
||||
p-map: 6.0.0
|
||||
|
||||
@@ -9,7 +9,6 @@ catalog:
|
||||
'@vitest/coverage-v8': ^4.0.18
|
||||
'@vue/test-utils': ^2.4.6
|
||||
jsdom: ^28.0.0
|
||||
oxlint: ^1.2.0
|
||||
tsdown: ^0.12.5
|
||||
vitest: ^4.0.18
|
||||
'@vitest/ui': ^4.0.18
|
||||
|
||||
@@ -3,11 +3,16 @@ import { defineConfig } from 'vitest/config';
|
||||
export default defineConfig({
|
||||
test: {
|
||||
projects: [
|
||||
'configs/oxlint/vitest.config.ts',
|
||||
'core/stdlib/vitest.config.ts',
|
||||
'core/platform/vitest.config.ts',
|
||||
'web/vue/vitest.config.ts',
|
||||
{
|
||||
extends: true,
|
||||
test: {
|
||||
typecheck: {
|
||||
enabled: false,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
environment: 'jsdom',
|
||||
coverage: {
|
||||
provider: 'v8',
|
||||
include: ['core/*', 'web/*'],
|
||||
|
||||
@@ -1,28 +1 @@
|
||||
# @robonen/vue
|
||||
|
||||
Collection of composables and utilities for Vue 3.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
pnpm install @robonen/vue
|
||||
```
|
||||
|
||||
## Composables
|
||||
|
||||
| Category | Composables |
|
||||
| -------------- | ------------------------------------------------------------------ |
|
||||
| **browser** | `useEventListener`, `useFocusGuard`, `useSupported` |
|
||||
| **component** | `unrefElement`, `useRenderCount`, `useRenderInfo` |
|
||||
| **lifecycle** | `tryOnBeforeMount`, `tryOnMounted`, `tryOnScopeDispose`, `useMounted` |
|
||||
| **math** | `useClamp` |
|
||||
| **reactivity** | `broadcastedRef`, `useCached`, `useLastChanged`, `useSyncRefs` |
|
||||
| **state** | `useAppSharedState`, `useAsyncState`, `useContextFactory`, `useCounter`, `useInjectionStore`, `useToggle` |
|
||||
| **storage** | `useLocalStorage`, `useSessionStorage`, `useStorage`, `useStorageAsync` |
|
||||
| **utilities** | `useOffsetPagination` |
|
||||
|
||||
## Usage
|
||||
|
||||
```ts
|
||||
import { useToggle, useEventListener } from '@robonen/vue';
|
||||
```
|
||||
# @robonen/vue
|
||||
@@ -1,4 +0,0 @@
|
||||
import { defineConfig } from 'oxlint';
|
||||
import { compose, base, typescript, vue, vitest, imports } from '@robonen/oxlint';
|
||||
|
||||
export default defineConfig(compose(base, typescript, vue, vitest, imports));
|
||||
@@ -32,16 +32,13 @@
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"lint": "oxlint -c oxlint.config.ts",
|
||||
"test": "vitest run",
|
||||
"dev": "vitest dev",
|
||||
"build": "tsdown"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@robonen/oxlint": "workspace:*",
|
||||
"@robonen/tsconfig": "workspace:*",
|
||||
"@vue/test-utils": "catalog:",
|
||||
"oxlint": "catalog:",
|
||||
"tsdown": "catalog:"
|
||||
},
|
||||
"dependencies": {
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
export * from './useEventListener';
|
||||
export * from './useFocusGuard';
|
||||
export * from './useSupported';
|
||||
@@ -1,3 +0,0 @@
|
||||
export * from './unrefElement';
|
||||
export * from './useRenderCount';
|
||||
export * from './useRenderInfo';
|
||||
@@ -1,8 +1,19 @@
|
||||
export * from './browser';
|
||||
export * from './component';
|
||||
export * from './lifecycle';
|
||||
export * from './math';
|
||||
export * from './reactivity';
|
||||
export * from './state';
|
||||
export * from './storage';
|
||||
export * from './utilities';
|
||||
export * from './tryOnBeforeMount';
|
||||
export * from './tryOnMounted';
|
||||
export * from './tryOnScopeDispose';
|
||||
export * from './unrefElement';
|
||||
export * from './useAppSharedState';
|
||||
export * from './useAsyncState';
|
||||
export * from './useCached';
|
||||
export * from './useClamp';
|
||||
export * from './useContextFactory';
|
||||
export * from './useCounter';
|
||||
export * from './useFocusGuard';
|
||||
export * from './useInjectionStore';
|
||||
export * from './useLastChanged';
|
||||
export * from './useMounted';
|
||||
export * from './useOffsetPagination';
|
||||
export * from './useRenderCount';
|
||||
export * from './useRenderInfo';
|
||||
export * from './useSupported';
|
||||
export * from './useSyncRefs';
|
||||
|
||||
@@ -1,4 +0,0 @@
|
||||
export * from './tryOnBeforeMount';
|
||||
export * from './tryOnMounted';
|
||||
export * from './tryOnScopeDispose';
|
||||
export * from './useMounted';
|
||||
@@ -1 +0,0 @@
|
||||
export * from './useClamp';
|
||||
@@ -1,41 +0,0 @@
|
||||
import { customRef, onScopeDispose } from 'vue';
|
||||
|
||||
/**
|
||||
* @name broadcastedRef
|
||||
* @category Reactivity
|
||||
* @description Creates a custom ref that syncs its value across browser tabs via the BroadcastChannel API
|
||||
*
|
||||
* @param {string} key The channel key to use for broadcasting
|
||||
* @param {T} initialValue The initial value of the ref
|
||||
* @returns {Ref<T>} A custom ref that broadcasts value changes across tabs
|
||||
*
|
||||
* @example
|
||||
* const count = broadcastedRef('counter', 0);
|
||||
*
|
||||
* @since 0.0.1
|
||||
*/
|
||||
export function broadcastedRef<T>(key: string, initialValue: T) {
|
||||
const channel = new BroadcastChannel(key);
|
||||
|
||||
onScopeDispose(channel.close);
|
||||
|
||||
return customRef<T>((track, trigger) => {
|
||||
channel.onmessage = (event) => {
|
||||
track();
|
||||
return event.data;
|
||||
};
|
||||
|
||||
channel.postMessage(initialValue);
|
||||
|
||||
return {
|
||||
get() {
|
||||
return initialValue;
|
||||
},
|
||||
set(newValue: T) {
|
||||
initialValue = newValue;
|
||||
channel.postMessage(newValue);
|
||||
trigger();
|
||||
},
|
||||
};
|
||||
});
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
export * from './broadcastedRef';
|
||||
export * from './useCached';
|
||||
export * from './useLastChanged';
|
||||
export * from './useSyncRefs';
|
||||
@@ -1,6 +0,0 @@
|
||||
export * from './useAppSharedState';
|
||||
export * from './useAsyncState';
|
||||
export * from './useContextFactory';
|
||||
export * from './useCounter';
|
||||
export * from './useInjectionStore';
|
||||
export * from './useToggle';
|
||||
@@ -1,110 +0,0 @@
|
||||
import { it, expect, describe } from 'vitest';
|
||||
import { ref } from 'vue';
|
||||
import { useToggle } from '.';
|
||||
|
||||
describe(useToggle, () => {
|
||||
it('initialize with false by default', () => {
|
||||
const { value } = useToggle();
|
||||
expect(value.value).toBeFalsy();
|
||||
});
|
||||
|
||||
it('initialize with the provided initial value', () => {
|
||||
const { value } = useToggle(true);
|
||||
expect(value.value).toBeTruthy();
|
||||
});
|
||||
|
||||
it('initialize with the provided initial value from a ref', () => {
|
||||
const { value } = useToggle(ref(true));
|
||||
expect(value.value).toBeTruthy();
|
||||
});
|
||||
|
||||
it('toggle from false to true', () => {
|
||||
const { value, toggle } = useToggle(false);
|
||||
toggle();
|
||||
expect(value.value).toBeTruthy();
|
||||
});
|
||||
|
||||
it('toggle from true to false', () => {
|
||||
const { value, toggle } = useToggle(true);
|
||||
toggle();
|
||||
expect(value.value).toBeFalsy();
|
||||
});
|
||||
|
||||
it('toggle multiple times', () => {
|
||||
const { value, toggle } = useToggle(false);
|
||||
toggle();
|
||||
expect(value.value).toBeTruthy();
|
||||
toggle();
|
||||
expect(value.value).toBeFalsy();
|
||||
toggle();
|
||||
expect(value.value).toBeTruthy();
|
||||
});
|
||||
|
||||
it('toggle returns the new value', () => {
|
||||
const { toggle } = useToggle(false);
|
||||
expect(toggle()).toBeTruthy();
|
||||
expect(toggle()).toBeFalsy();
|
||||
});
|
||||
|
||||
it('set a specific value via toggle', () => {
|
||||
const { value, toggle } = useToggle(false);
|
||||
toggle(true);
|
||||
expect(value.value).toBeTruthy();
|
||||
toggle(true);
|
||||
expect(value.value).toBeTruthy();
|
||||
});
|
||||
|
||||
it('use custom truthy and falsy values', () => {
|
||||
const { value, toggle } = useToggle('off', {
|
||||
truthyValue: 'on',
|
||||
falsyValue: 'off',
|
||||
});
|
||||
|
||||
expect(value.value).toBe('off');
|
||||
toggle();
|
||||
expect(value.value).toBe('on');
|
||||
toggle();
|
||||
expect(value.value).toBe('off');
|
||||
});
|
||||
|
||||
it('set a specific custom value via toggle', () => {
|
||||
const { value, toggle } = useToggle('off', {
|
||||
truthyValue: 'on',
|
||||
falsyValue: 'off',
|
||||
});
|
||||
|
||||
toggle('on');
|
||||
expect(value.value).toBe('on');
|
||||
toggle('on');
|
||||
expect(value.value).toBe('on');
|
||||
});
|
||||
|
||||
it('use ref-based truthy and falsy values', () => {
|
||||
const truthy = ref('yes');
|
||||
const falsy = ref('no');
|
||||
|
||||
const { value, toggle } = useToggle('no', {
|
||||
truthyValue: truthy,
|
||||
falsyValue: falsy,
|
||||
});
|
||||
|
||||
expect(value.value).toBe('no');
|
||||
toggle();
|
||||
expect(value.value).toBe('yes');
|
||||
toggle();
|
||||
expect(value.value).toBe('no');
|
||||
});
|
||||
|
||||
it('use getter-based truthy and falsy values', () => {
|
||||
const { value, toggle } = useToggle(0, {
|
||||
truthyValue: () => 1,
|
||||
falsyValue: () => 0,
|
||||
});
|
||||
|
||||
expect(value.value).toBe(0);
|
||||
toggle();
|
||||
expect(value.value).toBe(1);
|
||||
toggle();
|
||||
expect(value.value).toBe(0);
|
||||
});
|
||||
});
|
||||
@@ -1,4 +0,0 @@
|
||||
export * from './useLocalStorage';
|
||||
export * from './useSessionStorage';
|
||||
export * from './useStorage';
|
||||
export * from './useStorageAsync';
|
||||
@@ -1,72 +0,0 @@
|
||||
import { describe, it, expect, beforeEach } from 'vitest';
|
||||
import { nextTick } from 'vue';
|
||||
import { useLocalStorage } from '.';
|
||||
|
||||
describe(useLocalStorage, () => {
|
||||
beforeEach(() => {
|
||||
localStorage.clear();
|
||||
});
|
||||
|
||||
it('stores and reads a string via localStorage', async () => {
|
||||
const state = useLocalStorage<string>('ls-string', 'hello');
|
||||
|
||||
expect(state.value).toBe('hello');
|
||||
expect(localStorage.getItem('ls-string')).toBe('hello');
|
||||
|
||||
state.value = 'world';
|
||||
await nextTick();
|
||||
|
||||
expect(localStorage.getItem('ls-string')).toBe('world');
|
||||
});
|
||||
|
||||
it('stores and reads a number', async () => {
|
||||
const state = useLocalStorage<number>('ls-number', 42);
|
||||
|
||||
expect(state.value).toBe(42);
|
||||
|
||||
state.value = 100;
|
||||
await nextTick();
|
||||
|
||||
expect(localStorage.getItem('ls-number')).toBe('100');
|
||||
});
|
||||
|
||||
it('stores and reads an object', async () => {
|
||||
const state = useLocalStorage('ls-obj', { a: 1 });
|
||||
|
||||
expect(state.value).toEqual({ a: 1 });
|
||||
|
||||
state.value = { a: 2 };
|
||||
await nextTick();
|
||||
|
||||
expect(JSON.parse(localStorage.getItem('ls-obj')!)).toEqual({ a: 2 });
|
||||
});
|
||||
|
||||
it('reads existing value from localStorage on init', () => {
|
||||
localStorage.setItem('ls-existing', '"stored"');
|
||||
|
||||
const state = useLocalStorage('ls-existing', 'default', {
|
||||
serializer: { read: (v) => JSON.parse(v), write: (v) => JSON.stringify(v) },
|
||||
});
|
||||
|
||||
expect(state.value).toBe('stored');
|
||||
});
|
||||
|
||||
it('removes from localStorage when set to null', async () => {
|
||||
const state = useLocalStorage<string | null>('ls-null', 'value');
|
||||
expect(localStorage.getItem('ls-null')).toBe('value');
|
||||
|
||||
state.value = null;
|
||||
await nextTick();
|
||||
|
||||
expect(localStorage.getItem('ls-null')).toBeNull();
|
||||
});
|
||||
|
||||
it('passes options through to useStorage', () => {
|
||||
const state = useLocalStorage<string>('ls-no-write', 'default', {
|
||||
writeDefaults: false,
|
||||
});
|
||||
|
||||
expect(state.value).toBe('default');
|
||||
expect(localStorage.getItem('ls-no-write')).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -1,41 +0,0 @@
|
||||
import type { MaybeRefOrGetter, Ref } from 'vue';
|
||||
import { defaultWindow } from '@/types';
|
||||
import { VueToolsError } from '@/utils/error';
|
||||
import { useStorage } from '../useStorage';
|
||||
import type { UseStorageOptions } from '../useStorage';
|
||||
|
||||
/**
|
||||
* @name useLocalStorage
|
||||
* @category Storage
|
||||
* @description Reactive localStorage binding — creates a ref synced with `window.localStorage`
|
||||
*
|
||||
* @param {string} key The storage key
|
||||
* @param {MaybeRefOrGetter<T>} initialValue The initial/default value
|
||||
* @param {UseStorageOptions<T>} [options={}] Options
|
||||
* @returns {Ref<T>} A reactive ref synced with localStorage
|
||||
*
|
||||
* @example
|
||||
* const count = useLocalStorage('my-count', 0);
|
||||
*
|
||||
* @example
|
||||
* const state = useLocalStorage('my-state', { hello: 'world' });
|
||||
*
|
||||
* @since 0.0.12
|
||||
*/
|
||||
export function useLocalStorage<T extends string>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useLocalStorage<T extends number>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useLocalStorage<T extends boolean>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useLocalStorage<T>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useLocalStorage<T = unknown>(key: string, initialValue: MaybeRefOrGetter<null>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useLocalStorage<T>(
|
||||
key: string,
|
||||
initialValue: MaybeRefOrGetter<T>,
|
||||
options: UseStorageOptions<T> = {},
|
||||
): Ref<T> {
|
||||
const storage = defaultWindow?.localStorage;
|
||||
|
||||
if (!storage)
|
||||
throw new VueToolsError('useLocalStorage: localStorage is not available');
|
||||
|
||||
return useStorage(key, initialValue, storage, options);
|
||||
}
|
||||
@@ -1,72 +0,0 @@
|
||||
import { describe, it, expect, beforeEach } from 'vitest';
|
||||
import { nextTick } from 'vue';
|
||||
import { useSessionStorage } from '.';
|
||||
|
||||
describe(useSessionStorage, () => {
|
||||
beforeEach(() => {
|
||||
sessionStorage.clear();
|
||||
});
|
||||
|
||||
it('stores and reads a string via sessionStorage', async () => {
|
||||
const state = useSessionStorage<string>('ss-string', 'hello');
|
||||
|
||||
expect(state.value).toBe('hello');
|
||||
expect(sessionStorage.getItem('ss-string')).toBe('hello');
|
||||
|
||||
state.value = 'world';
|
||||
await nextTick();
|
||||
|
||||
expect(sessionStorage.getItem('ss-string')).toBe('world');
|
||||
});
|
||||
|
||||
it('stores and reads a number', async () => {
|
||||
const state = useSessionStorage<number>('ss-number', 42);
|
||||
|
||||
expect(state.value).toBe(42);
|
||||
|
||||
state.value = 100;
|
||||
await nextTick();
|
||||
|
||||
expect(sessionStorage.getItem('ss-number')).toBe('100');
|
||||
});
|
||||
|
||||
it('stores and reads an object', async () => {
|
||||
const state = useSessionStorage('ss-obj', { a: 1 });
|
||||
|
||||
expect(state.value).toEqual({ a: 1 });
|
||||
|
||||
state.value = { a: 2 };
|
||||
await nextTick();
|
||||
|
||||
expect(JSON.parse(sessionStorage.getItem('ss-obj')!)).toEqual({ a: 2 });
|
||||
});
|
||||
|
||||
it('reads existing value from sessionStorage on init', () => {
|
||||
sessionStorage.setItem('ss-existing', '"stored"');
|
||||
|
||||
const state = useSessionStorage('ss-existing', 'default', {
|
||||
serializer: { read: (v) => JSON.parse(v), write: (v) => JSON.stringify(v) },
|
||||
});
|
||||
|
||||
expect(state.value).toBe('stored');
|
||||
});
|
||||
|
||||
it('removes from sessionStorage when set to null', async () => {
|
||||
const state = useSessionStorage<string | null>('ss-null', 'value');
|
||||
expect(sessionStorage.getItem('ss-null')).toBe('value');
|
||||
|
||||
state.value = null;
|
||||
await nextTick();
|
||||
|
||||
expect(sessionStorage.getItem('ss-null')).toBeNull();
|
||||
});
|
||||
|
||||
it('passes options through to useStorage', () => {
|
||||
const state = useSessionStorage<string>('ss-no-write', 'default', {
|
||||
writeDefaults: false,
|
||||
});
|
||||
|
||||
expect(state.value).toBe('default');
|
||||
expect(sessionStorage.getItem('ss-no-write')).toBeNull();
|
||||
});
|
||||
});
|
||||
@@ -1,41 +0,0 @@
|
||||
import type { MaybeRefOrGetter, Ref } from 'vue';
|
||||
import { defaultWindow } from '@/types';
|
||||
import { VueToolsError } from '@/utils/error';
|
||||
import { useStorage } from '../useStorage';
|
||||
import type { UseStorageOptions } from '../useStorage';
|
||||
|
||||
/**
|
||||
* @name useSessionStorage
|
||||
* @category Storage
|
||||
* @description Reactive sessionStorage binding — creates a ref synced with `window.sessionStorage`
|
||||
*
|
||||
* @param {string} key The storage key
|
||||
* @param {MaybeRefOrGetter<T>} initialValue The initial/default value
|
||||
* @param {UseStorageOptions<T>} [options={}] Options
|
||||
* @returns {Ref<T>} A reactive ref synced with sessionStorage
|
||||
*
|
||||
* @example
|
||||
* const count = useSessionStorage('my-count', 0);
|
||||
*
|
||||
* @example
|
||||
* const state = useSessionStorage('my-state', { hello: 'world' });
|
||||
*
|
||||
* @since 0.0.12
|
||||
*/
|
||||
export function useSessionStorage<T extends string>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useSessionStorage<T extends number>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useSessionStorage<T extends boolean>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useSessionStorage<T>(key: string, initialValue: MaybeRefOrGetter<T>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useSessionStorage<T = unknown>(key: string, initialValue: MaybeRefOrGetter<null>, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useSessionStorage<T>(
|
||||
key: string,
|
||||
initialValue: MaybeRefOrGetter<T>,
|
||||
options: UseStorageOptions<T> = {},
|
||||
): Ref<T> {
|
||||
const storage = defaultWindow?.sessionStorage;
|
||||
|
||||
if (!storage)
|
||||
throw new VueToolsError('useSessionStorage: sessionStorage is not available');
|
||||
|
||||
return useStorage(key, initialValue, storage, options);
|
||||
}
|
||||
@@ -1,319 +0,0 @@
|
||||
import { describe, it, expect, vi } from 'vitest';
|
||||
import { nextTick } from 'vue';
|
||||
import { useStorage, StorageSerializers } from '.';
|
||||
import type { StorageLike } from '.';
|
||||
|
||||
function createMockStorage(): StorageLike & { store: Map<string, string> } {
|
||||
const store = new Map<string, string>();
|
||||
|
||||
return {
|
||||
store,
|
||||
getItem: (key: string) => store.get(key) ?? null,
|
||||
setItem: (key: string, value: string) => store.set(key, value),
|
||||
removeItem: (key: string) => store.delete(key),
|
||||
};
|
||||
}
|
||||
|
||||
describe(useStorage, () => {
|
||||
// --- Basic types ---
|
||||
|
||||
it('stores and reads a string', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage<string>('test-string', 'hello', storage);
|
||||
|
||||
expect(state.value).toBe('hello');
|
||||
expect(storage.getItem('test-string')).toBe('hello');
|
||||
|
||||
state.value = 'world';
|
||||
await nextTick();
|
||||
|
||||
expect(storage.getItem('test-string')).toBe('world');
|
||||
});
|
||||
|
||||
it('stores and reads a number', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage<number>('test-number', 42, storage);
|
||||
|
||||
expect(state.value).toBe(42);
|
||||
|
||||
state.value = 100;
|
||||
await nextTick();
|
||||
|
||||
expect(storage.getItem('test-number')).toBe('100');
|
||||
});
|
||||
|
||||
it('stores and reads a boolean', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage<boolean>('test-bool', true, storage);
|
||||
|
||||
expect(state.value).toBeTruthy();
|
||||
|
||||
state.value = false;
|
||||
await nextTick();
|
||||
|
||||
expect(storage.getItem('test-bool')).toBe('false');
|
||||
});
|
||||
|
||||
it('stores and reads an object', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage('test-obj', { a: 1, b: 'two' }, storage);
|
||||
|
||||
expect(state.value).toEqual({ a: 1, b: 'two' });
|
||||
|
||||
state.value = { a: 2, b: 'three' };
|
||||
await nextTick();
|
||||
|
||||
expect(JSON.parse(storage.getItem('test-obj')!)).toEqual({ a: 2, b: 'three' });
|
||||
});
|
||||
|
||||
// --- Reads existing value from storage ---
|
||||
|
||||
it('reads existing value from storage on init', () => {
|
||||
const storage = createMockStorage();
|
||||
storage.store.set('existing', '"stored-value"');
|
||||
|
||||
const state = useStorage('existing', 'default', storage, {
|
||||
serializer: StorageSerializers.object,
|
||||
});
|
||||
|
||||
expect(state.value).toBe('stored-value');
|
||||
});
|
||||
|
||||
// --- Removes item when set to null ---
|
||||
|
||||
it('removes from storage when value is set to null', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage<string | null>('test-null', 'value', storage);
|
||||
|
||||
await nextTick();
|
||||
expect(storage.getItem('test-null')).toBe('value');
|
||||
|
||||
state.value = null;
|
||||
await nextTick();
|
||||
|
||||
expect(storage.getItem('test-null')).toBeNull();
|
||||
});
|
||||
|
||||
// --- Custom serializer ---
|
||||
|
||||
it('uses custom serializer', async () => {
|
||||
const storage = createMockStorage();
|
||||
|
||||
const serializer = {
|
||||
read: (v: string) => v.split(',').map(Number),
|
||||
write: (v: number[]) => v.join(','),
|
||||
};
|
||||
|
||||
const state = useStorage('custom-ser', [1, 2, 3], storage, { serializer });
|
||||
|
||||
expect(state.value).toEqual([1, 2, 3]);
|
||||
|
||||
state.value = [4, 5, 6];
|
||||
await nextTick();
|
||||
|
||||
expect(storage.getItem('custom-ser')).toBe('4,5,6');
|
||||
});
|
||||
|
||||
// --- Merge defaults ---
|
||||
|
||||
it('merges defaults with stored value', () => {
|
||||
const storage = createMockStorage();
|
||||
storage.store.set('merge-test', JSON.stringify({ hello: 'stored' }));
|
||||
|
||||
const state = useStorage(
|
||||
'merge-test',
|
||||
{ hello: 'default', greeting: 'hi' },
|
||||
storage,
|
||||
{ mergeDefaults: true },
|
||||
);
|
||||
|
||||
expect(state.value.hello).toBe('stored');
|
||||
expect(state.value.greeting).toBe('hi');
|
||||
});
|
||||
|
||||
it('uses custom merge function', () => {
|
||||
const storage = createMockStorage();
|
||||
storage.store.set('merge-fn', JSON.stringify({ a: 1 }));
|
||||
|
||||
const state = useStorage(
|
||||
'merge-fn',
|
||||
{ a: 0, b: 2 },
|
||||
storage,
|
||||
{
|
||||
mergeDefaults: (stored, defaults) => ({ ...defaults, ...stored, b: stored.b ?? defaults.b }),
|
||||
},
|
||||
);
|
||||
|
||||
expect(state.value).toEqual({ a: 1, b: 2 });
|
||||
});
|
||||
|
||||
// --- Map and Set ---
|
||||
|
||||
it('stores and reads a Map', async () => {
|
||||
const storage = createMockStorage();
|
||||
const initial = new Map([['key1', 'val1']]);
|
||||
const state = useStorage('test-map', initial, storage);
|
||||
|
||||
expect(state.value).toEqual(new Map([['key1', 'val1']]));
|
||||
|
||||
state.value = new Map([['key2', 'val2']]);
|
||||
await nextTick();
|
||||
|
||||
const raw = storage.getItem('test-map');
|
||||
expect(JSON.parse(raw!)).toEqual([['key2', 'val2']]);
|
||||
});
|
||||
|
||||
it('stores and reads a Set', async () => {
|
||||
const storage = createMockStorage();
|
||||
const initial = new Set([1, 2, 3]);
|
||||
const state = useStorage('test-set', initial, storage);
|
||||
|
||||
expect(state.value).toEqual(new Set([1, 2, 3]));
|
||||
|
||||
state.value = new Set([4, 5]);
|
||||
await nextTick();
|
||||
|
||||
const raw = storage.getItem('test-set');
|
||||
expect(JSON.parse(raw!)).toEqual([4, 5]);
|
||||
});
|
||||
|
||||
// --- Date ---
|
||||
|
||||
it('stores and reads a Date', async () => {
|
||||
const storage = createMockStorage();
|
||||
const date = new Date('2026-02-14T00:00:00.000Z');
|
||||
const state = useStorage('test-date', date, storage);
|
||||
|
||||
expect(state.value).toEqual(date);
|
||||
|
||||
const newDate = new Date('2026-12-25T00:00:00.000Z');
|
||||
state.value = newDate;
|
||||
await nextTick();
|
||||
|
||||
expect(storage.getItem('test-date')).toBe(newDate.toISOString());
|
||||
});
|
||||
|
||||
// --- Error handling ---
|
||||
|
||||
it('calls onError when read fails', () => {
|
||||
const storage = createMockStorage();
|
||||
storage.store.set('bad-json', '{invalid');
|
||||
const onError = vi.fn();
|
||||
|
||||
const state = useStorage('bad-json', { fallback: true }, storage, { onError });
|
||||
|
||||
expect(onError).toHaveBeenCalledOnce();
|
||||
expect(state.value).toEqual({ fallback: true });
|
||||
});
|
||||
|
||||
it('calls onError when write fails', async () => {
|
||||
const onError = vi.fn();
|
||||
const storage: StorageLike = {
|
||||
getItem: () => null,
|
||||
setItem: () => { throw new Error('quota exceeded'); },
|
||||
removeItem: () => {},
|
||||
};
|
||||
|
||||
const state = useStorage<string>('fail-write', 'init', storage, { onError });
|
||||
|
||||
// One error from initial persist of defaults
|
||||
expect(onError).toHaveBeenCalledOnce();
|
||||
|
||||
state.value = 'new';
|
||||
await nextTick();
|
||||
|
||||
// Another error from the write triggered by value change
|
||||
expect(onError).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
// --- Persists defaults on init ---
|
||||
|
||||
it('persists default value to storage on init when key does not exist', () => {
|
||||
const storage = createMockStorage();
|
||||
useStorage('new-key', 'default-val', storage);
|
||||
|
||||
expect(storage.getItem('new-key')).toBe('default-val');
|
||||
});
|
||||
|
||||
it('does not overwrite existing storage value with defaults', () => {
|
||||
const storage = createMockStorage();
|
||||
storage.store.set('existing-key', 'existing-val');
|
||||
|
||||
useStorage('existing-key', 'default-val', storage);
|
||||
|
||||
expect(storage.getItem('existing-key')).toBe('existing-val');
|
||||
});
|
||||
|
||||
// --- writeDefaults: false ---
|
||||
|
||||
it('does not persist defaults when writeDefaults is false', () => {
|
||||
const storage = createMockStorage();
|
||||
useStorage('no-write', 'default-val', storage, { writeDefaults: false });
|
||||
|
||||
expect(storage.getItem('no-write')).toBeNull();
|
||||
});
|
||||
|
||||
// --- No infinite loop on init ---
|
||||
|
||||
it('calls setItem exactly once on init for writeDefaults', () => {
|
||||
const setItem = vi.fn();
|
||||
const storage: StorageLike = {
|
||||
getItem: () => null,
|
||||
setItem,
|
||||
removeItem: vi.fn(),
|
||||
};
|
||||
|
||||
useStorage<string>('init-key', 'value', storage);
|
||||
|
||||
expect(setItem).toHaveBeenCalledOnce();
|
||||
expect(setItem).toHaveBeenCalledWith('init-key', 'value');
|
||||
});
|
||||
|
||||
// --- No-op write when value unchanged ---
|
||||
|
||||
it('does not call setItem when value is unchanged', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage<string>('noop-key', 'same', storage);
|
||||
|
||||
const setItem = vi.spyOn(storage, 'setItem');
|
||||
setItem.mockClear();
|
||||
|
||||
// Re-assign the same value
|
||||
state.value = 'same';
|
||||
await nextTick();
|
||||
|
||||
expect(setItem).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
// --- shallow: false with deep mutation ---
|
||||
|
||||
it('writes to storage on deep object mutation with shallow: false', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage('deep-obj', { nested: { count: 0 } }, storage, { shallow: false });
|
||||
|
||||
expect(state.value.nested.count).toBe(0);
|
||||
|
||||
state.value.nested.count = 42;
|
||||
await nextTick();
|
||||
|
||||
expect(JSON.parse(storage.getItem('deep-obj')!)).toEqual({ nested: { count: 42 } });
|
||||
});
|
||||
|
||||
// --- Multiple rapid assignments ---
|
||||
|
||||
it('only writes last value when multiple assignments happen before flush', async () => {
|
||||
const storage = createMockStorage();
|
||||
const state = useStorage<string>('rapid-key', 'initial', storage);
|
||||
|
||||
const setItem = vi.spyOn(storage, 'setItem');
|
||||
setItem.mockClear();
|
||||
|
||||
state.value = 'first';
|
||||
state.value = 'second';
|
||||
state.value = 'third';
|
||||
await nextTick();
|
||||
|
||||
// Watcher fires once with the last value (pre flush batches)
|
||||
expect(storage.getItem('rapid-key')).toBe('third');
|
||||
});
|
||||
});
|
||||
@@ -1,224 +0,0 @@
|
||||
import { ref, shallowRef, watch, toValue } from 'vue';
|
||||
import type { Ref, MaybeRefOrGetter } from 'vue';
|
||||
import { isBoolean, isNumber, isString, isObject, isMap, isSet, isDate } from '@robonen/stdlib';
|
||||
import type { ConfigurableFlush } from '@/types';
|
||||
|
||||
export interface StorageSerializer<T> {
|
||||
read: (raw: string) => T;
|
||||
write: (value: T) => string;
|
||||
}
|
||||
|
||||
export const StorageSerializers: { [K: string]: StorageSerializer<any> } & {
|
||||
boolean: StorageSerializer<boolean>;
|
||||
number: StorageSerializer<number>;
|
||||
string: StorageSerializer<string>;
|
||||
object: StorageSerializer<any>;
|
||||
map: StorageSerializer<Map<any, any>>;
|
||||
set: StorageSerializer<Set<any>>;
|
||||
date: StorageSerializer<Date>;
|
||||
} = {
|
||||
boolean: {
|
||||
read: (v: string) => v === 'true',
|
||||
write: (v: boolean) => String(v),
|
||||
},
|
||||
number: {
|
||||
read: (v: string) => Number.parseFloat(v),
|
||||
write: (v: number) => String(v),
|
||||
},
|
||||
string: {
|
||||
read: (v: string) => v,
|
||||
write: (v: string) => v,
|
||||
},
|
||||
object: {
|
||||
read: (v: string) => JSON.parse(v),
|
||||
write: (v: any) => JSON.stringify(v),
|
||||
},
|
||||
map: {
|
||||
read: (v: string) => new Map(JSON.parse(v)),
|
||||
write: (v: Map<any, any>) => JSON.stringify([...v.entries()]),
|
||||
},
|
||||
set: {
|
||||
read: (v: string) => new Set(JSON.parse(v)),
|
||||
write: (v: Set<any>) => JSON.stringify([...v]),
|
||||
},
|
||||
date: {
|
||||
read: (v: string) => new Date(v),
|
||||
write: (v: Date) => v.toISOString(),
|
||||
},
|
||||
};
|
||||
|
||||
export interface StorageLike {
|
||||
getItem: (key: string) => string | null;
|
||||
setItem: (key: string, value: string) => void;
|
||||
removeItem: (key: string) => void;
|
||||
}
|
||||
|
||||
export interface UseStorageOptions<T> extends ConfigurableFlush {
|
||||
/**
|
||||
* Use shallowRef instead of ref for the internal state
|
||||
* @default true
|
||||
*/
|
||||
shallow?: boolean;
|
||||
/**
|
||||
* Watch for deep changes
|
||||
* @default true
|
||||
*/
|
||||
deep?: boolean;
|
||||
/**
|
||||
* Write the default value to the storage when it does not exist
|
||||
* @default true
|
||||
*/
|
||||
writeDefaults?: boolean;
|
||||
/**
|
||||
* Custom serializer for reading/writing storage values
|
||||
*/
|
||||
serializer?: StorageSerializer<T>;
|
||||
/**
|
||||
* Merge the default value with the stored value
|
||||
* @default false
|
||||
*/
|
||||
mergeDefaults?: boolean | ((stored: T, defaults: T) => T);
|
||||
/**
|
||||
* Error handler for read/write failures
|
||||
*/
|
||||
onError?: (error: unknown) => void;
|
||||
}
|
||||
|
||||
export type UseStorageReturn<T> = Ref<T>;
|
||||
|
||||
export function guessSerializer<T>(value: T): StorageSerializer<T> {
|
||||
if (isBoolean(value)) return StorageSerializers.boolean as any;
|
||||
if (isNumber(value)) return StorageSerializers.number as any;
|
||||
if (isString(value)) return StorageSerializers.string as any;
|
||||
if (isMap(value)) return StorageSerializers.map as any;
|
||||
if (isSet(value)) return StorageSerializers.set as any;
|
||||
if (isDate(value)) return StorageSerializers.date as any;
|
||||
if (isObject(value)) return StorageSerializers.object as any;
|
||||
|
||||
return StorageSerializers.object as any;
|
||||
}
|
||||
|
||||
export function shallowMerge<T>(stored: T, defaults: T): T {
|
||||
if (isObject(stored) && isObject(defaults))
|
||||
return { ...defaults, ...stored };
|
||||
|
||||
return stored;
|
||||
}
|
||||
|
||||
/**
|
||||
* @name useStorage
|
||||
* @category Storage
|
||||
* @description Reactive Storage binding — creates a ref synced with a storage backend
|
||||
*
|
||||
* @param {string} key The storage key
|
||||
* @param {MaybeRefOrGetter<T>} initialValue The initial/default value
|
||||
* @param {StorageLike} storage The storage backend
|
||||
* @param {UseStorageOptions<T>} [options={}] Options
|
||||
* @returns {Ref<T>} A reactive ref synced with storage
|
||||
*
|
||||
* @example
|
||||
* const count = useStorage('my-count', 0, storage);
|
||||
*
|
||||
* @example
|
||||
* const state = useStorage('my-state', { hello: 'world' }, storage);
|
||||
*
|
||||
* @example
|
||||
* const id = useStorage('my-id', 'default', storage, {
|
||||
* serializer: { read: (v) => v, write: (v) => v },
|
||||
* });
|
||||
*
|
||||
* @since 0.0.12
|
||||
*/
|
||||
export function useStorage<T extends string>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLike, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useStorage<T extends number>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLike, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useStorage<T extends boolean>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLike, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useStorage<T>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLike, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useStorage<T = unknown>(key: string, initialValue: MaybeRefOrGetter<null>, storage: StorageLike, options?: UseStorageOptions<T>): Ref<T>;
|
||||
export function useStorage<T>(
|
||||
key: string,
|
||||
initialValue: MaybeRefOrGetter<T>,
|
||||
storage: StorageLike,
|
||||
options: UseStorageOptions<T> = {},
|
||||
): Ref<T> {
|
||||
const {
|
||||
shallow = true,
|
||||
deep = true,
|
||||
flush = 'pre',
|
||||
writeDefaults = true,
|
||||
mergeDefaults = false,
|
||||
onError = console.error, // eslint-disable-line no-console
|
||||
} = options;
|
||||
|
||||
const defaults = toValue(initialValue);
|
||||
const serializer = options.serializer ?? guessSerializer(defaults);
|
||||
|
||||
const data = (shallow ? shallowRef : ref)(defaults) as Ref<T>;
|
||||
|
||||
function read(): T {
|
||||
const raw = storage.getItem(key);
|
||||
|
||||
if (raw === undefined || raw === null) {
|
||||
if (writeDefaults && defaults !== undefined && defaults !== null) {
|
||||
try {
|
||||
storage.setItem(key, serializer.write(defaults));
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
}
|
||||
}
|
||||
|
||||
return defaults;
|
||||
}
|
||||
|
||||
try {
|
||||
let value = serializer.read(raw);
|
||||
|
||||
if (mergeDefaults) {
|
||||
value = typeof mergeDefaults === 'function'
|
||||
? mergeDefaults(value, defaults)
|
||||
: shallowMerge(value, defaults);
|
||||
}
|
||||
|
||||
return value;
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
return defaults;
|
||||
}
|
||||
}
|
||||
|
||||
function write(value: T) {
|
||||
try {
|
||||
const oldValue = storage.getItem(key);
|
||||
|
||||
if (value === undefined || value === null) {
|
||||
storage.removeItem(key);
|
||||
} else {
|
||||
const serialized = serializer.write(value);
|
||||
|
||||
if (oldValue !== serialized)
|
||||
storage.setItem(key, serialized);
|
||||
}
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
}
|
||||
}
|
||||
|
||||
function update() {
|
||||
pauseWatch();
|
||||
|
||||
try {
|
||||
data.value = read();
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
} finally {
|
||||
resumeWatch();
|
||||
}
|
||||
}
|
||||
|
||||
const { pause: pauseWatch, resume: resumeWatch } = watch(data, (newValue) => {
|
||||
write(newValue);
|
||||
}, { flush, deep });
|
||||
|
||||
update();
|
||||
|
||||
return data;
|
||||
}
|
||||
@@ -1,336 +0,0 @@
|
||||
import { describe, it, expect, vi } from 'vitest';
|
||||
import { nextTick } from 'vue';
|
||||
import { useStorageAsync } from '.';
|
||||
import type { StorageLikeAsync } from '.';
|
||||
|
||||
function createMockAsyncStorage(): StorageLikeAsync & { store: Map<string, string> } {
|
||||
const store = new Map<string, string>();
|
||||
|
||||
return {
|
||||
store,
|
||||
getItem: async (key: string) => store.get(key) ?? null,
|
||||
setItem: async (key: string, value: string) => { store.set(key, value); },
|
||||
removeItem: async (key: string) => { store.delete(key); },
|
||||
};
|
||||
}
|
||||
|
||||
function createDelayedAsyncStorage(delay: number): StorageLikeAsync & { store: Map<string, string> } {
|
||||
const store = new Map<string, string>();
|
||||
|
||||
return {
|
||||
store,
|
||||
getItem: (key: string) => new Promise((resolve) => setTimeout(() => resolve(store.get(key) ?? null), delay)),
|
||||
setItem: (key: string, value: string) => new Promise((resolve) => setTimeout(() => { store.set(key, value); resolve(); }, delay)),
|
||||
removeItem: (key: string) => new Promise((resolve) => setTimeout(() => { store.delete(key); resolve(); }, delay)),
|
||||
};
|
||||
}
|
||||
|
||||
describe(useStorageAsync, () => {
|
||||
// --- Basic read/write ---
|
||||
|
||||
it('returns default value before storage is ready', () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
const { state, isReady } = useStorageAsync('key', 'default', storage);
|
||||
|
||||
expect(state.value).toBe('default');
|
||||
expect(isReady.value).toBeFalsy();
|
||||
});
|
||||
|
||||
it('reads existing value from async storage', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('key', 'stored');
|
||||
|
||||
const { state, isReady } = await useStorageAsync('key', 'default', storage);
|
||||
|
||||
expect(state.value).toBe('stored');
|
||||
expect(isReady.value).toBeTruthy();
|
||||
});
|
||||
|
||||
it('writes value to async storage on change', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
const { state } = await useStorageAsync<string>('key', 'initial', storage);
|
||||
|
||||
state.value = 'updated';
|
||||
await nextTick();
|
||||
|
||||
// Allow async write to complete
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(storage.store.get('key')).toBe('updated');
|
||||
});
|
||||
|
||||
// --- Types ---
|
||||
|
||||
it('reads and writes a number', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('num', '42');
|
||||
|
||||
const { state } = await useStorageAsync<number>('num', 0, storage);
|
||||
|
||||
expect(state.value).toBe(42);
|
||||
|
||||
state.value = 100;
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(storage.store.get('num')).toBe('100');
|
||||
});
|
||||
|
||||
it('reads and writes a boolean', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('flag', 'true');
|
||||
|
||||
const { state } = await useStorageAsync('flag', false, storage);
|
||||
|
||||
expect(state.value).toBeTruthy();
|
||||
|
||||
state.value = false;
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(storage.store.get('flag')).toBe('false');
|
||||
});
|
||||
|
||||
it('reads and writes an object', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('obj', JSON.stringify({ a: 1 }));
|
||||
|
||||
const { state } = await useStorageAsync('obj', { a: 0, b: 2 }, storage);
|
||||
|
||||
expect(state.value).toEqual({ a: 1 });
|
||||
});
|
||||
|
||||
// --- Awaitable ---
|
||||
|
||||
it('is awaitable and resolves after initial read', async () => {
|
||||
const storage = createDelayedAsyncStorage(50);
|
||||
storage.store.set('delayed', 'loaded');
|
||||
|
||||
const { state, isReady } = await useStorageAsync('delayed', 'default', storage);
|
||||
|
||||
expect(state.value).toBe('loaded');
|
||||
expect(isReady.value).toBeTruthy();
|
||||
});
|
||||
|
||||
// --- onReady callback ---
|
||||
|
||||
it('calls onReady callback after initial load', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('ready', 'ready-value');
|
||||
|
||||
const onReady = vi.fn();
|
||||
|
||||
await useStorageAsync('ready', 'default', storage, { onReady });
|
||||
|
||||
expect(onReady).toHaveBeenCalledOnce();
|
||||
expect(onReady).toHaveBeenCalledWith('ready-value');
|
||||
});
|
||||
|
||||
it('calls onReady with default when key not in storage', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
const onReady = vi.fn();
|
||||
|
||||
await useStorageAsync('missing', 'fallback', storage, { onReady });
|
||||
|
||||
expect(onReady).toHaveBeenCalledWith('fallback');
|
||||
});
|
||||
|
||||
// --- Merge defaults ---
|
||||
|
||||
it('merges defaults with stored value', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('merge', JSON.stringify({ hello: 'stored' }));
|
||||
|
||||
const { state } = await useStorageAsync(
|
||||
'merge',
|
||||
{ hello: 'default', greeting: 'hi' },
|
||||
storage,
|
||||
{ mergeDefaults: true },
|
||||
);
|
||||
|
||||
expect(state.value.hello).toBe('stored');
|
||||
expect(state.value.greeting).toBe('hi');
|
||||
});
|
||||
|
||||
it('uses custom merge function', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('merge-fn', JSON.stringify({ a: 1 }));
|
||||
|
||||
const { state } = await useStorageAsync(
|
||||
'merge-fn',
|
||||
{ a: 0, b: 2 },
|
||||
storage,
|
||||
{
|
||||
mergeDefaults: (stored, defaults) => ({ ...defaults, ...stored, b: stored.b ?? defaults.b }),
|
||||
},
|
||||
);
|
||||
|
||||
expect(state.value).toEqual({ a: 1, b: 2 });
|
||||
});
|
||||
|
||||
// --- Custom serializer ---
|
||||
|
||||
it('uses custom async serializer', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('custom', '1,2,3');
|
||||
|
||||
const serializer = {
|
||||
read: async (v: string) => v.split(',').map(Number),
|
||||
write: async (v: number[]) => v.join(','),
|
||||
};
|
||||
|
||||
const { state } = await useStorageAsync('custom', [0], storage, { serializer });
|
||||
|
||||
expect(state.value).toEqual([1, 2, 3]);
|
||||
|
||||
state.value = [4, 5, 6];
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(storage.store.get('custom')).toBe('4,5,6');
|
||||
});
|
||||
|
||||
// --- Null / remove ---
|
||||
|
||||
it('removes from storage when value is set to null', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('nullable', 'exists');
|
||||
|
||||
const { state } = await useStorageAsync<string | null>('nullable', 'default', storage);
|
||||
|
||||
state.value = null;
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(storage.store.has('nullable')).toBeFalsy();
|
||||
});
|
||||
|
||||
// --- Error handling ---
|
||||
|
||||
it('calls onError when read fails', async () => {
|
||||
const onError = vi.fn();
|
||||
const storage: StorageLikeAsync = {
|
||||
getItem: async () => { throw new Error('read failure'); },
|
||||
setItem: async () => {},
|
||||
removeItem: async () => {},
|
||||
};
|
||||
|
||||
const { state } = await useStorageAsync('fail-read', 'fallback', storage, { onError });
|
||||
|
||||
expect(onError).toHaveBeenCalledOnce();
|
||||
expect(state.value).toBe('fallback');
|
||||
});
|
||||
|
||||
it('calls onError when write fails', async () => {
|
||||
const onError = vi.fn();
|
||||
const storage: StorageLikeAsync = {
|
||||
getItem: async () => null,
|
||||
setItem: async () => { throw new Error('write failure'); },
|
||||
removeItem: async () => {},
|
||||
};
|
||||
|
||||
const { state } = await useStorageAsync<string>('fail-write', 'initial', storage, { onError });
|
||||
|
||||
// One error from writeDefaults persisting initial value
|
||||
expect(onError).toHaveBeenCalledOnce();
|
||||
|
||||
state.value = 'new';
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
// Another error from the write triggered by value change
|
||||
expect(onError).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
// --- No unnecessary write-back on initial read ---
|
||||
|
||||
it('does not write back to storage after initial read', async () => {
|
||||
const setItem = vi.fn(async () => {});
|
||||
const storage: StorageLikeAsync = {
|
||||
getItem: async () => 'existing',
|
||||
setItem,
|
||||
removeItem: async () => {},
|
||||
};
|
||||
|
||||
await useStorageAsync('key', 'default', storage);
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(setItem).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it('does not write back to storage when key is missing and writeDefaults is false', async () => {
|
||||
const setItem = vi.fn(async () => {});
|
||||
const storage: StorageLikeAsync = {
|
||||
getItem: async () => null,
|
||||
setItem,
|
||||
removeItem: async () => {},
|
||||
};
|
||||
|
||||
await useStorageAsync('key', 'default', storage, { writeDefaults: false });
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(setItem).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
// --- shallow: false with deep mutation ---
|
||||
|
||||
it('writes to storage on deep object mutation with shallow: false', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
const { state } = await useStorageAsync(
|
||||
'deep-obj',
|
||||
{ nested: { count: 0 } },
|
||||
storage,
|
||||
{ shallow: false },
|
||||
);
|
||||
|
||||
state.value.nested.count = 42;
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(JSON.parse(storage.store.get('deep-obj')!)).toEqual({ nested: { count: 42 } });
|
||||
});
|
||||
|
||||
// --- Multiple rapid assignments ---
|
||||
|
||||
it('handles multiple rapid assignments', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
const { state } = await useStorageAsync<string>('rapid', 'initial', storage);
|
||||
|
||||
state.value = 'first';
|
||||
state.value = 'second';
|
||||
state.value = 'third';
|
||||
await nextTick();
|
||||
await new Promise((resolve) => setTimeout(resolve, 0));
|
||||
|
||||
expect(storage.store.get('rapid')).toBe('third');
|
||||
});
|
||||
|
||||
// --- writeDefaults ---
|
||||
|
||||
it('persists defaults to storage when key does not exist', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
|
||||
await useStorageAsync('new-key', 'default-val', storage);
|
||||
|
||||
expect(storage.store.get('new-key')).toBe('default-val');
|
||||
});
|
||||
|
||||
it('does not persist defaults when writeDefaults is false', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
|
||||
await useStorageAsync('new-key', 'default-val', storage, { writeDefaults: false });
|
||||
|
||||
expect(storage.store.has('new-key')).toBeFalsy();
|
||||
});
|
||||
|
||||
it('does not overwrite existing value with defaults', async () => {
|
||||
const storage = createMockAsyncStorage();
|
||||
storage.store.set('existing', 'stored');
|
||||
|
||||
await useStorageAsync('existing', 'default', storage);
|
||||
|
||||
expect(storage.store.get('existing')).toBe('stored');
|
||||
});
|
||||
});
|
||||
@@ -1,188 +0,0 @@
|
||||
import { ref, shallowRef, watch, toValue } from 'vue';
|
||||
import type { Ref, ShallowRef, MaybeRefOrGetter, UnwrapRef } from 'vue';
|
||||
import type { ConfigurableFlush } from '@/types';
|
||||
import { tryOnScopeDispose } from '@/composables/lifecycle/tryOnScopeDispose';
|
||||
import { guessSerializer, shallowMerge } from '../useStorage';
|
||||
|
||||
export interface StorageSerializerAsync<T> {
|
||||
read: (raw: string) => T | Promise<T>;
|
||||
write: (value: T) => string | Promise<string>;
|
||||
}
|
||||
|
||||
export interface StorageLikeAsync {
|
||||
getItem: (key: string) => string | null | Promise<string | null>;
|
||||
setItem: (key: string, value: string) => void | Promise<void>;
|
||||
removeItem: (key: string) => void | Promise<void>;
|
||||
}
|
||||
|
||||
export interface UseStorageAsyncOptions<T, Shallow extends boolean = true> extends ConfigurableFlush {
|
||||
/**
|
||||
* Use shallowRef instead of ref for the internal state
|
||||
* @default true
|
||||
*/
|
||||
shallow?: Shallow;
|
||||
/**
|
||||
* Watch for deep changes
|
||||
* @default true
|
||||
*/
|
||||
deep?: boolean;
|
||||
/**
|
||||
* Write the default value to the storage when it does not exist
|
||||
* @default true
|
||||
*/
|
||||
writeDefaults?: boolean;
|
||||
/**
|
||||
* Custom serializer for reading/writing storage values
|
||||
*/
|
||||
serializer?: StorageSerializerAsync<T>;
|
||||
/**
|
||||
* Merge the default value with the stored value
|
||||
* @default false
|
||||
*/
|
||||
mergeDefaults?: boolean | ((stored: T, defaults: T) => T);
|
||||
/**
|
||||
* Called once when the initial value has been loaded from storage
|
||||
*/
|
||||
onReady?: (value: T) => void;
|
||||
/**
|
||||
* Error handler for read/write failures
|
||||
*/
|
||||
onError?: (error: unknown) => void;
|
||||
}
|
||||
|
||||
export interface UseStorageAsyncReturnBase<T, Shallow extends boolean> {
|
||||
state: Shallow extends true ? ShallowRef<T> : Ref<UnwrapRef<T>>;
|
||||
isReady: Ref<boolean>;
|
||||
}
|
||||
|
||||
export type UseStorageAsyncReturn<T, Shallow extends boolean> =
|
||||
& UseStorageAsyncReturnBase<T, Shallow>
|
||||
& PromiseLike<UseStorageAsyncReturnBase<T, Shallow>>;
|
||||
|
||||
/**
|
||||
* @name useStorageAsync
|
||||
* @category Storage
|
||||
* @description Reactive Storage binding with async support — creates a ref synced with an async storage backend
|
||||
*
|
||||
* @param {string} key The storage key
|
||||
* @param {MaybeRefOrGetter<T>} initialValue The initial/default value
|
||||
* @param {StorageLikeAsync} storage The async storage backend
|
||||
* @param {UseStorageAsyncOptions<T>} [options={}] Options
|
||||
* @returns {UseStorageAsyncReturn<T, Shallow>} An object with state ref and isReady flag, also awaitable
|
||||
*
|
||||
* @example
|
||||
* const { state } = useStorageAsync('access-token', '', asyncStorage);
|
||||
*
|
||||
* @example
|
||||
* const { state, isReady } = await useStorageAsync('settings', { theme: 'dark' }, asyncStorage);
|
||||
*
|
||||
* @example
|
||||
* const { state } = useStorageAsync('key', 'default', asyncStorage, {
|
||||
* onReady: (value) => console.log('Loaded:', value),
|
||||
* });
|
||||
*
|
||||
* @since 0.0.12
|
||||
*/
|
||||
export function useStorageAsync<T extends string, Shallow extends boolean = true>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;
|
||||
export function useStorageAsync<T extends number, Shallow extends boolean = true>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;
|
||||
export function useStorageAsync<T extends boolean, Shallow extends boolean = true>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;
|
||||
export function useStorageAsync<T, Shallow extends boolean = true>(key: string, initialValue: MaybeRefOrGetter<T>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;
|
||||
export function useStorageAsync<T = unknown, Shallow extends boolean = true>(key: string, initialValue: MaybeRefOrGetter<null>, storage: StorageLikeAsync, options?: UseStorageAsyncOptions<T, Shallow>): UseStorageAsyncReturn<T, Shallow>;
|
||||
export function useStorageAsync<T, Shallow extends boolean = true>(
|
||||
key: string,
|
||||
initialValue: MaybeRefOrGetter<T>,
|
||||
storage: StorageLikeAsync,
|
||||
options: UseStorageAsyncOptions<T, Shallow> = {},
|
||||
): UseStorageAsyncReturn<T, Shallow> {
|
||||
const {
|
||||
shallow = true,
|
||||
deep = true,
|
||||
flush = 'pre',
|
||||
writeDefaults = true,
|
||||
mergeDefaults = false,
|
||||
onReady,
|
||||
onError = console.error, // eslint-disable-line no-console
|
||||
} = options;
|
||||
|
||||
const defaults = toValue(initialValue);
|
||||
const serializer = options.serializer ?? guessSerializer(defaults);
|
||||
|
||||
const state = (shallow ? shallowRef : ref)(defaults) as Shallow extends true ? ShallowRef<T> : Ref<UnwrapRef<T>>;
|
||||
const isReady = ref(false);
|
||||
|
||||
async function read(): Promise<T> {
|
||||
try {
|
||||
const raw = await storage.getItem(key);
|
||||
|
||||
if (raw === undefined || raw === null) {
|
||||
if (writeDefaults && defaults !== undefined && defaults !== null) {
|
||||
try {
|
||||
await storage.setItem(key, await serializer.write(defaults));
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
}
|
||||
}
|
||||
|
||||
return defaults;
|
||||
}
|
||||
|
||||
let value: T = await serializer.read(raw) as T;
|
||||
|
||||
if (mergeDefaults) {
|
||||
value = typeof mergeDefaults === 'function'
|
||||
? mergeDefaults(value, defaults)
|
||||
: shallowMerge(value, defaults);
|
||||
}
|
||||
|
||||
return value;
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
return defaults;
|
||||
}
|
||||
}
|
||||
|
||||
async function write(value: T) {
|
||||
try {
|
||||
if (value === undefined || value === null) {
|
||||
await storage.removeItem(key);
|
||||
} else {
|
||||
const raw = await serializer.write(value);
|
||||
await storage.setItem(key, raw);
|
||||
}
|
||||
} catch (e) {
|
||||
onError(e);
|
||||
}
|
||||
}
|
||||
|
||||
let stopWatch: (() => void) | null = null;
|
||||
|
||||
tryOnScopeDispose(() => stopWatch?.());
|
||||
|
||||
const shell: UseStorageAsyncReturnBase<T, Shallow> = {
|
||||
state,
|
||||
isReady,
|
||||
};
|
||||
|
||||
const readyPromise: Promise<UseStorageAsyncReturnBase<T, Shallow>> = read().then((value) => {
|
||||
(state as Ref).value = value;
|
||||
isReady.value = true;
|
||||
onReady?.(value);
|
||||
|
||||
// Set up watcher AFTER initial state is set — avoids write-back on init
|
||||
const stop = watch(state, (newValue) => {
|
||||
write(newValue as T);
|
||||
}, { flush, deep });
|
||||
|
||||
stopWatch = stop;
|
||||
|
||||
return shell;
|
||||
});
|
||||
|
||||
return {
|
||||
...shell,
|
||||
// eslint-disable-next-line unicorn/no-thenable
|
||||
then(onFulfilled, onRejected) {
|
||||
return readyPromise.then(onFulfilled, onRejected);
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -1,6 +1,5 @@
|
||||
import { onBeforeMount, nextTick } from 'vue';
|
||||
import type { ComponentInternalInstance } from 'vue';
|
||||
import { getLifeCycleTarger } from '@/utils';
|
||||
import { onBeforeMount, nextTick, type ComponentInternalInstance } from 'vue';
|
||||
import { getLifeCycleTarger } from '../..';
|
||||
import type { VoidFunction } from '@robonen/stdlib';
|
||||
|
||||
// TODO: test
|
||||
@@ -12,7 +11,7 @@ export interface TryOnBeforeMountOptions {
|
||||
|
||||
/**
|
||||
* @name tryOnBeforeMount
|
||||
* @category Lifecycle
|
||||
* @category Components
|
||||
* @description Call onBeforeMount if it's inside a component lifecycle hook, otherwise just calls it
|
||||
*
|
||||
* @param {VoidFunction} fn - The function to run on before mount.
|
||||
@@ -1,6 +1,5 @@
|
||||
import { describe, it, vi, expect } from 'vitest';
|
||||
import { defineComponent, nextTick } from 'vue';
|
||||
import type { PropType } from 'vue';
|
||||
import { defineComponent, nextTick, type PropType } from 'vue';
|
||||
import { tryOnMounted } from '.';
|
||||
import { mount } from '@vue/test-utils';
|
||||
import type { VoidFunction } from '@robonen/stdlib';
|
||||
@@ -12,12 +11,12 @@ const ComponentStub = defineComponent({
|
||||
},
|
||||
},
|
||||
setup(props) {
|
||||
if (props.callback) { tryOnMounted(props.callback); }
|
||||
props.callback && tryOnMounted(props.callback);
|
||||
},
|
||||
template: `<div></div>`,
|
||||
});
|
||||
|
||||
describe(tryOnMounted, () => {
|
||||
describe('tryOnMounted', () => {
|
||||
it('run the callback when mounted', () => {
|
||||
const callback = vi.fn();
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { onMounted, nextTick } from 'vue';
|
||||
import type { ComponentInternalInstance } from 'vue';
|
||||
import { getLifeCycleTarger } from '@/utils';
|
||||
import { onMounted, nextTick, type ComponentInternalInstance } from 'vue';
|
||||
import { getLifeCycleTarger } from '../..';
|
||||
import type { VoidFunction } from '@robonen/stdlib';
|
||||
|
||||
// TODO: tests
|
||||
@@ -12,7 +11,7 @@ export interface TryOnMountedOptions {
|
||||
|
||||
/**
|
||||
* @name tryOnMounted
|
||||
* @category Lifecycle
|
||||
* @category Components
|
||||
* @description Call onMounted if it's inside a component lifecycle hook, otherwise just calls it
|
||||
*
|
||||
* @param {VoidFunction} fn The function to call
|
||||
@@ -1,6 +1,5 @@
|
||||
import { describe, expect, it, vi } from 'vitest';
|
||||
import { defineComponent, effectScope } from 'vue';
|
||||
import type { PropType } from 'vue';
|
||||
import { defineComponent, effectScope, type PropType } from 'vue';
|
||||
import { tryOnScopeDispose } from '.';
|
||||
import { mount } from '@vue/test-utils';
|
||||
import type { VoidFunction } from '@robonen/stdlib';
|
||||
@@ -18,12 +17,12 @@ const ComponentStub = defineComponent({
|
||||
template: '<div></div>',
|
||||
});
|
||||
|
||||
describe(tryOnScopeDispose, () => {
|
||||
describe('tryOnScopeDispose', () => {
|
||||
it('returns false when the scope is not active', () => {
|
||||
const callback = vi.fn();
|
||||
const detectedScope = tryOnScopeDispose(callback);
|
||||
|
||||
expect(detectedScope).toBeFalsy();
|
||||
expect(detectedScope).toBe(false);
|
||||
expect(callback).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
@@ -36,7 +35,7 @@ describe(tryOnScopeDispose, () => {
|
||||
detectedScope = tryOnScopeDispose(callback);
|
||||
});
|
||||
|
||||
expect(detectedScope).toBeTruthy();
|
||||
expect(detectedScope).toBe(true);
|
||||
expect(callback).not.toHaveBeenCalled();
|
||||
|
||||
scope.stop();
|
||||
@@ -3,7 +3,7 @@ import { getCurrentScope, onScopeDispose } from 'vue';
|
||||
|
||||
/**
|
||||
* @name tryOnScopeDispose
|
||||
* @category Lifecycle
|
||||
* @category Components
|
||||
* @description A composable that will run a callback when the scope is disposed or do nothing if the scope isn't available.
|
||||
*
|
||||
* @param {VoidFunction} callback - The callback to run when the scope is disposed.
|
||||
@@ -3,7 +3,7 @@ import { computed, defineComponent, nextTick, ref, shallowRef } from 'vue';
|
||||
import { mount } from '@vue/test-utils'
|
||||
import { unrefElement } from '.';
|
||||
|
||||
describe(unrefElement, () => {
|
||||
describe('unrefElement', () => {
|
||||
it('returns a plain element when passed a raw element', () => {
|
||||
const htmlEl = document.createElement('div');
|
||||
const svgEl = document.createElementNS('http://www.w3.org/2000/svg', 'svg');
|
||||
@@ -47,14 +47,14 @@ describe(unrefElement, () => {
|
||||
const result = unrefElement(childInstance);
|
||||
|
||||
expect(result).toBe(childInstance.$el);
|
||||
expect((result as HTMLElement).classList.contains('child-el')).toBeTruthy();
|
||||
expect((result as HTMLElement).classList.contains('child-el')).toBe(true);
|
||||
});
|
||||
|
||||
it('handles null and undefined values', () => {
|
||||
expect(unrefElement(undefined)).toBe(undefined);
|
||||
expect(unrefElement(null)).toBe(null);
|
||||
expect(unrefElement(ref<null>(null))).toBe(null);
|
||||
expect(unrefElement(ref<undefined>(undefined))).toBe(undefined);
|
||||
expect(unrefElement(ref(null))).toBe(null);
|
||||
expect(unrefElement(ref(undefined))).toBe(undefined);
|
||||
expect(unrefElement(() => null)).toBe(null);
|
||||
expect(unrefElement(() => undefined)).toBe(undefined);
|
||||
});
|
||||
@@ -11,7 +11,7 @@ export type UnRefElementReturn<T extends MaybeElement = MaybeElement> = T extend
|
||||
|
||||
/**
|
||||
* @name unrefElement
|
||||
* @category Component
|
||||
* @category Components
|
||||
* @description Unwraps a Vue element reference to get the underlying instance or DOM element.
|
||||
*
|
||||
* @param {MaybeComputedElementRef<El>} elRef - The element reference to unwrap.
|
||||
@@ -2,7 +2,7 @@ import { describe, it, vi, expect } from 'vitest';
|
||||
import { ref, reactive } from 'vue';
|
||||
import { useAppSharedState } from '.';
|
||||
|
||||
describe(useAppSharedState, () => {
|
||||
describe('useAppSharedState', () => {
|
||||
it('initialize state only once', () => {
|
||||
const stateFactory = (initValue?: number) => {
|
||||
const count = ref(initValue ?? 0);
|
||||
@@ -2,7 +2,7 @@ import { isShallow, nextTick, ref } from 'vue';
|
||||
import { it, expect, describe, vi, beforeEach, afterEach } from 'vitest';
|
||||
import { useAsyncState } from '.';
|
||||
|
||||
describe(useAsyncState, () => {
|
||||
describe('useAsyncState', () => {
|
||||
beforeEach(() => {
|
||||
vi.useFakeTimers();
|
||||
});
|
||||
@@ -18,15 +18,15 @@ describe(useAsyncState, () => {
|
||||
);
|
||||
|
||||
expect(state.value).toBe('initial');
|
||||
expect(isReady.value).toBeFalsy();
|
||||
expect(isLoading.value).toBeTruthy();
|
||||
expect(isReady.value).toBe(false);
|
||||
expect(isLoading.value).toBe(true);
|
||||
expect(error.value).toBe(null);
|
||||
|
||||
await nextTick();
|
||||
|
||||
expect(state.value).toBe('data');
|
||||
expect(isReady.value).toBeTruthy();
|
||||
expect(isLoading.value).toBeFalsy();
|
||||
expect(isReady.value).toBe(true);
|
||||
expect(isLoading.value).toBe(false);
|
||||
expect(error.value).toBe(null);
|
||||
});
|
||||
|
||||
@@ -37,15 +37,15 @@ describe(useAsyncState, () => {
|
||||
);
|
||||
|
||||
expect(state.value).toBe('initial');
|
||||
expect(isReady.value).toBeFalsy();
|
||||
expect(isLoading.value).toBeTruthy();
|
||||
expect(isReady.value).toBe(false);
|
||||
expect(isLoading.value).toBe(true);
|
||||
expect(error.value).toBe(null);
|
||||
|
||||
await nextTick();
|
||||
|
||||
expect(state.value).toBe('data');
|
||||
expect(isReady.value).toBeTruthy();
|
||||
expect(isLoading.value).toBeFalsy();
|
||||
expect(isReady.value).toBe(true);
|
||||
expect(isLoading.value).toBe(false);
|
||||
expect(error.value).toBe(null);
|
||||
});
|
||||
|
||||
@@ -56,15 +56,15 @@ describe(useAsyncState, () => {
|
||||
);
|
||||
|
||||
expect(state.value).toBe('initial');
|
||||
expect(isReady.value).toBeFalsy();
|
||||
expect(isLoading.value).toBeTruthy();
|
||||
expect(isReady.value).toBe(false);
|
||||
expect(isLoading.value).toBe(true);
|
||||
expect(error.value).toBe(null);
|
||||
|
||||
await nextTick();
|
||||
|
||||
expect(state.value).toBe('initial');
|
||||
expect(isReady.value).toBeFalsy();
|
||||
expect(isLoading.value).toBeFalsy();
|
||||
expect(isReady.value).toBe(false);
|
||||
expect(isLoading.value).toBe(false);
|
||||
expect(error.value).toEqual(new Error('test-error'));
|
||||
});
|
||||
|
||||
@@ -131,14 +131,14 @@ describe(useAsyncState, () => {
|
||||
);
|
||||
|
||||
const promise = execute();
|
||||
expect(isLoading.value).toBeTruthy();
|
||||
expect(isLoading.value).toBe(true);
|
||||
|
||||
await vi.advanceTimersByTimeAsync(50);
|
||||
expect(isLoading.value).toBeTruthy();
|
||||
expect(isLoading.value).toBe(true);
|
||||
|
||||
await vi.advanceTimersByTimeAsync(50);
|
||||
await promise;
|
||||
expect(isLoading.value).toBeFalsy();
|
||||
expect(isLoading.value).toBe(false);
|
||||
});
|
||||
|
||||
it('is awaitable', async () => {
|
||||
@@ -160,15 +160,15 @@ describe(useAsyncState, () => {
|
||||
executeImmediately();
|
||||
|
||||
expect(state.value).toBe('initial');
|
||||
expect(isLoading.value).toBeTruthy();
|
||||
expect(isReady.value).toBeFalsy();
|
||||
expect(isLoading.value).toBe(true);
|
||||
expect(isReady.value).toBe(false);
|
||||
expect(error.value).toBe(null);
|
||||
|
||||
await nextTick();
|
||||
|
||||
expect(state.value).toBe('data');
|
||||
expect(isReady.value).toBeTruthy();
|
||||
expect(isLoading.value).toBeFalsy();
|
||||
expect(isReady.value).toBe(true);
|
||||
expect(isLoading.value).toBe(false);
|
||||
expect(error.value).toBe(null);
|
||||
});
|
||||
|
||||
@@ -193,7 +193,7 @@ describe(useAsyncState, () => {
|
||||
);
|
||||
|
||||
expect(state.value.a).toBe(1);
|
||||
expect(isShallow(state)).toBeTruthy();
|
||||
expect(isShallow(state)).toBe(true);
|
||||
});
|
||||
|
||||
it('uses ref when shallow is false', async () => {
|
||||
@@ -204,6 +204,6 @@ describe(useAsyncState, () => {
|
||||
);
|
||||
|
||||
expect(state.value.a).toBe(1);
|
||||
expect(isShallow(state)).toBeFalsy();
|
||||
expect(isShallow(state)).toBe(false);
|
||||
});
|
||||
});
|
||||
@@ -1,5 +1,4 @@
|
||||
import { ref, shallowRef, watch } from 'vue';
|
||||
import type { Ref, ShallowRef, UnwrapRef } from 'vue';
|
||||
import { ref, shallowRef, watch, type Ref, type ShallowRef, type UnwrapRef } from 'vue';
|
||||
import { isFunction, sleep } from '@robonen/stdlib';
|
||||
|
||||
export interface UseAsyncStateOptions<Shallow extends boolean, Data = any> {
|
||||
@@ -104,12 +103,8 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
||||
watch(
|
||||
isLoading,
|
||||
(loading) => {
|
||||
if (loading === false) {
|
||||
if (error.value)
|
||||
reject(error.value);
|
||||
else
|
||||
resolve(shell);
|
||||
}
|
||||
if (loading === false)
|
||||
error.value ? reject(error.value) : resolve(shell);
|
||||
},
|
||||
{
|
||||
immediate: true,
|
||||
@@ -122,7 +117,6 @@ export function useAsyncState<Data, Params extends any[] = [], Shallow extends b
|
||||
|
||||
return {
|
||||
...shell,
|
||||
// eslint-disable-next-line unicorn/no-thenable
|
||||
then(onFulfilled, onRejected) {
|
||||
return waitResolve().then(onFulfilled, onRejected);
|
||||
},
|
||||
@@ -4,7 +4,7 @@ import { useCached } from '.';
|
||||
|
||||
const arrayEquals = (a: number[], b: number[]) => a.length === b.length && a.every((v, i) => v === b[i]);
|
||||
|
||||
describe(useCached, () => {
|
||||
describe('useCached', () => {
|
||||
it('default comparator', async () => {
|
||||
const externalValue = ref(0);
|
||||
const cachedValue = useCached(externalValue);
|
||||
@@ -1,5 +1,4 @@
|
||||
import { ref, watch, toValue } from 'vue';
|
||||
import type { MaybeRefOrGetter, Ref, WatchOptions } from 'vue';
|
||||
import { ref, watch, toValue, type MaybeRefOrGetter, type Ref, type WatchOptions } from 'vue';
|
||||
|
||||
export type Comparator<Value> = (a: Value, b: Value) => boolean;
|
||||
|
||||
@@ -2,7 +2,7 @@ import { ref, readonly, computed } from 'vue';
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { useClamp } from '.';
|
||||
|
||||
describe(useClamp, () => {
|
||||
describe('useClamp', () => {
|
||||
it('non-reactive values should be clamped', () => {
|
||||
const clampedValue = useClamp(10, 0, 5);
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { clamp, isFunction } from '@robonen/stdlib';
|
||||
import { computed, isReadonly, ref, toValue } from 'vue';
|
||||
import type { ComputedRef, MaybeRef, MaybeRefOrGetter, WritableComputedRef } from 'vue';
|
||||
import { computed, isReadonly, ref, toValue, type ComputedRef, type MaybeRef, type MaybeRefOrGetter, type WritableComputedRef } from 'vue';
|
||||
|
||||
/**
|
||||
* @name useClamp
|
||||
@@ -2,7 +2,7 @@ import { describe, it, expect } from 'vitest';
|
||||
import { defineComponent } from 'vue';
|
||||
import { useContextFactory } from '.';
|
||||
import { mount } from '@vue/test-utils';
|
||||
import { VueToolsError } from '@/utils';
|
||||
import { VueToolsError } from '../../utils';
|
||||
|
||||
function testFactory<Data>(
|
||||
data: Data,
|
||||
@@ -35,7 +35,7 @@ function testFactory<Data>(
|
||||
|
||||
// TODO: maybe replace template with passing mock functions to setup
|
||||
|
||||
describe(useContextFactory, () => {
|
||||
describe('useContextFactory', () => {
|
||||
it('provide and inject context correctly', () => {
|
||||
const { Parent } = testFactory('test', useContextFactory('TestContext'));
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
import { inject as vueInject, provide as vueProvide } from 'vue';
|
||||
import type { InjectionKey, App } from 'vue';
|
||||
import { VueToolsError } from '@/utils';
|
||||
import { inject as vueInject, provide as vueProvide, type InjectionKey, type App } from 'vue';
|
||||
import { VueToolsError } from '../..';
|
||||
|
||||
/**
|
||||
* @name useContextFactory
|
||||
@@ -2,7 +2,7 @@ import { it, expect, describe } from 'vitest';
|
||||
import { ref } from 'vue';
|
||||
import { useCounter } from '.';
|
||||
|
||||
describe(useCounter, () => {
|
||||
describe('useCounter', () => {
|
||||
it('initialize count with the provided initial value', () => {
|
||||
const { count } = useCounter(5);
|
||||
expect(count.value).toBe(5);
|
||||
@@ -1,5 +1,4 @@
|
||||
import { ref, toValue } from 'vue';
|
||||
import type { MaybeRefOrGetter, Ref } from 'vue';
|
||||
import { ref, toValue, type MaybeRefOrGetter, type Ref } from 'vue';
|
||||
import { clamp } from '@robonen/stdlib';
|
||||
|
||||
export interface UseCounterOptions {
|
||||
@@ -18,7 +17,7 @@ export interface UseConterReturn {
|
||||
|
||||
/**
|
||||
* @name useCounter
|
||||
* @category State
|
||||
* @category Utilities
|
||||
* @description A composable that provides a counter with increment, decrement, set, get, and reset functions
|
||||
*
|
||||
* @param {MaybeRef<number>} [initialValue=0] The initial value of the counter
|
||||
@@ -47,17 +46,14 @@ export function useCounter(
|
||||
max = Number.MAX_SAFE_INTEGER,
|
||||
} = options;
|
||||
|
||||
const increment = (delta = 1) => {
|
||||
const increment = (delta = 1) =>
|
||||
count.value = clamp(count.value + delta, min, max);
|
||||
};
|
||||
|
||||
const decrement = (delta = 1) => {
|
||||
const decrement = (delta = 1) =>
|
||||
count.value = clamp(count.value - delta, min, max);
|
||||
};
|
||||
|
||||
const set = (value: number) => {
|
||||
const set = (value: number) =>
|
||||
count.value = clamp(value, min, max);
|
||||
};
|
||||
|
||||
const get = () => count.value;
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
import { isArray, isString, noop } from '@robonen/stdlib';
|
||||
import type { Arrayable, VoidFunction } from '@robonen/stdlib';
|
||||
import { isArray, isString, noop, type Arrayable, type VoidFunction } from '@robonen/stdlib';
|
||||
import type { MaybeRefOrGetter } from 'vue';
|
||||
import { defaultWindow } from '@/types';
|
||||
import { defaultWindow } from '../..';
|
||||
|
||||
// TODO: wip
|
||||
|
||||
@@ -10,7 +9,9 @@ interface InferEventTarget<Events> {
|
||||
removeEventListener: (event: Events, listener?: any, options?: any) => any;
|
||||
}
|
||||
|
||||
export type GeneralEventListener<E = Event> = (evt: E) => void;
|
||||
export interface GeneralEventListener<E = Event> {
|
||||
(evt: E): void;
|
||||
}
|
||||
|
||||
export type WindowEventName = keyof WindowEventMap;
|
||||
export type DocumentEventName = keyof DocumentEventMap;
|
||||
@@ -18,7 +19,7 @@ export type ElementEventName = keyof HTMLElementEventMap;
|
||||
|
||||
/**
|
||||
* @name useEventListener
|
||||
* @category Browser
|
||||
* @category Elements
|
||||
* @description Registers an event listener using the `addEventListener` on mounted and removes it automatically on unmounted
|
||||
*
|
||||
* Overload 1: Omitted window target
|
||||
@@ -31,7 +32,7 @@ export function useEventListener<E extends WindowEventName>(
|
||||
|
||||
/**
|
||||
* @name useEventListener
|
||||
* @category Browser
|
||||
* @category Elements
|
||||
* @description Registers an event listener using the `addEventListener` on mounted and removes it automatically on unmounted
|
||||
*
|
||||
* Overload 2: Explicit window target
|
||||
@@ -45,7 +46,7 @@ export function useEventListener<E extends WindowEventName>(
|
||||
|
||||
/**
|
||||
* @name useEventListener
|
||||
* @category Browser
|
||||
* @category Elements
|
||||
* @description Registers an event listener using the `addEventListener` on mounted and removes it automatically on unmounted
|
||||
*
|
||||
* Overload 3: Explicit document target
|
||||
@@ -59,7 +60,7 @@ export function useEventListener<E extends DocumentEventName>(
|
||||
|
||||
/**
|
||||
* @name useEventListener
|
||||
* @category Browser
|
||||
* @category Elements
|
||||
* @description Registers an event listener using the `addEventListener` on mounted and removes it automatically on unmounted
|
||||
*
|
||||
* Overload 4: Explicit HTMLElement target
|
||||
@@ -73,7 +74,7 @@ export function useEventListener<E extends ElementEventName>(
|
||||
|
||||
/**
|
||||
* @name useEventListener
|
||||
* @category Browser
|
||||
* @category Elements
|
||||
* @description Registers an event listener using the `addEventListener` on mounted and removes it automatically on unmounted
|
||||
*
|
||||
* Overload 5: Custom target with inferred event type
|
||||
@@ -83,11 +84,11 @@ export function useEventListener<Names extends string, EventType = Event>(
|
||||
event: Arrayable<Names>,
|
||||
listener: Arrayable<GeneralEventListener<EventType>>,
|
||||
options?: MaybeRefOrGetter<boolean | AddEventListenerOptions>
|
||||
): VoidFunction;
|
||||
)
|
||||
|
||||
/**
|
||||
* @name useEventListener
|
||||
* @category Browser
|
||||
* @category Elements
|
||||
* @description Registers an event listener using the `addEventListener` on mounted and removes it automatically on unmounted
|
||||
*
|
||||
* Overload 6: Custom event target fallback
|
||||
@@ -103,13 +104,13 @@ export function useEventListener(...args: any[]) {
|
||||
let target: MaybeRefOrGetter<EventTarget> | undefined;
|
||||
let events: Arrayable<string>;
|
||||
let listeners: Arrayable<Function>;
|
||||
let _options: MaybeRefOrGetter<boolean | AddEventListenerOptions> | undefined;
|
||||
let options: MaybeRefOrGetter<boolean | AddEventListenerOptions> | undefined;
|
||||
|
||||
if (isString(args[0]) || isArray(args[0])) {
|
||||
[events, listeners, _options] = args;
|
||||
[events, listeners, options] = args;
|
||||
target = defaultWindow;
|
||||
} else {
|
||||
[target, events, listeners, _options] = args;
|
||||
[target, events, listeners, options] = args;
|
||||
}
|
||||
|
||||
if (!target)
|
||||
@@ -123,16 +124,13 @@ export function useEventListener(...args: any[]) {
|
||||
|
||||
const cleanups: Function[] = [];
|
||||
|
||||
const _cleanup = () => {
|
||||
const cleanup = () => {
|
||||
cleanups.forEach(fn => fn());
|
||||
cleanups.length = 0;
|
||||
}
|
||||
|
||||
const _register = (el: any, event: string, listener: any, options: any) => {
|
||||
const register = (el: any, event: string, listener: any, options: any) => {
|
||||
el.addEventListener(event, listener, options);
|
||||
return () => el.removeEventListener(event, listener, options);
|
||||
}
|
||||
|
||||
void _cleanup;
|
||||
void _register;
|
||||
}
|
||||
@@ -17,7 +17,7 @@ const setupFocusGuard = (namespace?: string) => {
|
||||
const getFocusGuards = (namespace: string) =>
|
||||
document.querySelectorAll(`[data-${namespace}]`);
|
||||
|
||||
describe(useFocusGuard, () => {
|
||||
describe('useFocusGuard', () => {
|
||||
let component: ReturnType<typeof setupFocusGuard>;
|
||||
const namespace = 'test-guard';
|
||||
|
||||
@@ -33,7 +33,7 @@ describe(useFocusGuard, () => {
|
||||
component = setupFocusGuard(namespace);
|
||||
|
||||
const guards = getFocusGuards(namespace);
|
||||
expect(guards).toHaveLength(2);
|
||||
expect(guards.length).toBe(2);
|
||||
|
||||
guards.forEach((guard) => {
|
||||
expect(guard.getAttribute('tabindex')).toBe('0');
|
||||
@@ -46,7 +46,7 @@ describe(useFocusGuard, () => {
|
||||
|
||||
component.unmount();
|
||||
|
||||
expect(getFocusGuards(namespace)).toHaveLength(0);
|
||||
expect(getFocusGuards(namespace).length).toBe(0);
|
||||
});
|
||||
|
||||
it('correctly manage multiple instances with the same namespace', () => {
|
||||
@@ -54,16 +54,16 @@ describe(useFocusGuard, () => {
|
||||
const wrapper2 = setupFocusGuard(namespace);
|
||||
|
||||
// Guards should not be duplicated
|
||||
expect(getFocusGuards(namespace)).toHaveLength(2);
|
||||
expect(getFocusGuards(namespace).length).toBe(2);
|
||||
|
||||
wrapper1.unmount();
|
||||
|
||||
// Second instance still keeps the guards
|
||||
expect(getFocusGuards(namespace)).toHaveLength(2);
|
||||
expect(getFocusGuards(namespace).length).toBe(2);
|
||||
|
||||
wrapper2.unmount();
|
||||
|
||||
// No guards left after all instances are unmounted
|
||||
expect(getFocusGuards(namespace)).toHaveLength(0);
|
||||
expect(getFocusGuards(namespace).length).toBe(0);
|
||||
});
|
||||
});
|
||||
@@ -6,7 +6,7 @@ let counter = 0;
|
||||
|
||||
/**
|
||||
* @name useFocusGuard
|
||||
* @category Browser
|
||||
* @category Utilities
|
||||
* @description Adds a pair of focus guards at the boundaries of the DOM tree to ensure consistent focus behavior
|
||||
*
|
||||
* @param {string} [namespace] - A namespace to group the focus guards
|
||||
@@ -1,5 +1,5 @@
|
||||
import { useContextFactory } from '../useContextFactory';
|
||||
import type { App } from 'vue';
|
||||
import type { App, InjectionKey } from 'vue';
|
||||
|
||||
export interface useInjectionStoreOptions<Return> {
|
||||
injectionName?: string;
|
||||
@@ -3,7 +3,7 @@ import { describe, it, expect } from 'vitest';
|
||||
import { useLastChanged } from '.';
|
||||
import { timestamp } from '@robonen/stdlib';
|
||||
|
||||
describe(useLastChanged, () => {
|
||||
describe('useLastChanged', () => {
|
||||
it('initialize with null if no initialValue is provided', () => {
|
||||
const source = ref(0);
|
||||
const lastChanged = useLastChanged(source);
|
||||
@@ -1,6 +1,5 @@
|
||||
import { timestamp } from '@robonen/stdlib';
|
||||
import { ref, watch } from 'vue';
|
||||
import type { WatchSource, WatchOptions, Ref } from 'vue';
|
||||
import { ref, watch, type WatchSource, type WatchOptions, type Ref } from 'vue';
|
||||
|
||||
export interface UseLastChangedOptions<
|
||||
Immediate extends boolean,
|
||||
@@ -11,7 +10,7 @@ export interface UseLastChangedOptions<
|
||||
|
||||
/**
|
||||
* @name useLastChanged
|
||||
* @category Reactivity
|
||||
* @category State
|
||||
* @description Records the last time a value changed
|
||||
*
|
||||
* @param {WatchSource} source The value to track
|
||||
@@ -33,7 +32,7 @@ export function useLastChanged(source: WatchSource, options: UseLastChangedOptio
|
||||
export function useLastChanged(source: WatchSource, options: UseLastChangedOptions<boolean, any> = {}): Ref<number | null> | Ref<number> {
|
||||
const lastChanged = ref<number | null>(options.initialValue ?? null);
|
||||
|
||||
watch(source, () => { lastChanged.value = timestamp(); }, options);
|
||||
watch(source, () => lastChanged.value = timestamp(), options);
|
||||
|
||||
return lastChanged;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user