@ui5/fs is a file system abstraction library designed for the UI5 framework. It provides utilities for managing and processing file resources in a consistent and efficient manner, which is particularly useful for building and developing UI5 applications.
Resource Management
This feature allows you to create and manage resources. The code sample demonstrates how to create a resource and retrieve its path.
const { resourceFactory } = require('@ui5/fs');
const resource = resourceFactory.createResource({
path: '/path/to/resource',
string: 'content of the resource'
});
console.log(resource.getPath()); // Output: /path/to/resourceResource Collections
This feature allows you to create collections of resources and perform operations on them. The code sample demonstrates how to create a collection and retrieve a resource by its path.
const { resourceFactory } = require('@ui5/fs');
const resource1 = resourceFactory.createResource({ path: '/path/to/resource1', string: 'content1' });
const resource2 = resourceFactory.createResource({ path: '/path/to/resource2', string: 'content2' });
const collection = resourceFactory.createResourceCollection({
resources: [resource1, resource2]
});
collection.byPath('/path/to/resource1').then(resource => console.log(resource.getString())); // Output: content1Resource Filtering
This feature allows you to filter resources based on certain criteria. The code sample demonstrates how to filter resources by their path.
const { resourceFactory } = require('@ui5/fs');
const resource1 = resourceFactory.createResource({ path: '/path/to/resource1', string: 'content1' });
const resource2 = resourceFactory.createResource({ path: '/path/to/resource2', string: 'content2' });
const collection = resourceFactory.createResourceCollection({
resources: [resource1, resource2]
});
const filteredResources = collection.filter(resource => resource.getPath().includes('resource1'));
filteredResources.forEach(resource => console.log(resource.getPath())); // Output: /path/to/resource1fs-extra is a package that extends the native Node.js file system module with additional methods and functionality. It provides similar file management capabilities but is not specifically tailored for UI5 applications. It offers methods for copying, moving, and removing files and directories, among other utilities.
vinyl-fs is a file system utility for working with streams in Node.js. It is part of the Gulp ecosystem and is used for reading, writing, and manipulating files. While it provides similar file management capabilities, it is more focused on stream-based operations and is not specifically designed for UI5 applications.
globby is a package for matching files using glob patterns. It provides utilities for finding files and directories based on patterns, which can be useful for resource management. However, it does not offer the same level of abstraction and specific utilities for UI5 applications as @ui5/fs.
UI5-specific file system abstraction
Part of the UI5 Tooling
UI5 FS documentation can be found here: sap.github.io/ui5-tooling
The UI5 FS API Reference can be found here: @ui5/fs
Please check our Contribution Guidelines.
Please follow our Contribution Guidelines on how to report an issue.
Please report issues in the main UI5 Tooling repository.
See CHANGELOG.md.
[v3.0.0] - 2023-02-09
2b61580d76575f3454bc16d1f411a4d15f694029deAn error is thrown when a resource shall be written to an adapter where the path of the resource does not starts with the virtual base path defined in the adapter.
Resources stored in the adapters can not be modified by reference anymore. All modifications need to be persisted by using the #write method in order to be reflected in the adapter.
This package has been transformed to ES Modules. Therefore it no longer provides a CommonJS export. If your project uses CommonJS, it needs to be converted to ES Modules or use a dynamic import.
For more information see also:
Support for older Node.js and npm releases has been dropped. Only Node.js v16.18.0 and npm v8 or higher are supported.
a0e5cf3f46e6d1f6a590a1722d719ac6a39e6b8d14<a name="v2.0.6"></a>
FAQs
UI5 Tooling - File System Abstraction
The npm package @ui5/fs receives a total of 197,365 weekly downloads. As such, @ui5/fs popularity was classified as popular.
We found that @ui5/fs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.