devDependency replace globby

.chglog/release-config.yml

@@ -3,6 +3,7 @@ template: RELEASE.tpl.md
 info:
   repository_url: https://github.com/SAP/ui5-fs
 options:
+  tag_filter_pattern: '^v[^012]' # For release notes ignore versions below v3 to that we always compare the _last v3+_ tag with the current release
   commits:
     filters:
       Type:

.eslintrc.js

@@ -1,10 +1,7 @@
 module.exports = {
 	"env": {
 		"node": true,
-		"es6": true
-	},
-	"parserOptions": {
-		"ecmaVersion": 8
+		"es2021": true
 	},
 	"extends": ["eslint:recommended", "google"],
 	"plugins": [
@@ -46,7 +43,11 @@ module.exports = {
 		"comma-dangle": "off",
 		"no-tabs": "off",
 		"valid-jsdoc": 0,
-		"jsdoc/check-examples": 2,
+		// jsdoc/check-examples is temporarily set to "warn" as the rule causes issues in our CI
+		// See: https://github.com/gajus/eslint-plugin-jsdoc/issues/508
+		// Starting with ESLint v8, it needs to be disabled as it currently can't be supported
+		// See: https://github.com/eslint/eslint/issues/14745
+		"jsdoc/check-examples": 0,
 		"jsdoc/check-param-names": 2,
 		"jsdoc/check-tag-names": 2,
 		"jsdoc/check-types": 2,

.github/workflows/codeql-analysis.yml

@@ -2,9 +2,15 @@ name: "CodeQL"
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+      - main
+      - next
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - main
+      - next
 
   # Execute at least once per week to get new findings without active development taking place
   schedule:
@@ -17,11 +23,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       with:
         languages: 'javascript'
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -33,4 +39,4 @@ jobs:
     # 📚 https://git.io/JvXDl
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v1
+      uses: github/codeql-action/analyze@v2

.github/workflows/github-ci.yml

@@ -2,22 +2,28 @@ name: GitHub CI
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+      - main
+      - next
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - main
+      - next
 
 jobs:
   test:
     name: General checks, tests and coverage reporting
     runs-on: ubuntu-latest
     steps:
 
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - name: Use Node.js LTS 14.x
-      uses: actions/setup-node@v2.4.1
+    - name: Use Node.js LTS 16.x
+      uses: actions/setup-node@v3.3.0
       with:
-        node-version: 14.x
+        node-version: 16.x
 
     - name: Install dependencies
       run: npm ci

.github/workflows/reuse-compliance.yml

@@ -2,15 +2,21 @@ name: REUSE
 
 on:
   push:
-    branches: [ master ]
+    branches:
+      - master
+      - main
+      - next
   pull_request:
-    branches: [ master ]
+    branches:
+      - master
+      - main
+      - next
 
 jobs:
   compliance-check:
     name: Compliance Check
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Execute REUSE Compliance Check
       uses: fsfe/reuse-action@v1.1

CHANGELOG.md

@@ -2,10 +2,49 @@
 All notable changes to this project will be documented in this file.  
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-fs/compare/v2.0.6...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-fs/compare/v3.0.0-alpha.5...HEAD).
+
+<a name="v3.0.0-alpha.5"></a>
+## [v3.0.0-alpha.5] - 2022-07-06
+
+<a name="v3.0.0-alpha.4"></a>
+## [v3.0.0-alpha.4] - 2022-06-13
+### Breaking Changes
+- **AbstractAdapter:** Virtual base path must end with slash [`6d1f411`](https://github.com/SAP/ui5-fs/commit/6d1f4117a2b8bb1226540fafeec8341e4966177d)
+- **resourceFactory:** Remove #createCollectionsForTree [`a4d15f6`](https://github.com/SAP/ui5-fs/commit/a4d15f61ae0416051658280bfd2f8635c7ddf44e)
+
+### Features
+- Add Link-reader and WriterCollection [`a0e5cf3`](https://github.com/SAP/ui5-fs/commit/a0e5cf3ef86a4b0cdc817d08963ed6574740f1bc)
+
+
+<a name="v3.0.0-alpha.3"></a>
+## [v3.0.0-alpha.3] - 2022-04-26
+### Bug Fixes
+- **FileSystem Adapter:** Use native fs.copy / Skip writing when resource is unchanged ([#370](https://github.com/SAP/ui5-fs/issues/370)) [`9ac6a39`](https://github.com/SAP/ui5-fs/commit/9ac6a39f3cb72e02c2a1298b07c4676a0ee92377)
+
+
+<a name="v3.0.0-alpha.2"></a>
+## [v3.0.0-alpha.2] - 2022-01-25
+### Breaking Changes
+- Require Node.js >= 16.13.2 / npm >= 8 [`94029de`](https://github.com/SAP/ui5-fs/commit/94029deea4e85211fb8d84f7b213f1fd0c418240)
+
+### BREAKING CHANGE
+
+Support for older Node.js and npm releases has been dropped.
+Only Node.js v16.13.2 and npm v8 or higher are supported.
+
+
+<a name="v3.0.0-alpha.1"></a>
+## [v3.0.0-alpha.1] - 2022-01-13
+### Features
+- Introduce Readers "Filter" and "Transformer" ([#331](https://github.com/SAP/ui5-fs/issues/331)) [`f46e6d1`](https://github.com/SAP/ui5-fs/commit/f46e6d1b9aed5858f2d72b10b18635de6ed1f1e0)
+
+
+<a name="v3.0.0-alpha.0"></a>
+## [v3.0.0-alpha.0] - 2021-12-14
 
 <a name="v2.0.6"></a>
-## [v2.0.6] - 2020-12-17
+## [v2.0.6] - 2020-12-18
 ### Bug Fixes
 - **fsInterface on Windows:** Correctly handle project paths containing non-ASCII characters [`6bb44be`](https://github.com/SAP/ui5-fs/commit/6bb44be7c13f6b5c66855d3343694f42f9bdfe0e)
 
@@ -128,6 +167,12 @@ Adapters "AbstractAdapter", "FileSystem" and "Memory" used to be accessible via
 - **AbstractAdapter:** Fix normalization of globstar [`6d484e8`](https://github.com/SAP/ui5-fs/commit/6d484e847b62aa0829641f25a76dcc89b0840d44)
 
 
+[v3.0.0-alpha.5]: https://github.com/SAP/ui5-fs/compare/v3.0.0-alpha.4...v3.0.0-alpha.5
+[v3.0.0-alpha.4]: https://github.com/SAP/ui5-fs/compare/v3.0.0-alpha.3...v3.0.0-alpha.4
+[v3.0.0-alpha.3]: https://github.com/SAP/ui5-fs/compare/v3.0.0-alpha.2...v3.0.0-alpha.3
+[v3.0.0-alpha.2]: https://github.com/SAP/ui5-fs/compare/v3.0.0-alpha.1...v3.0.0-alpha.2
+[v3.0.0-alpha.1]: https://github.com/SAP/ui5-fs/compare/v3.0.0-alpha.0...v3.0.0-alpha.1
+[v3.0.0-alpha.0]: https://github.com/SAP/ui5-fs/compare/v2.0.6...v3.0.0-alpha.0
 [v2.0.6]: https://github.com/SAP/ui5-fs/compare/v2.0.5...v2.0.6
 [v2.0.5]: https://github.com/SAP/ui5-fs/compare/v2.0.4...v2.0.5
 [v2.0.4]: https://github.com/SAP/ui5-fs/compare/v2.0.3...v2.0.4

azure-pipelines.yml

@@ -8,24 +8,18 @@ trigger:
 
 strategy:
   matrix:
-    linux_node_10:
+    linux_node_lts_16:
       imageName: 'ubuntu-20.04'
-      node_version: 10.x
-    linux_node_lts_12:
-      imageName: 'ubuntu-20.04'
-      node_version: 12.x
-    linux_node_lts_14:
-      imageName: 'ubuntu-20.04'
-      node_version: 14.x
+      node_version: 16.x
     linux_node_latest:
       imageName: 'ubuntu-20.04'
-      node_version: 16.x
+      node_version: 18.x
     mac_node_latest:
-      imageName: 'macOS-10.15'
-      node_version: 16.x
+      imageName: 'macOS-11'
+      node_version: 18.x
     windows_node_latest:
-      imageName: 'windows-2019'
-      node_version: 16.x
+      imageName: 'windows-2022'
+      node_version: 18.x
 
 pool:
   vmImage: $(imageName)
@@ -59,6 +53,6 @@ steps:
     codeCoverageTool: 'cobertura'
     summaryFileLocation: '$(System.DefaultWorkingDirectory)/coverage/cobertura-coverage.xml'
 
-- script: npm run test
+- script: npm run coverage
   displayName: Run Test Natively in Case of Failures
   condition: failed()

index.js

@@ -22,6 +22,21 @@ module.exports = {
 		 */
 		Memory: "./lib/adapters/Memory"
 	},
+	/**
+	 * @public
+	 * @alias module:@ui5/fs.readers
+	 * @namespace
+	 */
+	readers: {
+		/**
+		 * @type {typeof import('./lib/readers/Filter')}
+		 */
+		Filter: "./lib/readers/Filter",
+		/**
+		 * @type {typeof import('./lib/readers/Transformer')}
+		 */
+		Transformer: "./lib/readers/Transformer",
+	},
 	/**
 	 * @type {typeof import('./lib/AbstractReader')}
 	 */

jsdoc.json

@@ -11,7 +11,6 @@
 		"./jsdoc-plugin"
 	],
 	"opts": {
-		"template": "node_modules/docdash/",
 		"encoding": "utf8",
 		"destination": "jsdocs/",
 		"recurse": true,

lib/AbstractReader.js

@@ -70,6 +70,60 @@ class AbstractReader {
 		});
 	}
 
+
+	/**
+	 * Create a [Filter-Reader]{@link module:@ui5/fs.readers.Filter} from the current reader
+	 *
+	 * @public
+	 * @param {module:@ui5/fs.readers.Filter~callback} callback
+	 * 				Filter function. Will be called for every resource passed through this reader.
+	 * @returns {module:@ui5/fs.reader.Filter} Filter instance
+	 */
+	filter(callback) {
+		const Filter = require("./readers/Filter");
+		return new Filter({
+			reader: this,
+			callback
+		});
+	}
+
+	/**
+	 * Create a [Transformer-Reader]{@link module:@ui5/fs.readers.Transformer} from the current reader
+	 *
+	 * @private
+	 * @param {module:@ui5/fs.readers.Transformer~callback} callback
+	 * 				Callback to check and eventually transform any resource passed through the reader
+	 * @returns {module:@ui5/fs.reader.Transformer} Transformer instance
+	 */
+	transform(callback) {
+		const Transformer = require("./readers/Transformer");
+		return new Transformer({
+			reader: this,
+			callback
+		});
+	}
+	/**
+	 * Create an abstraction of this reader instance where all requests are prefixed with
+	 * <code>/resources/<namespace></code>.
+	 *
+	 * This simulates "flat" resource access, which is for example common for projects of type
+	 * "application"
+	 *
+	 * @public
+	 * @param {string} namespace Project namespace
+	 * @returns {module:@ui5/fs.reader.AbstractReader} Reader instance
+	 */
+	flatten(namespace) {
+		const Link = require("./readers/Link");
+		return new Link({
+			reader: this,
+			pathMapping: {
+				linkPath: `/`,
+				targetPath: `/resources/${namespace}/`
+			}
+		});
+	}
+
 	/**
 	 * Locates resources by one or more glob patterns.
 	 *
@@ -82,7 +136,7 @@ class AbstractReader {
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
 	 */
 	_byGlob(virPattern, options, trace) {
-		throw new Error("Not implemented");
+		throw new Error("Function '_byGlob' is not implemented");
 	}
 
 	/**
@@ -96,7 +150,7 @@ class AbstractReader {
 	 * @returns {Promise<module:@ui5/fs.Resource[]>} Promise resolving to list of resources
 	 */
 	_runGlob(pattern, options, trace) {
-		throw new Error("Not implemented");
+		throw new Error("Function '_runGlob' is not implemented");
 	}
 
 	/**
@@ -110,7 +164,7 @@ class AbstractReader {
 	 * @returns {Promise<module:@ui5/fs.Resource>} Promise resolving to a single resource
 	 */
 	_byPath(virPath, options, trace) {
-		throw new Error("Not implemented");
+		throw new Error("Function '_byPath' is not implemented");
 	}
 }
 

lib/ReaderCollection.js

@@ -12,10 +12,10 @@ class ReaderCollection extends AbstractReader {
 	 * The constructor.
 	 *
 	 * @param {object} parameters Parameters
-	 * @param {module:@ui5/fs.AbstractReader[]} parameters.readers List of resource readers (all tried in parallel)
 	 * @param {string} parameters.name The collection name
+	 * @param {module:@ui5/fs.AbstractReader[]} parameters.readers List of resource readers (all tried in parallel)
 	 */
-	constructor({readers, name}) {
+	constructor({name, readers}) {
 		super();
 		this._name = name;
 		this._readers = readers;