@ui5/fs

What is @ui5/fs?

@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.

What are @ui5/fs's main functionalities?

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/resource

Resource 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: content1

Resource 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/resource1

Other packages similar to @ui5/fs

fs-extra

fs-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

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

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.

README

ui5-fs

UI5-specific file system abstraction
Part of the UI5 Tooling

Documentation

UI5 FS documentation can be found here: sap.github.io/ui5-tooling

The UI5 FS API Reference can be found here: @ui5/fs

Contributing

Please check our Contribution Guidelines.

Support

Please follow our Contribution Guidelines on how to report an issue.

Please report issues in the main UI5 Tooling repository.

Release History

See CHANGELOG.md.

Changelog

[v4.0.0] - 2024-07-23

Breaking Changes

• Drop node v21 support 2d2f125
• Require Node.js 20.11.x/>=21.2.0 and npm >=10 b98bd9a
• DuplexCollection: remove byGlobSource method (#552) e26338b

Dependency Updates

• Bump minimatch from 9.0.5 to 10.0.1 7de313a
• Bump globby from 13.2.2 to 14.0.1 465638d

BREAKING CHANGE

byGlobSource method is removed from DuplexCollection

JIRA: CPOUI5FOUNDATION-802 Relates to: https://github.com/SAP/ui5-tooling/issues/701

Support for older Node.js and npm releases has been dropped. Only Node.js 20.11.x and >=21.2.0 as well as npm v10 or higher are supported.

<a name="v3.0.5"></a>