@sap-ux/project-access 1.8.2 → 1.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -48,7 +48,7 @@ export declare function findFilesByExtension(extension: string, root: string, ex
48
48
  export declare function findFileUp(fileName: string, startPath: string, fs?: Editor): Promise<string | undefined>;
49
49
  /**
50
50
  * @description Returns a flat list of all file paths under a directory tree,
51
- * recursing through all subdirectories
51
+ * recursing through all subdirectories.
52
52
  * @param {string} dir - the directory to walk
53
53
  * @returns {string[]} - array of file path strings
54
54
  * @throws if an error occurs reading a file path
@@ -134,7 +134,7 @@ function findFileUp(fileName, startPath, fs) {
134
134
  exports.findFileUp = findFileUp;
135
135
  /**
136
136
  * @description Returns a flat list of all file paths under a directory tree,
137
- * recursing through all subdirectories
137
+ * recursing through all subdirectories.
138
138
  * @param {string} dir - the directory to walk
139
139
  * @returns {string[]} - array of file path strings
140
140
  * @throws if an error occurs reading a file path
@@ -35,6 +35,7 @@ export declare function getCapCustomPaths(capProjectPath: string): Promise<CapCu
35
35
  * Return the CAP model and all services.
36
36
  *
37
37
  * @param projectRoot - CAP project root where package.json resides
38
+ * @returns {*} {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
38
39
  */
39
40
  export declare function getCapModelAndServices(projectRoot: string): Promise<{
40
41
  model: csn;
@@ -95,6 +95,7 @@ exports.getCapCustomPaths = getCapCustomPaths;
95
95
  * Return the CAP model and all services.
96
96
  *
97
97
  * @param projectRoot - CAP project root where package.json resides
98
+ * @returns {*} {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
98
99
  */
99
100
  function getCapModelAndServices(projectRoot) {
100
101
  return __awaiter(this, void 0, void 0, function* () {
@@ -5,6 +5,7 @@ import type { AllAppResults, FioriArtifactTypes, FoundFioriArtifacts, WorkspaceF
5
5
  * @param path path of a project file
6
6
  * @param sapuxRequired if true, only find sapux projects
7
7
  * @param silent if true, then does not throw an error but returns an empty path
8
+ * @returns {*} {Promise<string>} - Project Root
8
9
  */
9
10
  export declare function findProjectRoot(path: string, sapuxRequired?: boolean, silent?: boolean): Promise<string>;
10
11
  /**
@@ -69,6 +69,7 @@ function wsFoldersToRootPaths(wsFolders) {
69
69
  * @param path path of a project file
70
70
  * @param sapuxRequired if true, only find sapux projects
71
71
  * @param silent if true, then does not throw an error but returns an empty path
72
+ * @returns {*} {Promise<string>} - Project Root
72
73
  */
73
74
  function findProjectRoot(path, sapuxRequired = true, silent = false) {
74
75
  return __awaiter(this, void 0, void 0, function* () {
@@ -93,7 +94,6 @@ exports.findProjectRoot = findProjectRoot;
93
94
  /**
94
95
  * Find app root and project root from given paths and sapux entry.
95
96
  *
96
- *
97
97
  * @param sapux - value of sapux in package.json, either boolean or string array
98
98
  * @param path - path where the search started from
99
99
  * @param root - root of the app or project, where package.json is located
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sap-ux/project-access",
3
- "version": "1.8.2",
3
+ "version": "1.8.4",
4
4
  "description": "Library to access SAP Fiori tools projects",
5
5
  "repository": {
6
6
  "type": "git",
@@ -27,7 +27,7 @@
27
27
  "findit2": "2.2.3",
28
28
  "mem-fs": "2.1.0",
29
29
  "mem-fs-editor": "9.4.0",
30
- "@sap-ux/ui5-config": "0.18.0"
30
+ "@sap-ux/ui5-config": "0.18.2"
31
31
  },
32
32
  "devDependencies": {
33
33
  "@types/mem-fs": "1.1.2",
@@ -37,7 +37,7 @@
37
37
  },
38
38
  "scripts": {
39
39
  "build": "tsc --build",
40
- "clean": "rimraf dist coverage *.tsbuildinfo",
40
+ "clean": "rimraf --glob dist coverage *.tsbuildinfo",
41
41
  "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
42
42
  "lint": "eslint . --ext .ts",
43
43
  "lint:fix": "eslint . --ext .ts --fix",