Skip to content

Commit f83feb5

Browse files
committed
Updating build tools & README.md
1 parent 4d72a23 commit f83feb5

File tree

8 files changed

+238
-114
lines changed

8 files changed

+238
-114
lines changed

README.md

Lines changed: 42 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -447,23 +447,61 @@ filesize.js/
447447
6. Push to the branch (`git push origin feature/amazing-feature`)
448448
7. Open a Pull Request
449449

450+
### Development Workflow
451+
452+
filesize.js includes an optimized development workflow with modern build tools:
453+
454+
* **🔄 Live Reload**: Use `npm run dev` for automatic rebuilds during development
455+
* **📊 Bundle Analysis**: Monitor build sizes with `npm run build:analyze`
456+
* **⚡ Fast Testing**: Live test running with `npm run test:watch`
457+
* **🔧 Auto-fixing**: Automatic linting fixes with `npm run lint:fix`
458+
* **📈 Performance**: Optimized Rollup configuration with enhanced tree shaking
459+
460+
**Build Output Analysis:**
461+
- Minified ES Module: ~1.8KB (gzipped)
462+
- UMD Bundle: ~1.9KB (gzipped)
463+
- Comprehensive source maps included
464+
450465
### Development Commands
451466

452467
```bash
453468
# Install dependencies
454469
npm install
455470

471+
# Development mode with live rebuild
472+
npm run dev
473+
474+
# Build distribution
475+
npm run build
476+
477+
# Build with bundle size analysis
478+
npm run build:analyze
479+
480+
# Live rebuild during development
481+
npm run build:watch
482+
456483
# Run linting
457484
npm run lint
458485

486+
# Auto-fix linting issues
487+
npm run lint:fix
488+
459489
# Run tests
460490
npm test
461491

462-
# Build distribution
463-
npm run build
492+
# Live testing during development
493+
npm run test:watch
494+
495+
# Run only unit tests
496+
npm run mocha
497+
498+
# Bundle size analysis
499+
npm run analyze:size
464500

465-
# Run all checks (lint + test)
466-
npm run ci
501+
# Benchmarking
502+
npm run benchmark
503+
npm run benchmark:basic
504+
npm run benchmark:stress
467505
```
468506

469507
## License

dist/filesize.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/filesize.min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/filesize.umd.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/filesize.umd.min.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)