pure-md5 0.2.0 → 0.2.2

package/planning/03-optimization-size-tree-shaking/07-multiple-build-formats.md

@@ -1,228 +0,0 @@
-# Задача 7: Анализ бандла и метрики
-
-## Контекст
-
-После настройки tsup и создания разных сборок (Задачи 1 и 6) необходимо измерить и проанализировать результаты оптимизаций. Без количественных метрик невозможно оценить эффективность проделанной работы.
-
-## Цель
-
-Создать систему для измерения и анализа:
-
-1. Размера бандла до/после оптимизаций
-2. Эффективности tree-shaking
-3. Производительности MD5 реализации
-4. Качества TypeScript типов
-
-## Требуемые действия
-
-### Шаг 1: Установить инструменты для анализа
-
-1. Установить инструменты для анализа бандла и типов:
-   ```bash
-   npm install -D @arethetypeswrong/cli bundlewatch
-   ```
-2. Установить инструменты для бенчмарков:
-   ```bash
-   npm install -D benchmark microtime
-   ```
-
-### Шаг 2: Создать скрипты для анализа размера
-
-1. Создать `scripts/analyze-size.js`:
-
-   ```javascript
-   // scripts/analyze-size.js
-   import fs from 'fs';
-   import { gzipSync } from 'zlib';
-   import { brotliCompressSync } from 'zlib';
-
-   const files = [
-     'dist/index.js',
-     'dist/index.mjs',
-     'dist/index.min.js',
-     'dist/index.browser.js'
-   ];
-
-   console.log('=== Bundle Size Analysis ===\n');
-
-   files.forEach((file) => {
-     if (fs.existsSync(file)) {
-       const content = fs.readFileSync(file);
-       const rawSize = content.length;
-       const gzippedSize = gzipSync(content).length;
-       const brotliSize = brotliCompressSync(content).length;
-
-       console.log(`${file}:`);
-       console.log(`  Raw: ${(rawSize / 1024).toFixed(2)} KB`);
-       console.log(`  Gzipped: ${(gzippedSize / 1024).toFixed(2)} KB`);
-       console.log(`  Brotli: ${(brotliSize / 1024).toFixed(2)} KB`);
-       console.log(
-         `  Gzip reduction: ${((1 - gzippedSize / rawSize) * 100).toFixed(1)}%`
-       );
-       console.log();
-     }
-   });
-   ```
-
-### Шаг 3: Создать бенчмарки производительности
-
-1. Создать `benchmarks/performance.js`:
-
-   ```javascript
-   // benchmarks/performance.js
-   import { md5 } from '../dist/index.mjs';
-   import Benchmark from 'benchmark';
-
-   const suite = new Benchmark.Suite('MD5 Performance');
-
-   // Тестовые данные
-   const testCases = [
-     { name: 'Short string (10 chars)', data: 'Hello World' },
-     { name: 'Medium string (100 chars)', data: 'x'.repeat(100) },
-     { name: 'Long string (1000 chars)', data: 'x'.repeat(1000) },
-     { name: 'Binary data (1KB)', data: Buffer.alloc(1024, 'x').toString() }
-   ];
-
-   testCases.forEach(({ name, data }) => {
-     suite.add(name, () => {
-       md5(data);
-     });
-   });
-
-   suite
-     .on('cycle', (event) => {
-       console.log(String(event.target));
-     })
-     .on('complete', function () {
-       console.log('\nFastest is: ' + this.filter('fastest').map('name'));
-     })
-     .run({ async: true });
-   ```
-
-### Шаг 4: Проверить качество TypeScript типов
-
-1. Добавить скрипт для проверки типов:
-   ```json
-   "scripts": {
-     "check-types": "tsc --noEmit",
-     "check-exports": "attw --pack ."
-   }
-   ```
-2. Создать `scripts/check-exports.js` для проверки exports
-
-### Шаг 5: Создать метрики tree-shaking
-
-1. Создать тестовый проект для проверки tree-shaking
-2. Импортировать только `md5` функцию
-3. Собрать проект и проверить что неиспользуемый код удален
-4. Использовать `@arethetypeswrong/cli` для анализа
-
-### Шаг 6: Создать baseline измерений
-
-1. Сохранить текущие метрики (до оптимизаций):
-   ```bash
-   npm run build
-   node scripts/analyze-size.js > benchmarks/baseline-size.json
-   node benchmarks/performance.js > benchmarks/baseline-performance.json
-   ```
-2. Создать файлы с baseline данными
-
-### Шаг 7: Создать скрипт для сравнения
-
-1. Создать `scripts/compare-metrics.js`:
-
-   ```javascript
-   // scripts/compare-metrics.js
-   import fs from 'fs';
-
-   const baseline = JSON.parse(
-     fs.readFileSync('benchmarks/baseline-size.json', 'utf8')
-   );
-   const current = JSON.parse(
-     fs.readFileSync('benchmarks/current-size.json', 'utf8')
-   );
-
-   console.log('=== Size Comparison (Before vs After) ===\n');
-
-   Object.keys(baseline).forEach((file) => {
-     if (current[file]) {
-       const baselineSize = baseline[file].raw;
-       const currentSize = current[file].raw;
-       const change = (
-         ((currentSize - baselineSize) / baselineSize) *
-         100
-       ).toFixed(1);
-
-       console.log(`${file}:`);
-       console.log(`  Before: ${(baselineSize / 1024).toFixed(2)} KB`);
-       console.log(`  After:  ${(currentSize / 1024).toFixed(2)} KB`);
-       console.log(`  Change: ${change}%`);
-       console.log();
-     }
-   });
-   ```
-
-### Шаг 8: Интегрировать в CI/CD
-
-1. Обновить GitHub Actions workflow:
-   ```yaml
-   # .github/workflows/ci.yml
-   jobs:
-     analyze:
-       runs-on: ubuntu-latest
-       steps:
-         - uses: actions/checkout@v3
-         - uses: actions/setup-node@v3
-         - run: npm ci
-         - run: npm run build
-         - run: npm run analyze-size
-         - run: npm run check-types
-         - run: npm run check-exports
-   ```
-2. Добавить проверки на регрессии
-
-### Шаг 9: Документировать результаты
-
-1. Создать `BENCHMARKS.md` в корне проекта
-2. Задокументировать методологию измерений
-3. Привести результаты до/после оптимизаций
-4. Сделать выводы об эффективности
-
-## Ожидаемый результат
-
-- Полная система метрик и анализа
-- Измерения размера бандла до/после
-- Измерения производительности до/после
-- Проверка качества TypeScript типов
-- Интеграция в CI/CD
-- Документация результатов
-
-## Проверка прогресса
-
-- [ ] Установлены инструменты для анализа
-- [ ] Созданы скрипты для анализа размера
-- [ ] Созданы бенчмарки производительности
-- [ ] Настроена проверка TypeScript типов
-- [ ] Созданы метрики tree-shaking
-- [ ] Создан baseline измерений
-- [ ] Создан скрипт для сравнения
-- [ ] Интегрировано в CI/CD
-- [ ] Документированы результаты
-
-## Примечания
-
-1. Измерения должны быть воспроизводимыми
-2. Учитывать variance в измерениях производительности
-3. Проводить multiple runs для статистической значимости
-4. Сохранять историю измерений для tracking
-
-## Метрики успеха
-
-1. Уменьшение размера бандла на 20-30%
-2. Улучшение производительности на 10-20%
-3. Эффективное tree-shaking
-4. Качественные TypeScript типы (no errors)
-
-## Следующий шаг
-
-После настройки системы метрик перейти к Задаче 8: Обновление документации и CI/CD.

package/planning/03-optimization-size-tree-shaking/08-benchmarks-metrics.md

@@ -1,34 +0,0 @@
-# Задача 8: Бенчмарки, метрики, документация и CI/CD
-
-## Контекст
-
-После всех оптимизаций необходимо измерить и задокументировать улучшения, обновить документацию и настроить CI/CD процессы. Это обеспечит:
-
-1. Количественные метрики эффективности оптимизаций
-2. Четкие инструкции для пользователей
-3. Автоматическую проверку качества
-4. Отслеживание регрессий
-5. Профессиональную поддержку проекта
-
-## Цель
-
-Создать полную систему бенчмарков, метрик, обновить документацию и настроить CI/CD для измерения:
-
-1. Производительности до/после оптимизаций
-2. Размера бандла до/после
-3. Эффективности tree-shaking
-4. Потребления памяти
-5. Документировать и автоматизировать процессы
-
-## Требуемые действия
-
-### Шаг 1: Создать бенчмарки производительности
-
-1. Создать файл `benchmarks/performance.js`
-2. Реализовать тесты для разных сценариев:
-   - Хеширование коротких строк
-   - Хеширование длинных строк
-   - Хеширование бинарных данных
-   - Многократное хеширование
-
-**Пример бенчмарка:**

package/planning/03-optimization-size-tree-shaking/MIGRATION_GUIDE.md

@@ -1,260 +0,0 @@
-# Migration Guide to tsup
-
-## Overview
-
-This guide describes the migration process from the outdated Webpack+Babel+TypeScript stack to modern tsup.
-
-## Migration Benefits
-
-### Before migration:
-
-- Webpack 4.34.0 (2019)
-- TypeScript 3.5.2 (2019)
-- Babel for transpilation
-- 13 dev dependencies
-- Slow builds
-- Complex configuration
-
-### After migration:
-
-- tsup (modern)
-- TypeScript 5+ (latest version)
-- Native TypeScript transpilation
-- 3-5 dev dependencies
-- 10-100x faster builds
-- Minimal configuration
-
-## Step-by-Step Migration Plan
-
-### Step 0: Preparation
-
-1. Ensure all tests pass: `npm test`
-2. Create backup of current configuration
-3. Check current bundle size (baseline)
-
-### Step 1: Install tsup
-
-```bash
-# Install tsup and update TypeScript
-npm install -D tsup typescript@latest
-
-# Verify installation
-npx tsup --version
-npx tsc --version
-```
-
-### Step 2: Remove Outdated Dependencies
-
-```bash
-# Remove Webpack and Babel
-npm uninstall -D webpack webpack-cli babel-loader \
-  @babel/core @babel/preset-env @babel/preset-typescript \
-  @babel/plugin-proposal-class-properties @babel/plugin-proposal-object-rest-spread
-
-# Remove configuration files
-rm webpack.config.js .babelrc
-```
-
-### Step 3: Basic tsup Configuration
-
-Create `tsup.config.ts`:
-
-```typescript
-import { defineConfig } from 'tsup';
-
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['cjs', 'esm'],
-  dts: true,
-  sourcemap: true,
-  clean: true,
-  treeshake: true
-});
-```
-
-### Step 4: Update TypeScript Configuration
-
-Update `tsconfig.json`:
-
-```json
-{
-  "compilerOptions": {
-    "target": "es2020",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "declaration": true,
-    "outDir": "./dist",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "**/*.test.ts"]
-}
-```
-
-### Step 5: Update package.json
-
-```json
-{
-  "scripts": {
-    "build": "tsup",
-    "build:watch": "tsup --watch",
-    "dev": "tsup --watch",
-    "test": "jest"
-  },
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
-  }
-}
-```
-
-### Step 6: First Build
-
-```bash
-# First build
-npm run build
-
-# Check created files
-ls -la dist/
-
-# Check sizes
-ls -lh dist/*
-```
-
-### Step 7: Verification
-
-```bash
-# Run tests
-npm test
-
-# Check import in Node.js
-node -e "const { md5 } = require('./dist/index.js'); console.log(md5('test'))"
-
-# Check as ES module (if supported)
-node --loader ts-node/esm -e "import { md5 } from './dist/index.mjs'; console.log(md5('test'))"
-```
-
-### Step 8: Additional Configurations
-
-Create additional configurations as needed:
-
-- `tsup.config.prod.ts` - for production
-- `tsup.config.umd.ts` - for browser
-- `tsup.config.min.ts` - minimal build
-
-## Troubleshooting
-
-### Problem 1: TypeScript Errors After Update
-
-**Solution:**
-
-1. Check TypeScript breaking changes
-2. Update types gradually
-3. Use `tsc --noEmit` for verification
-
-### Problem 2: .d.ts Files Not Generated
-
-**Solution:**
-
-1. Check that `dts: true` in configuration
-2. Ensure TypeScript is properly configured
-3. Check with `@arethetypeswrong/cli`
-
-### Problem 3: Tree-Shaking Not Working
-
-**Solution:**
-
-1. Check that `treeshake: true`
-2. Ensure ES modules are used
-3. Check side effects in package.json
-
-### Problem 4: Import Errors
-
-**Solution:**
-
-1. Check exports in package.json
-2. Ensure correct paths
-3. Check compatibility with consumers
-
-## Verification Checklist
-
-- [ ] tsup installed
-- [ ] Outdated dependencies removed
-- [ ] tsup configuration created
-- [ ] TypeScript updated and configured
-- [ ] package.json updated
-- [ ] Build works
-- [ ] Tests pass
-- [ ] Import works
-- [ ] .d.ts files generated
-- [ ] Tree-shaking works
-- [ ] Bundle size reduced
-
-## Additional Optimizations
-
-### 1. Configuration for Different Formats
-
-```typescript
-// tsup.config.prod.ts
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['cjs', 'esm'],
-  dts: true,
-  sourcemap: false,
-  minify: true,
-  treeshake: true
-});
-```
-
-### 2. Browser Configuration
-
-```typescript
-// tsup.config.umd.ts
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['iife'],
-  globalName: 'pureMD5',
-  minify: true,
-  target: 'es2020',
-  platform: 'browser'
-});
-```
-
-### 3. Minimal Build
-
-```typescript
-// tsup.config.min.ts
-export default defineConfig({
-  entry: ['src/index.ts'],
-  format: ['esm'],
-  dts: false,
-  sourcemap: false,
-  minify: true,
-  treeshake: true,
-  pure: ['console.log']
-});
-```
-
-## Resources
-
-- [tsup Documentation](https://tsup.egoist.dev/)
-- [TypeScript 5 Breaking Changes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-0.html)
-- [Tree-shaking in tsup](https://tsup.egoist.dev/#tree-shaking)
-- [Configuration Examples](https://github.com/egoist/tsup/tree/main/examples)
-
-## Support
-
-If problems occur:
-
-1. Check tsup documentation
-2. Create issue in repository
-3. Contact TypeScript community

package/planning/03-optimization-size-tree-shaking/README.md

@@ -1,173 +0,0 @@
-# Phase 3: Size Optimization and Tree-Shaking Configuration
-
-## Goal
-
-Reduce bundle size, improve tree-shaking, and optimize MD5 implementation performance.
-
-## Current Analysis
-
-### Problems:
-
-1. **Outdated bundler** - Webpack 4 + Babel + TypeScript 3.5 (2019)
-2. **CommonJS modules** - poorly suited for tree-shaking in modern bundlers
-3. **Many small files** - create import overhead
-4. **Runtime check** in `index.ts` increases bundle size
-5. **Code duplication** - `add32` is defined in two places
-6. **Suboptimal loops** - performance can be improved
-
-### Metrics before optimization:
-
-- Total number of files in `src/`: 16
-- Used dependencies: 0 (pure TypeScript)
-- Current build: Webpack 4 + Babel + TypeScript 3.5 (outdated stack)
-- Dev dependencies: 13 packages (can be reduced)
-
-## Optimization Tasks
-
-### Task 1: Migration from Webpack to tsup
-
-**Goal**: Replace outdated Webpack+Babel+TypeScript stack with modern tsup for faster builds and better tree-shaking.
-**Actions:**
-
-1. Install tsup and remove outdated dependencies
-2. Configure tsup for TypeScript library builds
-3. Update TypeScript to modern version
-4. Configure .d.ts file generation
-
-**Expected result:** 10-100x faster builds, improved tree-shaking, reduced dependencies.
-**Progress:** [ ] Not started
-
----
-
-### Task 2: Consolidation of Small Modules
-
-**Goal**: Combine related functions into larger modules to reduce overhead.
-
-**Actions:**
-
-1. Combine `ff.ts`, `gg.ts`, `hh.ts`, `ii.ts` into one module `round-functions.ts`
-2. Combine `hex.ts` and `rhex.ts` (or inline rhex)
-3. Consider inlining `cmn.ts` into `md5cycle.ts`
-
-**Expected result:** Reduction of file count from 16 to ~10.
-
-**Progress:** [ ] Not started
-
----
-
-### Task 3: Elimination of Code Duplication
-
-**Goal**: Remove duplication of the `add32` function.
-
-**Actions:**
-
-1. Remove inline definition of `add32` from `index.ts`
-2. Ensure import from `add32.ts` is used everywhere
-3. Optimize `add32` implementation for performance
-
-**Expected result:** Single implementation of `add32`.
-
-**Progress:** [ ] Not started
-
----
-
-### Task 4: Moving Runtime Check to Compile-Time
-
-**Goal**: Remove `hex(md51('hello'))` check from runtime.
-
-**Actions:**
-
-1. Create a test to verify MD5 correctness
-2. Remove runtime check from `index.ts`
-3. Add compile-time check via TypeScript or in the build
-
-**Expected result:** Reduced bundle size and improved performance.
-
-**Progress:** [ ] Not started
-
----
-
-### Task 5: Loop and Operation Optimization
-
-**Goal**: Improve performance of critical code sections.
-
-**Actions:**
-
-1. Optimize loops in `md51.ts`
-2. Improve bit operations in `add32.ts`
-3. Consider using typed arrays for performance
-
-**Expected result:** 10-20% performance improvement.
-
-**Progress:** [ ] Not started
-
----
-
-### Task 6: tsup Configuration for Different Formats
-
-**Goal**: Configure tsup to create different builds for different environments.
-**Actions:**
-
-1. Configure tsup to generate CommonJS, ES modules, and UMD
-2. Add minification and dead code elimination
-3. Configure source maps
-4. Create minimal build
-
-**Expected result:** Flexible optimized builds for all environments.
-**Progress:** [ ] Not started
-
----
-
-### Task 7: Bundle Analysis and Metrics
-
-**Goal**: Measure and analyze optimization results.
-**Actions:**
-
-1. Install and configure bundle analyzer
-2. Measure bundle size before and after optimizations
-3. Check tree-shaking effectiveness
-4. Create performance benchmarks
-
-**Expected result:** Quantitative improvement metrics, understanding of what can be optimized further.
-**Progress:** [ ] Not started
-
----
-
-### Task 8: Documentation and CI/CD Update
-
-**Goal**: Update documentation and CI/CD for the new stack.
-**Actions:**
-
-1. Update README with build instructions
-2. Update package.json with new scripts
-3. Configure GitHub Actions for the new stack
-4. Add automatic benchmarks to CI
-
-**Expected result:** Complete documentation and automated CI/CD.
-**Progress:** [ ] Not started
-
-## Success Criteria
-
-1. 10-100x faster builds
-2. 20-30% reduction in bundle size
-3. Improved tree-shaking (dead code elimination)
-4. Reduction of dev dependencies from 13 to 3-5 packages
-5. Maintain 100% test coverage
-6. Compatibility with all current use cases
-
-## Priorities
-
-1. Migration to tsup (Task 1)
-2. Tree-shaking and consolidation (Tasks 2, 6)
-3. Size reduction (Tasks 3, 4)
-4. Performance and metrics (Tasks 5, 7, 8)
-
-## Risks
-
-1. Breaking backward compatibility
-2. Issues with .d.ts file generation
-3. Incompatibility with existing consumers
-
-## Next Steps
-
-After completing this phase, move to: 4. File system integration 5. WHATWG Streams support 6. Comprehensive testing and documentation