@sap-ux/project-access 1.1.3 → 1.2.0

package/dist/constants.d.ts

@@ -1,6 +1,7 @@
 export declare const FileName: {
     readonly Manifest: "manifest.json";
     readonly Package: "package.json";
+    readonly Tsconfig: "tsconfig.json";
     readonly Ui5Yaml: "ui5.yaml";
     readonly Ui5LocalYaml: "ui5-local.yaml";
     readonly Ui5MockYaml: "ui5-mock.yaml";

package/dist/constants.js

@@ -4,6 +4,7 @@ exports.FileName = void 0;
 exports.FileName = {
     Manifest: 'manifest.json',
     Package: 'package.json',
+    Tsconfig: 'tsconfig.json',
     Ui5Yaml: 'ui5.yaml',
     Ui5LocalYaml: 'ui5-local.yaml',
     Ui5MockYaml: 'ui5-mock.yaml'

package/dist/file/file-search.d.ts

@@ -5,10 +5,20 @@ import type { Editor } from 'mem-fs-editor';
  * @param filename - filename to search
  * @param root - root folder to start search
  * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
- * @param fs - optional mem-fs-editor instance
+ * @param [memFs] - optional mem-fs-editor instance
  * @returns - array of paths that contain the filename
  */
-export declare function findFiles(filename: string, root: string, excludeFolders: string[], fs?: Editor): Promise<string[]>;
+export declare function findFiles(filename: string, root: string, excludeFolders: string[], memFs?: Editor): Promise<string[]>;
+/**
+ * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
+ *
+ * @param extension - file extension to search for including '.', e.g. '.ts'
+ * @param root - root folder to start search
+ * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
+ * @param [memFs] - optional mem-fs-editor instance
+ * @returns - array of file paths that have the extension
+ */
+export declare function findFilesByExtension(extension: string, root: string, excludeFolders: string[], memFs?: Editor): Promise<string[]>;
 /**
  * Find a file by name in parent folders starting from 'startPath'.
  *

package/dist/file/file-search.js

@@ -12,76 +12,102 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFileUp = exports.findFiles = void 0;
+exports.findFileUp = exports.findFilesByExtension = exports.findFiles = void 0;
 const path_1 = require("path");
 const findit2_1 = __importDefault(require("findit2"));
 const file_access_1 = require("./file-access");
 /**
- * Creates a filter function that removes files that have been deleted in an instance of a mem-fs-editor.
+ * Get deleted and modified files from mem-fs editor filtered by query and 'by' (name|extension).
  *
- * @param changes - changes recorded in an instance of a mem-fs-editor
- * @param filename - relevant filename
- * @returns a filter function for string arrays
+ * @param changes - memfs editor changes, usually retrieved by fs.dump()
+ * @param query - search string, file name or file extension
+ * @param by - search by file 'name' or file 'extension'
+ * @returns - array of deleted and modified files filtered by query
  */
-function getMemFsFilter(changes, filename) {
-    const deleted = Object.entries(changes)
-        .filter(([, info]) => info.state === 'deleted')
-        .map(([file]) => (0, path_1.join)((0, path_1.basename)((0, path_1.join)(file)) === filename ? (0, path_1.dirname)(file) : file));
-    return (path) => !deleted.find((entry) => path.startsWith(entry));
-}
-/**
- * Concatanates the given list of files with additional files that have been created using a mem-fs-editor and matching the filename.
- *
- * @param folders - existing list of folders
- * @param changes - changes recorded in an instance of a mem-fs-editor
- * @param filename - relevant filename
- * @returns Concatanated and deduped list of folders containing the given filename
- */
-function concatNewFoldersFromMemFs(folders, changes, filename) {
-    const modified = Object.entries(changes)
-        .filter(([file, info]) => info.state === 'modified' && (0, path_1.basename)((0, path_1.join)(file)) === filename)
-        .map(([file]) => (0, path_1.dirname)((0, path_1.join)(file)));
-    return [...new Set([...folders, ...modified])];
+function getMemFsChanges(changes, query, by) {
+    const deleted = [];
+    const modified = [];
+    const getFilePartToCompare = by === 'extension' ? path_1.extname : path_1.basename;
+    for (const file of Object.keys(changes).filter((f) => getFilePartToCompare(f) === query)) {
+        if (changes[file].state === 'deleted') {
+            deleted.push((0, path_1.join)(file));
+        }
+        if (changes[file].state === 'modified') {
+            modified.push((0, path_1.join)(file));
+        }
+    }
+    return { deleted, modified };
 }
 /**
- * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
+ * Find function to search for files.
  *
- * @param filename - filename to search
- * @param root - root folder to start search
- * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
- * @param fs - optional mem-fs-editor instance
- * @returns - array of paths that contain the filename
+ * @param options - find options
+ * @param options.query - search string
+ * @param options.by - search by file 'name' or file 'extension'
+ * @param options.root - folder to start recursive search
+ * @param options.excludeFolders - folder names to exclude
+ * @param [options.memFs] - optional memfs editor instance
+ * @returns - array of paths that contain the file if searched for name; array of full file paths in case of search by extension
  */
-function findFiles(filename, root, excludeFolders, fs) {
+function findBy(options) {
+    const getFilePartToCompare = options.by === 'extension' ? path_1.extname : path_1.basename;
     return new Promise((resolve, reject) => {
         const results = [];
-        const finder = (0, findit2_1.default)(root);
+        const finder = (0, findit2_1.default)(options.root);
         finder.on('directory', (dir, _stat, stop) => {
             const base = (0, path_1.basename)(dir);
-            if (excludeFolders.includes(base)) {
+            if (options.excludeFolders.includes(base)) {
                 stop();
             }
         });
         finder.on('file', (file) => {
-            if (file.endsWith(path_1.sep + filename)) {
-                results.push((0, path_1.dirname)(file));
+            if (getFilePartToCompare(file) === options.query) {
+                results.push(file);
             }
         });
         finder.on('end', () => {
-            if (fs) {
-                const changes = fs.dump('');
-                resolve(concatNewFoldersFromMemFs(results, changes, filename).filter(getMemFsFilter(changes, filename)));
+            let searchResult = results;
+            if (options.memFs) {
+                const { modified, deleted } = getMemFsChanges(options.memFs.dump(''), options.query, options.by);
+                const merged = Array.from(new Set([...results, ...modified]));
+                searchResult = merged.filter((f) => !deleted.includes(f));
             }
-            else {
-                resolve(results);
+            if (options.by === 'name') {
+                searchResult = searchResult.map((f) => (0, path_1.dirname)(f));
             }
+            resolve(searchResult);
         });
         finder.on('error', (error) => {
             reject(error);
         });
     });
 }
+/**
+ * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
+ *
+ * @param filename - filename to search
+ * @param root - root folder to start search
+ * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
+ * @param [memFs] - optional mem-fs-editor instance
+ * @returns - array of paths that contain the filename
+ */
+function findFiles(filename, root, excludeFolders, memFs) {
+    return findBy({ query: filename, by: 'name', root, excludeFolders, memFs });
+}
 exports.findFiles = findFiles;
+/**
+ * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
+ *
+ * @param extension - file extension to search for including '.', e.g. '.ts'
+ * @param root - root folder to start search
+ * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
+ * @param [memFs] - optional mem-fs-editor instance
+ * @returns - array of file paths that have the extension
+ */
+function findFilesByExtension(extension, root, excludeFolders, memFs) {
+    return findBy({ query: extension, by: 'extension', root, excludeFolders, memFs });
+}
+exports.findFilesByExtension = findFilesByExtension;
 /**
  * Find a file by name in parent folders starting from 'startPath'.
  *

package/dist/file/index.d.ts

@@ -1,3 +1,3 @@
 export { fileExists, readFile, readJSON } from './file-access';
-export { findFiles, findFileUp } from './file-search';
+export { findFiles, findFilesByExtension, findFileUp } from './file-search';
 //# sourceMappingURL=index.d.ts.map

package/dist/file/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFileUp = exports.findFiles = exports.readJSON = exports.readFile = exports.fileExists = void 0;
+exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.readJSON = exports.readFile = exports.fileExists = void 0;
 var file_access_1 = require("./file-access");
 Object.defineProperty(exports, "fileExists", { enumerable: true, get: function () { return file_access_1.fileExists; } });
 Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return file_access_1.readFile; } });
 Object.defineProperty(exports, "readJSON", { enumerable: true, get: function () { return file_access_1.readJSON; } });
 var file_search_1 = require("./file-search");
 Object.defineProperty(exports, "findFiles", { enumerable: true, get: function () { return file_search_1.findFiles; } });
+Object.defineProperty(exports, "findFilesByExtension", { enumerable: true, get: function () { return file_search_1.findFilesByExtension; } });
 Object.defineProperty(exports, "findFileUp", { enumerable: true, get: function () { return file_search_1.findFileUp; } });
 //# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { FileName } from './constants';
-export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject } from './project';
+export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject } from './project';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,13 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.FileName = void 0;
+exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 var project_1 = require("./project");
 Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return project_1.findAllApps; } });
 Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return project_1.findProjectRoot; } });
 Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return project_1.getAppRootFromWebappPath; } });
+Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return project_1.getAppProgrammingLanguage; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return project_1.getCapModelAndServices; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return project_1.getCapProjectType; } });
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return project_1.getWebappPath; } });

package/dist/project/index.d.ts

@@ -1,4 +1,5 @@
 export { getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject } from './cap';
+export { getAppProgrammingLanguage } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findProjectRoot, getAppRootFromWebappPath } from './search';
 export { getWebappPath } from './ui5-config';

package/dist/project/index.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
+exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return cap_1.getCapProjectType; } });
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return cap_1.isCapJavaProject; } });
 Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return cap_1.isCapNodeJsProject; } });
+var info_1 = require("./info");
+Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return info_1.getAppProgrammingLanguage; } });
 var module_loader_1 = require("./module-loader");
 Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return module_loader_1.loadModuleFromProject; } });
 var search_1 = require("./search");

package/dist/project/info.d.ts

@@ -0,0 +1,11 @@
+import type { Editor } from 'mem-fs-editor';
+import type { AppProgrammingLanguage } from '../types';
+/**
+ * Get the used programming language of an application.
+ *
+ * @param appRoot - root folder of the application
+ * @param [memFs] - optional mem-fs editor instance
+ * @returns - used language, JavaScript or TypeScript
+ */
+export declare function getAppProgrammingLanguage(appRoot: string, memFs?: Editor): Promise<AppProgrammingLanguage>;
+//# sourceMappingURL=info.d.ts.map

package/dist/project/info.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppProgrammingLanguage = void 0;
+const path_1 = require("path");
+const constants_1 = require("../constants");
+const file_1 = require("../file");
+const ui5_config_1 = require("./ui5-config");
+/**
+ * Get the used programming language of an application.
+ *
+ * @param appRoot - root folder of the application
+ * @param [memFs] - optional mem-fs editor instance
+ * @returns - used language, JavaScript or TypeScript
+ */
+function getAppProgrammingLanguage(appRoot, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ignoreFolders = ['node_modules', '.git'];
+        let appLanguage = '';
+        try {
+            const webappPath = yield (0, ui5_config_1.getWebappPath)(appRoot, memFs);
+            if (yield (0, file_1.fileExists)(webappPath, memFs)) {
+                if ((yield (0, file_1.fileExists)((0, path_1.join)(appRoot, constants_1.FileName.Tsconfig), memFs)) &&
+                    (yield (0, file_1.findFilesByExtension)('.ts', webappPath, ignoreFolders, memFs)).length > 0) {
+                    appLanguage = 'TypeScript';
+                }
+                else if ((yield (0, file_1.findFilesByExtension)('.js', webappPath, ignoreFolders, memFs)).length > 0) {
+                    appLanguage = 'JavaScript';
+                }
+            }
+        }
+        catch (_a) {
+            // could not detect app language
+        }
+        return appLanguage;
+    });
+}
+exports.getAppProgrammingLanguage = getAppProgrammingLanguage;
+//# sourceMappingURL=info.js.map

package/dist/project/ui5-config.d.ts

@@ -1,8 +1,10 @@
+import type { Editor } from 'mem-fs-editor';
 /**
  * Get path to webapp.
  *
  * @param projectRoot - root path, where package.json or ui5.yaml is
+ * @param [memFs] - optional mem-fs editor instance
  * @returns - path to webapp folder
  */
-export declare function getWebappPath(projectRoot: string): Promise<string>;
+export declare function getWebappPath(projectRoot: string, memFs?: Editor): Promise<string>;
 //# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -18,15 +18,16 @@ const file_1 = require("../file");
  * Get path to webapp.
  *
  * @param projectRoot - root path, where package.json or ui5.yaml is
+ * @param [memFs] - optional mem-fs editor instance
  * @returns - path to webapp folder
  */
-function getWebappPath(projectRoot) {
+function getWebappPath(projectRoot, memFs) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         let webappPath = (0, path_1.join)(projectRoot, 'webapp');
         const ui5YamlPath = (0, path_1.join)(projectRoot, constants_1.FileName.Ui5Yaml);
-        if (yield (0, file_1.fileExists)(ui5YamlPath)) {
-            const yamlString = yield (0, file_1.readFile)(ui5YamlPath);
+        if (yield (0, file_1.fileExists)(ui5YamlPath, memFs)) {
+            const yamlString = yield (0, file_1.readFile)(ui5YamlPath, memFs);
             const ui5Config = yield ui5_config_1.UI5Config.newInstance(yamlString);
             const relativeWebappPath = (_b = (_a = ui5Config.getConfiguration()) === null || _a === void 0 ? void 0 : _a.paths) === null || _b === void 0 ? void 0 : _b.webapp;
             if (relativeWebappPath) {

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from './cap';
-export * from './package';
 export * from './find';
+export * from './info';
+export * from './package';
 export * from './vscode';
 export * from './webapp';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

@@ -15,8 +15,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./cap"), exports);
-__exportStar(require("./package"), exports);
 __exportStar(require("./find"), exports);
+__exportStar(require("./info"), exports);
+__exportStar(require("./package"), exports);
 __exportStar(require("./vscode"), exports);
 __exportStar(require("./webapp"), exports);
 //# sourceMappingURL=index.js.map

package/dist/types/info/index.d.ts

@@ -0,0 +1,2 @@
+export type AppProgrammingLanguage = 'JavaScript' | 'TypeScript' | '';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/info/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",