feat(core): Add SmartFS core library with providers, builders, interfaces, docs, tests and CI
This commit is contained in:
18
changelog.md
Normal file
18
changelog.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-11-21 - 1.1.0 - feat(core)
|
||||
Add SmartFS core library with providers, builders, interfaces, docs, tests and CI
|
||||
|
||||
- Add core TypeScript sources and public exports: SmartFs, SmartFsFile, SmartFsDirectory, SmartFsTransaction, SmartFsWatcher and ts/index.ts
|
||||
- Add two providers: SmartFsProviderNode (Node.js fs/promises + fs.watch) and SmartFsProviderMemory (in-memory implementation used for testing)
|
||||
- Add provider and type contracts: ISmartFsProvider, IProviderCapabilities and comprehensive mod.types definitions
|
||||
- Implement transactions with prepare/execute/rollback, atomic writes, Web Streams-based read/write streams, and file watching with debouncing and filters
|
||||
- Add tests entry (test/test.ts) and test scaffolding for memory and node providers
|
||||
- Add package configuration (package.json, tsconfig.json, npmextra.json), documentation (readme.md, readme.hints.md) and plugins/paths helpers
|
||||
- Add CI workflows and .gitignore
|
||||
|
||||
## 2025-11-21 - 1.0.1 - initial release
|
||||
Initial project commit and setup.
|
||||
|
||||
- Project initialized with the initial scaffold and files
|
||||
- Basic project configuration and versioning (1.0.1)
|
||||
27
readme.md
27
readme.md
@@ -2,6 +2,10 @@
|
||||
|
||||
Modern, pluggable filesystem module with fluent API, Web Streams support, and multiple storage backends.
|
||||
|
||||
## Issue Reporting and Security
|
||||
|
||||
For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who want to sign a contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.
|
||||
|
||||
## Features
|
||||
|
||||
- **🎯 Fluent API** - Action-last chainable interface for elegant code
|
||||
@@ -428,18 +432,21 @@ try {
|
||||
4. **Enable atomic writes** for critical data
|
||||
5. **Debounce watchers** to reduce event spam
|
||||
|
||||
## Contributing
|
||||
## License and Legal Information
|
||||
|
||||
Contributions welcome! Please ensure:
|
||||
- All tests pass
|
||||
- Code follows existing style
|
||||
- TypeScript types are complete
|
||||
- Documentation is updated
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
## License
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
MIT © [Lossless GmbH](https://lossless.gmbh)
|
||||
### Trademarks
|
||||
|
||||
---
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
For more information, visit [code.foss.global](https://code.foss.global/push.rocks/smartfs)
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartfs',
|
||||
version: '1.1.0',
|
||||
description: 'a cross platform extendable fs module'
|
||||
}
|
||||
Reference in New Issue
Block a user