pure-md5 0.2.0 → 0.2.2

package/planning/03-optimization-size-tree-shaking/03-remove-duplicate-add32.md

@@ -1,93 +0,0 @@
-# Задача 3: Устранение дублирования кода (add32)
-
-## Контекст
-Функция `add32` определена в двух местах:
-1. В `src/add32.ts` как основная реализация
-2. В `src/index.ts` как inline функция для runtime проверки
-
-Дублирование увеличивает размер бандла и усложняет поддержку.
-
-## Цель
-Удалить дублирование, оставив единую реализацию `add32` в `add32.ts`.
-
-## Требуемые действия
-
-### Шаг 1: Проанализировать текущее использование
-1. Открыть `src/index.ts` и найти inline определение `add32`
-2. Открыть `src/add32.ts` и посмотреть текущую реализацию
-3. Проверить где еще используется `add32` в проекте
-
-### Шаг 2: Удалить inline определение из index.ts
-1. Открыть `src/index.ts`
-2. Удалить блок кода с inline определением `add32`:
-   ```typescript
-   fn = function add32(x, y) {
-     let lsw = (x & 0xffff) + (y & 0xffff);
-     let msw = (x >> 16) + (y >> 16) + (lsw >> 16);
-     return (msw << 16) | (lsw & 0xffff);
-   };
-   ```
-3. Убедиться что импорт `add32` из `./add32` используется правильно
-
-### Шаг 3: Обновить импорт в index.ts
-1. Добавить импорт `add32` в `src/index.ts`:
-   ```typescript
-   import hex from './hex';
-   import md51 from './md51';
-   import add32 from './add32'; // Добавить этот импорт
-   ```
-2. Обновить логику проверки чтобы использовать импортированную `add32`
-
-### Шаг 4: Оптимизировать реализацию add32
-1. Открыть `src/add32.ts`
-2. Сравнить две реализации (из add32.ts и из index.ts)
-3. Выбрать более оптимальную реализацию или объединить лучшие части
-4. Убедиться что реализация корректно работает с 32-битными числами
-
-**Текущая реализация в add32.ts:**
-```typescript
-function add32(x: number, y: number): number {
-  return (x + y) & 0xffffffff;
-}
-```
-
-**Inline реализация из index.ts:**
-```typescript
-function add32(x, y) {
-  let lsw = (x & 0xffff) + (y & 0xffff);
-  let msw = (x >> 16) + (y >> 16) + (lsw >> 16);
-  return (msw << 16) | (lsw & 0xffff);
-}
-```
-
-### Шаг 5: Проверить корректность
-1. Создать простой тест для `add32`
-2. Проверить что функция корректно работает с большими числами
-3. Убедиться что не происходит переполнения
-
-### Шаг 6: Обновить зависимости
-1. Проверить все файлы которые импортируют `add32`
-2. Убедиться что импорты корректны
-3. Запустить тесты чтобы проверить корректность
-
-## Ожидаемый результат
-- Единая реализация `add32` в `add32.ts`
-- Удалено дублирование из `index.ts`
-- Функциональность сохранена
-- Размер бандла уменьшен
-
-## Проверка прогресса
-- [ ] Inline определение удалено из index.ts
-- [ ] Добавлен импорт add32 в index.ts
-- [ ] Реализация add32 оптимизирована (если нужно)
-- [ ] Все импорты add32 обновлены
-- [ ] Тесты проходят
-- [ ] Сборка работает
-
-## Примечания
-1. Внимательно проверить работу с отрицательными числами
-2. Убедиться что оптимизация не ломает логику MD5
-3. Проверить производительность обеих реализаций
-
-## Следующий шаг
-После устранения дублирования перейти к Задаче 4: Вынос runtime проверки в compile-time.

package/planning/03-optimization-size-tree-shaking/04-remove-runtime-check.md

@@ -1,102 +0,0 @@
-# Задача 4: Вынос runtime проверки в compile-time
-
-## Контекст
-В `src/index.ts` есть runtime проверка корректности MD5:
-```typescript
-const check = hex(md51('hello'));
-if (check !== '5d41402abc4b2a76b9719d911017c592') {
-  // Определение add32 inline
-}
-```
-
-Эта проверка:
-1. Увеличивает размер бандла
-2. Выполняется при каждом импорте библиотеки
-3. Может быть вынесена в compile-time или тесты
-
-## Цель
-Убрать runtime проверку из основного кода, переместив её в тесты или compile-time проверки.
-
-## Требуемые действия
-
-### Шаг 1: Проанализировать текущую логику
-1. Открыть `src/index.ts`
-2. Понять полную логику проверки:
-   - Проверяет что MD5('hello') дает правильный хеш
-   - Если нет - определяет inline add32 с другой реализацией
-   - Это fallback для некорректной реализации add32
-
-### Шаг 2: Создать тест для проверки корректности
-1. Открыть существующие тесты (`src/*.test.ts`)
-2. Добавить тест для проверки MD5('hello')
-3. Убедиться что тест покрывает тот же случай что и runtime проверка
-
-**Пример теста:**
-```typescript
-test('MD5 should produce correct hash for "hello"', () => {
-  expect(md5('hello')).toBe('5d41402abc4b2a76b9719d911017c592');
-});
-```
-
-### Шаг 3: Удалить runtime проверку из index.ts
-1. Удалить весь блок с проверкой из `src/index.ts`:
-   ```typescript
-   let fn;
-   const check = hex(md51('hello'));
-   if (check !== '5d41402abc4b2a76b9719d911017c592') {
-     fn = function add32(x, y) {
-       let lsw = (x & 0xffff) + (y & 0xffff);
-       let msw = (x >> 16) + (y >> 16) + (lsw >> 16);
-       return (msw << 16) | (lsw & 0xffff);
-     };
-   }
-   ```
-2. Упростить функцию `md5`:
-   ```typescript
-   function md5(string: string): string {
-     return hex(md51(string));
-   }
-   ```
-
-### Шаг 4: Обеспечить корректность add32
-1. Убедиться что `add32.ts` содержит корректную реализацию
-2. Проверить что все тесты проходят с текущей реализацией add32
-3. Если нужно, обновить реализацию add32 для корректности
-
-### Шаг 5: Добавить compile-time проверку (опционально)
-1. Рассмотреть добавление TypeScript assertion
-2. Или добавить проверку в процесс сборки
-3. Или использовать константы которые проверяются TypeScript
-
-### Шаг 6: Проверить сборку и тесты
-1. Запустить `npm run build`
-2. Проверить что сборка проходит без ошибок
-3. Запустить `npm test`
-4. Убедиться что все тесты проходят, включая новый тест
-
-## Ожидаемый результат
-- Runtime проверка удалена из основного кода
-- Функциональность проверена через тесты
-- Размер бандла уменьшен
-- Производительность улучшена (нет лишних проверок)
-
-## Проверка прогресса
-- [ ] Создан тест для MD5('hello')
-- [ ] Runtime проверка удалена из index.ts
-- [ ] Функция md5 упрощена
-- [ ] Реализация add32 проверена на корректность
-- [ ] Сборка проходит без ошибок
-- [ ] Все тесты проходят
-- [ ] Размер бандла уменьшился
-
-## Примечания
-1. Убедиться что удаление проверки не ломает логику
-2. Проверить что add32 работает корректно во всех случаях
-3. Рассмотреть добавление дополнительных тестов для edge cases
-
-## Риски
-1. Если реализация add32 некорректна, тесты могут не выявить этого
-2. Нужно убедиться что все use cases покрыты тестами
-
-## Следующий шаг
-После удаления runtime проверки перейти к Задаче 5: Оптимизация циклов и операций.

package/planning/03-optimization-size-tree-shaking/05-optimize-loops-performance.md

@@ -1,107 +0,0 @@
-# Задача 5: Оптимизация циклов и операций
-
-## Контекст
-Критические участки кода в MD5 реализации могут быть оптимизированы для улучшения производительности. Основные кандидаты:
-1. Циклы в `md51.ts`
-2. Битовые операции в `add32.ts`
-3. Операции со строками в `md5blk.ts`
-
-## Цель
-Улучшить производительность MD5 реализации на 10-20% через оптимизацию циклов и операций.
-
-## Требуемые действия
-
-### Шаг 1: Анализ текущей производительности
-1. Создать простой бенчмарк для измерения производительности
-2. Измерить текущую скорость MD5 хеширования
-3. Определить bottleneck'ы через профилирование
-
-**Пример бенчмарка:**
-```typescript
-// benchmark.ts
-import { md5 } from './index';
-
-const start = performance.now();
-for (let i = 0; i < 10000; i++) {
-  md5('test string ' + i);
-}
-const end = performance.now();
-console.log(`Time: ${end - start}ms`);
-```
-
-### Шаг 2: Оптимизация md51.ts
-1. Открыть `src/md51.ts`
-2. Оптимизировать циклы:
-   - Использовать `while` вместо `for` где это уместно
-   - Предвычислять константы
-   - Уменьшить количество операций в цикле
-3. Оптимизировать работу со строками:
-   - Использовать `charCodeAt` более эффективно
-   - Рассмотреть использование `Uint8Array` для бинарных данных
-
-### Шаг 3: Оптимизация add32.ts
-1. Открыть `src/add32.ts`
-2. Сравнить производительность разных реализаций:
-   ```typescript
-   // Вариант 1: текущий
-   return (x + y) & 0xffffffff;
-   
-   // Вариант 2: inline из index.ts
-   let lsw = (x & 0xffff) + (y & 0xffff);
-   let msw = (x >> 16) + (y >> 16) + (lsw >> 16);
-   return (msw << 16) | (lsw & 0xffff);
-   ```
-3. Выбрать наиболее производительную реализацию
-4. Добавить комментарии о выборе реализации
-
-### Шаг 4: Оптимизация md5cycle.ts
-1. Открыть `src/md5cycle.ts`
-2. Оптимизировать вызовы функций:
-   - Рассмотреть инлайнинг small функций
-   - Уменьшить количество `.bind()` вызовов
-   - Предвычислять константы
-3. Оптимизировать доступ к массивам
-
-### Шаг 5: Оптимизация работы с памятью
-1. Рассмотреть использование typed arrays вместо обычных массивов
-2. Уменьшить аллокации памяти в циклах
-3. Переиспользовать буферы где это возможно
-
-### Шаг 6: Проверить корректность после оптимизаций
-1. Запустить все тесты: `npm test`
-2. Проверить что оптимизации не ломают логику
-3. Запустить бенчмарк для измерения улучшений
-
-### Шаг 7: Добавить перфоманс тесты
-1. Создать тесты производительности в `src/*.perf.test.ts`
-2. Добавить baseline измерения
-3. Установить пороги для регрессий
-
-## Ожидаемый результат
-- Улучшение производительности на 10-20%
-- Сохранение корректности MD5 алгоритма
-- Все тесты проходят
-- Добавлены перфоманс тесты
-
-## Проверка прогресса
-- [ ] Создан бенчмарк для измерения производительности
-- [ ] Оптимизированы циклы в md51.ts
-- [ ] Оптимизирована реализация add32.ts
-- [ ] Оптимизирован md5cycle.ts
-- [ ] Проверена работа с памятью
-- [ ] Все тесты проходят
-- [ ] Измерено улучшение производительности
-- [ ] Добавлены перфоманс тесты
-
-## Примечания
-1. Оптимизации не должны ломать корректность алгоритма
-2. Сохранять читаемость кода
-3. Документировать причины выбора оптимизаций
-
-## Метрики
-1. Время хеширования 10к строк (до/после)
-2. Размер бандла (не должен увеличиться)
-3. Потребление памяти
-
-## Следующий шаг
-После оптимизации производительности перейти к Задаче 6: Настройка Webpack для минимального бандла.

package/planning/03-optimization-size-tree-shaking/06-tsup-formats-configuration.md

@@ -1,227 +0,0 @@
-# Задача 6: Настройка tsup для разных форматов
-
-## Контекст
-После успешной миграции на tsup (Задача 1) необходимо настроить создание разных сборок для различных use cases. Tsup поддерживает генерацию множественных форматов из коробки.
-
-## Цель
-Настроить tsup для создания оптимизированных сборок:
-1. CommonJS для Node.js и старых бандлеров
-2. ES модули для современных бандлеров (Webpack 5+, Vite, Rollup)
-3. UMD/IIFE для использования в браузере через script tag
-4. Минимальная сборка с агрессивной оптимизацией для production
-
-## Требуемые действия
-
-### Шаг 1: Создать основную конфигурацию tsup
-1. Обновить `tsup.config.ts` для поддержки всех форматов:
-   ```typescript
-   import { defineConfig } from 'tsup';
-   
-   export default defineConfig({
-     entry: ['src/index.ts'],
-     format: ['cjs', 'esm'], // CommonJS и ES модули
-     dts: true, // Генерация .d.ts файлов
-     sourcemap: true, // Source maps для отладки
-     clean: true, // Очистка output директории
-     minify: false, // Минификация отключена для dev
-     treeshake: true, // Включить tree-shaking
-     splitting: false, // Для библиотек обычно false
-     bundle: true, // Bundle все зависимости
-     outDir: 'dist', // Output директория
-     target: 'es2020', // Современный target
-   });
-   ```
-
-### Шаг 2: Создать production конфигурацию
-1. Создать `tsup.config.prod.ts`:
-   ```typescript
-   import { defineConfig } from 'tsup';
-   
-   export default defineConfig({
-     entry: ['src/index.ts'],
-     format: ['cjs', 'esm'],
-     dts: true,
-     sourcemap: false, // Без source maps в production
-     clean: true,
-     minify: true, // Включить минификацию
-     minifyWhitespace: true,
-     minifyIdentifiers: true,
-     minifySyntax: true,
-     treeshake: true,
-     splitting: false,
-     bundle: true,
-     outDir: 'dist',
-     target: 'es2020',
-   });
-   ```
-
-### Шаг 3: Создать UMD конфигурацию для браузера
-1. Создать `tsup.config.umd.ts`:
-   ```typescript
-   import { defineConfig } from 'tsup';
-   
-   export default defineConfig({
-     entry: ['src/index.ts'],
-     format: ['iife'], // IIFE формат для браузера
-     globalName: 'pureMD5', // Глобальная переменная
-     dts: false, // .d.ts не нужны для браузера
-     sourcemap: true,
-     clean: true,
-     minify: true,
-     treeshake: true,
-     splitting: false,
-     bundle: true,
-     outDir: 'dist',
-     target: 'es2020',
-     platform: 'browser', // Платформа браузера
-     outExtension: () => ({ js: '.browser.js' }), // Другое расширение
-   });
-   ```
-
-### Шаг 4: Создать минимальную конфигурацию
-1. Создать `tsup.config.min.ts`:
-   ```typescript
-   import { defineConfig } from 'tsup';
-   
-   export default defineConfig({
-     entry: ['src/index.ts'],
-     format: ['esm'], // Только ES модули для минимального размера
-     dts: false, // Без типов
-     sourcemap: false, // Без source maps
-     clean: true,
-     minify: true,
-     minifyWhitespace: true,
-     minifyIdentifiers: true,
-     minifySyntax: true,
-     treeshake: true,
-     pure: ['console.log', 'console.debug'], // Удалить console вызовы
-     splitting: false,
-     bundle: true,
-     outDir: 'dist',
-     target: 'es2020',
-     outExtension: () => ({ js: '.min.js' }), // Расширение .min.js
-   });
-   ```
-
-### Шаг 5: Обновить package.json scripts
-1. Обновить скрипты в `package.json`:
-   ```json
-   "scripts": {
-     "build": "tsup",
-     "build:prod": "tsup --config tsup.config.prod.ts",
-     "build:umd": "tsup --config tsup.config.umd.ts",
-     "build:min": "tsup --config tsup.config.min.ts",
-     "build:all": "npm run build && npm run build:prod && npm run build:umd && npm run build:min",
-     "build:watch": "tsup --watch",
-     "dev": "tsup --watch"
-   }
-   ```
-
-### Шаг 6: Настроить exports в package.json
-1. Обновить поле exports для поддержки разных форматов:
-   ```json
-   "exports": {
-     ".": {
-       "import": "./dist/index.mjs",
-       "require": "./dist/index.js",
-       "types": "./dist/index.d.ts",
-       "default": "./dist/index.js"
-     },
-     "./browser": {
-       "import": "./dist/index.browser.mjs",
-       "require": "./dist/index.browser.js",
-       "default": "./dist/index.browser.js"
-     },
-     "./min": {
-       "import": "./dist/index.min.mjs",
-       "require": "./dist/index.min.js",
-       "default": "./dist/index.min.js"
-     }
-   },
-   "main": "./dist/index.js",
-   "module": "./dist/index.mjs",
-   "browser": "./dist/index.browser.js",
-   "types": "./dist/index.d.ts"
-   ```
-
-### Шаг 7: Проверить все сборки
-1. Запустить полную сборку:
-   ```bash
-   npm run build:all
-   ```
-2. Проверить созданные файлы в `dist/`:
-   ```bash
-   ls -la dist/
-   ```
-3. Ожидаемые файлы:
-   - `index.js` (CommonJS, development)
-   - `index.mjs` (ES modules, development)
-   - `index.d.ts` (TypeScript declarations)
-   - `index.browser.js` (UMD для браузера)
-   - `index.min.js` (Минимальная сборка)
-
-### Шаг 8: Протестировать каждую сборку
-1. Тестировать CommonJS сборку:
-   ```bash
-   node -e "const { md5 } = require('./dist/index.js'); console.log(md5('test'))"
-   ```
-2. Тестировать ES modules сборку (если поддерживается):
-   ```bash
-   node --loader ts-node/esm -e "import { md5 } from './dist/index.mjs'; console.log(md5('test'))"
-   ```
-3. Тестировать UMD сборку в браузере (симуляция):
-   ```bash
-   echo 'console.log(pureMD5.md5("test"))' | node -e "
-   const vm = require('vm');
-   const fs = require('fs');
-   const code = fs.readFileSync('./dist/index.browser.js', 'utf8');
-   const context = { console };
-   vm.runInNewContext(code, context);
-   "
-   ```
-
-### Шаг 9: Настроить анализ бандла
-1. Установить инструменты для анализа:
-   ```bash
-   npm install -D @arethetypeswrong/cli
-   ```
-2. Добавить скрипт анализа:
-   ```json
-   "scripts": {
-     "analyze": "attw --pack .",
-     "analyze:size": "node scripts/analyze-size.js"
-   }
-   ```
-
-## Ожидаемый результат
-- 4 разные оптимизированные сборки
-- Правильные exports в package.json
-- Минимальная сборка значительно меньше основной
-- Все сборки работают в своих средах
-- Возможность анализа бандла
-
-## Проверка прогресса
-- [ ] Основная конфигурация tsup создана
-- [ ] Production конфигурация создана
-- [ ] UMD конфигурация создана
-- [ ] Минимальная конфигурация создана
-- [ ] package.json scripts обновлены
-- [ ] exports в package.json настроены
-- [ ] Все сборки создаются без ошибок
-- [ ] Каждая сборка протестирована
-- [ ] Инструменты анализа установлены
-- [ ] Документированы различия между сборками
-
-## Примечания
-1. UMD формат может быть не нужен если библиотека используется только через npm
-2. Минимальная сборка может ломать source maps для отладки
-3. Проверить совместимость с существующими потребителями
-4. Убедиться что tree-shaking работает корректно
-
-## Метрики
-1. Размер каждой сборки (raw и gzipped)
-2. Время сборки для каждой конфигурации
-3. Эффективность tree-shaking
-
-## Следующий шаг
-После настройки разных форматов перейти к Задаче 7: Анализ бандла и метрики.