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

All notable changes to this project will be documented in this file.
This project adheres to Semantic Versioning.

A list of unreleased changes can be found here.

v4.0.1 - 2024-08-25

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.

v3.0.5 - 2023-10-09

v3.0.4 - 2023-05-23

Bug Fixes

• Do not prefix excludes when creating a reader (#504) f765894

v3.0.3 - 2023-04-21

Dependency Updates

• Bump minimatch from 8.0.4 to 9.0.0 (#497) 56d4542
• Bump minimatch from 7.4.4 to 8.0.2 a53a4e3

v3.0.2 - 2023-03-01

Dependency Updates

• Bump minimatch from 6.2.0 to 7.2.0 d2c37d4

v3.0.1 - 2023-02-16

Dependency Updates

• Bump minimatch from 6.1.8 to 6.2.0 20e9311

v3.0.0 - 2023-02-09

Breaking Changes

• Transform to ES Modules (#398) 2b61580
• Throw an error on write of a resource when path does not starts with virBasePath of the respective adapter (#453) d76575f
• Clone resources when writing in and reading from the Memory (#448) 3454bc1
• AbstractAdapter: Virtual base path must end with slash 6d1f411
• resourceFactory: Remove #createCollectionsForTree a4d15f6
• Require Node.js >= 16.18.0 / npm >= 8 94029de

BREAKING CHANGE

An 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:

• https://sap.github.io/ui5-tooling/updates/migrate-v3/
• https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

Support for older Node.js and npm releases has been dropped. Only Node.js v16.18.0 and npm v8 or higher are supported.

Features

• Add Link-reader and WriterCollection a0e5cf3
• Introduce Readers "Filter" and "Transformer" (#331) f46e6d1
• Resource: Add isModified method f6a590a

Bug Fixes

• Allow resource migration (#407) 1722d71
• FileSystem Adapter: Use fs.copy / Skip writing when resource is unchanged (#370) 9ac6a39

Dependency Updates

• Bump minimatch from 5.1.4 to 6.1.5 e6b8d14

v2.0.6 - 2020-12-18

Bug Fixes

• fsInterface on Windows: Correctly handle project paths containing non-ASCII characters 6bb44be

v2.0.5 - 2020-11-06

Performance Improvements

• Reduce install size by moving 'mock-require' to devDependencies 173f4ff

v2.0.4 - 2020-10-22

Bug Fixes

• fsInterface: Improve error messages 8b998f8

v2.0.3 - 2020-08-12

Bug Fixes

• ResourceTagCollection: Do not validate class of resource c52c9f7

v2.0.2 - 2020-07-30

Bug Fixes

• TypeScript type definition support (#252) f379094
• Resource: Keep stats size up to date (#253) 0ef976f
• Resource: getStream for empty string (#249) bc5eafb
• Resource#getSize: Retrieve Resource's size (#256) 9d2cc6c
• adapters/Memory: Return cloned resources (#235) 7bf3c6a

Reverts

• [FIX] adapters/Memory: Return cloned resources (#235)

v2.0.1 - 2020-04-30

Bug Fixes

• Namespaces in API Reference (JSDoc) b9d7b3c

v2.0.0 - 2020-03-31

Breaking Changes

• Remove deprecated parameter useNamespaces (#223) 231b319
• Require Node.js >= 10 46651f1

Dependency Updates

• Bump globby from 10.0.2 to 11.0.0 (#207) c81eb9d

BREAKING CHANGE

Remove deprecated parameter "useNamespaces" from method "resourceFactory.createCollectionsForTree". Use parameter "getVirtualBasePathPrefix" instead.

Support for older Node.js releases has been dropped. Only Node.js v10 or higher is supported.

v1.1.2 - 2019-07-01

Dependency Updates

• Bump globby from 9.2.0 to 10.0.0 573e853

v1.1.1 - 2019-06-18

Bug Fixes

• fsInterface: Handle non-POSIX paths correctly (#147) 1ad0cc8

v1.1.0 - 2019-06-03

Features

• AbstractAdapter: Add excludes option (#140) daef31f

v1.0.2 - 2019-03-21

Dependency Updates

• Bump @ui5/logger from 1.0.0 to 1.0.1 (#122) e2e2791

Features

• fsInterface: Add mkdir function 5bd91ac

v1.0.1 - 2019-02-01

Bug Fixes

• Prevent FS write from draining Resources content 370f121

Dependency Updates

• Yarn: Pin dir-glob dependency to v2.0.0 e14457c

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

v0.2.0 - 2018-07-11

v0.1.0 - 2018-06-26

v0.0.1 - 2018-06-06

Bug Fixes

• AbstractAdapter: Fix normalization of globstar 6d484e8