@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 Build and Development Tooling

Resources

During the build phase, a modified resource is kept in memory for further processing in other build steps.

This ensures performance, as physical read and write access for a high number of resources are kept to a minimum.

The virtual file system offers an abstraction layer from the physical file system. Amongst others, it can combine a bunch of scattered file locations into a well defined, virtualized structure.

Adapters

Adapers abstract resource access to different resource locations.

The memory adapter represents a virtual file system, which maintains respective resources inside a data structure, whereas the file system adapter has direct access to the physical file sytem.

Resource Readers

Maps virtual to physical paths.

Collections

Multiple resource readers can be bundled to a collection. There are multiple types of collections which differ in their capability of having read or write access and in the order of how they obtain resources.

Collection

The collection has only read access.

The collection takes a list of readers. Readers are accessed in parallel: the reader which returns the resource first is used.

Prioritized Collection

The prioritized collection has only read access.

The collection takes a list of readers. The readers are accessed prioritized in the same order as they are passed to the collection.

Duplex Collection

The duplex collection has read and write access.

The collection takes a single reader or collection of readers and a writer instance for writing results.

Contributing

Please check our Contribution Guidelines.

Support

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

Release History

See CHANGELOG.md.

License

This project is licensed under the Apache Software License, Version 2.0 except as noted otherwise in the LICENSE file.

Changelog

[v1.0.0] - 2019-01-10

Breaking Changes

• index.js export: Remove top-level access to adapters f1f7831

Dependency Updates

• Pin dir-glob to v2.0.0 b921fbc
• Bump @ui5/logger from 0.2.2 to 1.0.0 (#72) 4077f19

BREAKING CHANGE

Adapters "AbstractAdapter", "FileSystem" and "Memory" used to be accessible via the top-level export of index.js (example: require("@ui5/project").FileSystem). This is no longer possible. Adapters are now grouped in the top-level object "adapters" and can be accessed from there (example: require("@ui5/project").adapters.FileSystem).

<a name="v0.2.0"></a>