@cj-tech-master/excelts 7.1.0 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -56
- package/README_zh.md +9 -56
- package/dist/iife/excelts.iife.js +1 -1
- package/dist/iife/excelts.iife.min.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,6 +14,14 @@ ExcelTS is a zero-dependency TypeScript toolkit for spreadsheets and documents:
|
|
|
14
14
|
- ✅ **Cross-Platform** — Node.js 22+, Bun, Chrome 89+, Firefox 102+, Safari 14.1+
|
|
15
15
|
- ✅ **ESM First** — Native ES Modules with CommonJS compatibility and full tree-shaking
|
|
16
16
|
|
|
17
|
+
## Module Documentation
|
|
18
|
+
|
|
19
|
+
- [XML Module](src/modules/xml/README.md) — Zero-dependency SAX/DOM parser, query engine, and dual-mode writer
|
|
20
|
+
- [PDF Module](src/modules/pdf/README.md) — Full-featured zero-dependency PDF engine with encryption and font embedding
|
|
21
|
+
- [CSV Module](src/modules/csv/README.md) — RFC 4180 parser/formatter, streaming, data generation
|
|
22
|
+
- [Archive Module](src/modules/archive/README.md) — ZIP/TAR create/read/edit, compression, encryption
|
|
23
|
+
- [Stream Module](src/modules/stream/README.md) — Cross-platform Readable/Writable/Transform/Duplex
|
|
24
|
+
|
|
17
25
|
## Translations
|
|
18
26
|
|
|
19
27
|
- [中文文档](README_zh.md)
|
|
@@ -140,13 +148,7 @@ import { parseCsv, formatCsv, CsvParserStream } from "@cj-tech-master/excelts/cs
|
|
|
140
148
|
import { Readable, pipeline, createTransform } from "@cj-tech-master/excelts/stream";
|
|
141
149
|
```
|
|
142
150
|
|
|
143
|
-
Each subpath supports `browser`, `import` (ESM), and `require` (CJS) conditions.
|
|
144
|
-
|
|
145
|
-
- [XML Module](src/modules/xml/README.md) - Zero-dependency SAX/DOM parser, query engine, and dual-mode writer
|
|
146
|
-
- [PDF Module](src/modules/pdf/README.md) - Full-featured zero-dependency PDF engine with encryption and font embedding
|
|
147
|
-
- [CSV Module](src/modules/csv/README.md) - RFC 4180 parser/formatter, streaming, data generation
|
|
148
|
-
- [Archive Module](src/modules/archive/README.md) - ZIP/TAR create/read/edit, compression, encryption
|
|
149
|
-
- [Stream Module](src/modules/stream/README.md) - Cross-platform Readable/Writable/Transform/Duplex
|
|
151
|
+
Each subpath supports `browser`, `import` (ESM), and `require` (CJS) conditions.
|
|
150
152
|
|
|
151
153
|
## PDF Export
|
|
152
154
|
|
|
@@ -617,28 +619,6 @@ For older browsers without native `CompressionStream` API (Firefox < 113, Safari
|
|
|
617
619
|
|
|
618
620
|
ExcelTS does **not** require `crypto.randomUUID()` in browsers; it uses an internal UUID v4 generator with a `crypto.getRandomValues()` fallback.
|
|
619
621
|
|
|
620
|
-
## Maintainer
|
|
621
|
-
|
|
622
|
-
This project is actively maintained by [CJ (@cjnoname)](https://github.com/cjnoname).
|
|
623
|
-
|
|
624
|
-
### Maintenance Status
|
|
625
|
-
|
|
626
|
-
**Active Maintenance** - This project is actively maintained with a focus on:
|
|
627
|
-
|
|
628
|
-
- 🔒 **Security Updates** - Timely security patches and dependency updates
|
|
629
|
-
- 🐛 **Bug Fixes** - Critical bug fixes and stability improvements
|
|
630
|
-
- 📦 **Dependency Management** - Keeping dependencies up-to-date and secure
|
|
631
|
-
- 🔍 **Code Review** - Reviewing and merging community contributions
|
|
632
|
-
|
|
633
|
-
### Contributing
|
|
634
|
-
|
|
635
|
-
While I may not have the bandwidth to develop new features regularly, **community contributions are highly valued and encouraged!**
|
|
636
|
-
|
|
637
|
-
- 💡 **Pull Requests Welcome** - I will review and merge quality PRs promptly
|
|
638
|
-
- 🚀 **Feature Proposals** - Open an issue to discuss new features before implementing
|
|
639
|
-
- 🐛 **Bug Reports** - Please report bugs with reproducible examples
|
|
640
|
-
- 📖 **Documentation** - Improvements to documentation are always appreciated
|
|
641
|
-
|
|
642
622
|
## API Documentation
|
|
643
623
|
|
|
644
624
|
For detailed API documentation, please refer to the comprehensive documentation sections:
|
|
@@ -651,33 +631,6 @@ For detailed API documentation, please refer to the comprehensive documentation
|
|
|
651
631
|
- Data Validation
|
|
652
632
|
- Conditional Formatting
|
|
653
633
|
- File I/O
|
|
654
|
-
- [PDF Export](src/modules/pdf/README.md)
|
|
655
|
-
|
|
656
|
-
## Contributing Guidelines
|
|
657
|
-
|
|
658
|
-
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
659
|
-
|
|
660
|
-
### Before Submitting a PR
|
|
661
|
-
|
|
662
|
-
1. **Bug Fixes**: Add a unit-test or integration-test (in `src/**/__tests__`) that reproduces the issue
|
|
663
|
-
2. **New Features**: Open an issue first to discuss the feature and implementation approach
|
|
664
|
-
3. **Documentation**: Update relevant documentation and type definitions
|
|
665
|
-
4. **Code Style**: Follow the existing code style and pass all linters (`npm run lint`)
|
|
666
|
-
5. **Tests**: Ensure all tests pass (`npm test`) and add tests for new functionality
|
|
667
|
-
|
|
668
|
-
### Important Notes
|
|
669
|
-
|
|
670
|
-
- **Version Numbers**: Please do not modify package version in PRs. Versions are managed through releases.
|
|
671
|
-
- **License**: All contributions will be included under the project's MIT license
|
|
672
|
-
- **Commit Messages**: Write clear, descriptive commit messages
|
|
673
|
-
|
|
674
|
-
### Getting Help
|
|
675
|
-
|
|
676
|
-
If you need help or have questions:
|
|
677
|
-
|
|
678
|
-
- 📖 Check existing [issues](https://github.com/cjnoname/excelts/issues) and [documentation](https://github.com/cjnoname/excelts)
|
|
679
|
-
- 💬 Open a [new issue](https://github.com/cjnoname/excelts/issues/new) for discussion
|
|
680
|
-
- 🐛 Use issue templates for bug reports
|
|
681
634
|
|
|
682
635
|
## License
|
|
683
636
|
|
package/README_zh.md
CHANGED
|
@@ -14,6 +14,14 @@ ExcelTS 是零依赖的 TypeScript 电子表格与文档工具包:
|
|
|
14
14
|
- ✅ **跨平台** — Node.js 22+、Bun、Chrome 89+、Firefox 102+、Safari 14.1+
|
|
15
15
|
- ✅ **ESM 优先** — 原生 ES Modules,兼容 CommonJS,完整 tree-shaking 支持
|
|
16
16
|
|
|
17
|
+
## 模块文档
|
|
18
|
+
|
|
19
|
+
- [XML 模块](src/modules/xml/README.md) — 零依赖 SAX/DOM 解析器、查询引擎和双模式写入器
|
|
20
|
+
- [PDF 模块](src/modules/pdf/README.md) — 零依赖 PDF 引擎,支持加密和字体嵌入
|
|
21
|
+
- [CSV 模块](src/modules/csv/README.md) — RFC 4180 解析/格式化、流式处理、数据生成
|
|
22
|
+
- [归档模块](src/modules/archive/README.md) — ZIP/TAR 创建/读取/编辑、压缩、加密
|
|
23
|
+
- [流模块](src/modules/stream/README.md) — 跨平台 Readable/Writable/Transform/Duplex
|
|
24
|
+
|
|
17
25
|
## 翻译
|
|
18
26
|
|
|
19
27
|
- [English Documentation](README.md)
|
|
@@ -140,13 +148,7 @@ import { parseCsv, formatCsv, CsvParserStream } from "@cj-tech-master/excelts/cs
|
|
|
140
148
|
import { Readable, pipeline, createTransform } from "@cj-tech-master/excelts/stream";
|
|
141
149
|
```
|
|
142
150
|
|
|
143
|
-
每个子路径支持 `browser`、`import`(ESM)和 `require`(CJS
|
|
144
|
-
|
|
145
|
-
- [XML 模块](src/modules/xml/README.md) - 零依赖 SAX/DOM 解析器、查询引擎和双模式写入器
|
|
146
|
-
- [PDF 模块](src/modules/pdf/README.md) - 零依赖 Excel 转 PDF,支持加密和字体嵌入
|
|
147
|
-
- [CSV 模块](src/modules/csv/README.md) - RFC 4180 解析/格式化、流式处理、数据生成
|
|
148
|
-
- [归档模块](src/modules/archive/README.md) - ZIP/TAR 创建/读取/编辑、压缩、加密
|
|
149
|
-
- [流模块](src/modules/stream/README.md) - 跨平台 Readable/Writable/Transform/Duplex
|
|
151
|
+
每个子路径支持 `browser`、`import`(ESM)和 `require`(CJS)条件。
|
|
150
152
|
|
|
151
153
|
## PDF 导出
|
|
152
154
|
|
|
@@ -615,28 +617,6 @@ import {
|
|
|
615
617
|
|
|
616
618
|
浏览器端不要求必须支持 `crypto.randomUUID()`:ExcelTS 内置了 UUID v4 生成器,并会优先使用 `crypto.getRandomValues()` 作为 fallback。
|
|
617
619
|
|
|
618
|
-
## 维护者
|
|
619
|
-
|
|
620
|
-
本项目由 [CJ (@cjnoname)](https://github.com/cjnoname) 积极维护。
|
|
621
|
-
|
|
622
|
-
### 维护状态
|
|
623
|
-
|
|
624
|
-
**积极维护中** - 本项目处于积极维护状态,重点关注:
|
|
625
|
-
|
|
626
|
-
- 🔒 **安全更新** - 及时的安全补丁和依赖项更新
|
|
627
|
-
- 🐛 **Bug 修复** - 关键 Bug 修复和稳定性改进
|
|
628
|
-
- 📦 **依赖管理** - 保持依赖项最新且安全
|
|
629
|
-
- 🔍 **代码审查** - 审查和合并社区贡献
|
|
630
|
-
|
|
631
|
-
### 贡献
|
|
632
|
-
|
|
633
|
-
虽然我可能没有足够的时间定期开发新功能,但**非常重视和欢迎社区贡献!**
|
|
634
|
-
|
|
635
|
-
- 💡 **欢迎 Pull Request** - 我会及时审查并合并高质量的 PR
|
|
636
|
-
- 🚀 **功能提议** - 在实现前请先开 issue 讨论新功能
|
|
637
|
-
- 🐛 **Bug 报告** - 请提供可重现的示例报告 Bug
|
|
638
|
-
- 📖 **文档改进** - 始终欢迎文档改进
|
|
639
|
-
|
|
640
620
|
## API 文档
|
|
641
621
|
|
|
642
622
|
详细的 API 文档,请参考以下综合文档部分:
|
|
@@ -649,33 +629,6 @@ import {
|
|
|
649
629
|
- 数据验证
|
|
650
630
|
- 条件格式
|
|
651
631
|
- 文件输入输出
|
|
652
|
-
- [PDF 导出](src/modules/pdf/README.md)
|
|
653
|
-
|
|
654
|
-
## 贡献指南
|
|
655
|
-
|
|
656
|
-
欢迎贡献!请随时提交 Pull Request。
|
|
657
|
-
|
|
658
|
-
### 提交 PR 前
|
|
659
|
-
|
|
660
|
-
1. **Bug 修复**:在 `src/**/__tests__` 中添加能重现问题的单元测试或集成测试
|
|
661
|
-
2. **新功能**:先开 issue 讨论功能和实现方案
|
|
662
|
-
3. **文档**:更新相关文档和类型定义
|
|
663
|
-
4. **代码风格**:遵循现有代码风格并通过所有代码检查(`npm run lint`)
|
|
664
|
-
5. **测试**:确保所有测试通过(`npm test`)并为新功能添加测试
|
|
665
|
-
|
|
666
|
-
### 重要说明
|
|
667
|
-
|
|
668
|
-
- **版本号**:请不要在 PR 中修改 package 版本。版本通过发布管理。
|
|
669
|
-
- **许可证**:所有贡献都将包含在项目的 MIT 许可证下
|
|
670
|
-
- **提交信息**:编写清晰、描述性的提交信息
|
|
671
|
-
|
|
672
|
-
### 获取帮助
|
|
673
|
-
|
|
674
|
-
如果需要帮助或有疑问:
|
|
675
|
-
|
|
676
|
-
- 📖 查看现有的 [issues](https://github.com/cjnoname/excelts/issues) 和[文档](https://github.com/cjnoname/excelts)
|
|
677
|
-
- 💬 开一个[新 issue](https://github.com/cjnoname/excelts/issues/new) 讨论
|
|
678
|
-
- 🐛 使用 issue 模板报告 Bug
|
|
679
632
|
|
|
680
633
|
## 许可证
|
|
681
634
|
|