Skip to content

Commit

Permalink
[INTERNAL] Enhance TODO / jsdoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
matz3 committed Mar 10, 2023
1 parent 2e5306d commit dfb837e
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions lib/graph/helpers/ui5Framework.js
Original file line number Diff line number Diff line change
Expand Up @@ -209,14 +209,16 @@ const utils = {
}
},
/**
* This logic needs to stay in sync with the @sapui5/distribution-metadata package
* This logic needs to stay in sync with the dependency definitions for the
* sapui5/distribution-metadata package.
*
* @param project
* @param {@ui5/project/specifications/Project} project
*/
async getFrameworkLibraryDependencies(project) {
let dependencies = [];
let optionalDependencies = [];

// TODO: Add getter for ID
if (project.__id.startsWith("@sapui5/")) {
project.getFrameworkDependencies().forEach((dependency) => {
if (dependency.optional) {
Expand All @@ -241,7 +243,6 @@ const utils = {

return {dependencies, optionalDependencies};
},

async getWorkspaceFrameworkLibraryMetadata({workspace, projectGraph}) {
const libraryMetadata = Object.create(null);
const {projectNameMap} = await workspace._getResolvedModules(); // TODO: private API usage
Expand Down Expand Up @@ -294,7 +295,8 @@ export default {
let version = options.versionOverride || frameworkVersion;

if (rootProject.isFrameworkProject() && !version) {
// TODO: Also take workspace into account
// TODO: Also take workspace into account:
// Version should not be mandatory if all framework dependencies are part of the workspace

// If the root project is a framework project and no framework version is defined,
// all framework dependencies must already be part of the graph
Expand Down

0 comments on commit dfb837e

Please sign in to comment.