mirror of
https://github.com/kucherenko/jscpd.git
synced 2026-09-19 08:11:03 +08:00
apk
64e471e2b0
Adds 92 new tests (178 → 270 total) with zero source-file modifications: - packages/finder: 13 new test files covering all reporters, subscribers, validators, hooks, utils, options, cloneFound, getFilesToDetect, and InFilesDetector; shared buildClone() factory helper - apps/jscpd: 3 new test files (options-unit, print, store) plus extensions to formats, modes, and options integration tests - vitest.config.ts added to both packages to restrict coverage.include to src/** only, eliminating bin/ and prism.js noise - Fixes 3 tokenizer bugs (trailing space in format lookup, tokenization edge cases) uncovered by the new format fixture suite - Adds fixture files for 40+ language formats to support formats.test.ts
54 lines
1.4 KiB
Plaintext
54 lines
1.4 KiB
Plaintext
h1. Application Documentation
|
|
|
|
h2. Overview
|
|
|
|
This application provides *data processing* utilities for managing items and configurations.
|
|
|
|
h2. Features
|
|
|
|
* Validate input strings with length constraints
|
|
* Parse configuration objects with default values
|
|
* Retry failed operations with configurable attempt limits
|
|
* Filter and transform data collections efficiently
|
|
|
|
h2. API Reference
|
|
|
|
h3. validateInput(value)
|
|
|
|
Validates a string value. Rules:
|
|
|
|
* Must not be @null@ or empty
|
|
* Must not exceed *255 characters*
|
|
* Returns the trimmed value on success
|
|
|
|
h3. parseConfig(config)
|
|
|
|
Parses a configuration object with sensible defaults:
|
|
|
|
|_. Property |_. Default |_. Description |
|
|
| host | localhost | Server hostname |
|
|
| port | 3000 | Server port |
|
|
| debug | false | Debug mode flag |
|
|
| timeout | 30000 | Request timeout in ms |
|
|
|
|
h3. retryOnFailure(maxAttempts, fn)
|
|
|
|
Retries a function up to @maxAttempts@ times on failure.
|
|
|
|
h2. Installation
|
|
|
|
bc. npm install myapp-utils
|
|
|
|
h2. Usage
|
|
|
|
bc.. import { validateInput, parseConfig } from 'myapp-utils'
|
|
|
|
const config = parseConfig({ host: 'api.example.com', port: 8080 })
|
|
const name = validateInput(' Alice ')
|
|
|
|
p. For more details see the "full docs":http://example.com/docs
|
|
|
|
h2. Administrator Guide
|
|
|
|
This section covers administrative tasks and server configuration.
|