listImpactedFiles

Get files impacted by changes to specified project files

Since R2021a

collapse all in page

Syntax

impactedfiles = listImpactedFiles(proj,files)
impactedfiles = listImpactedFiles(proj,files,Name=Value)

Description

impactedfiles = listImpactedFiles(proj,files) returns the names of the project files that require the specified files to run.

example

impactedfiles = listImpactedFiles(proj,files,Name=Value) specifies additional options as one or more name-value arguments. For example, to find the impact files only in the specified project proj, set the AnalyzeReferences argument to false.

example

Examples

collapse all

Open the Times Table App project. Use currentProject to create a project object.

openExample("matlab/TimesTableProjectExample")
proj = currentProject;

Make a change to timesTableGame.m.

fid = fopen('source/timesTableGame.m','a');
fwrite(fid,'% Add simple comment');
fclose(fid)

Get the files impacted by the modified files.

modifiedfiles = listModifiedFiles(proj);
impactedfiles = listImpactedFiles(proj,modifiedfiles)
impactedfiles = 

  6×1 string array

    "C:\workSpace\examples\TimesTableApp\requirements\TimesTableRequirements.mlx"
    "C:\workSpace\examples\TimesTableApp\source\timesTableGame.m"
    "C:\workSpace\examples\TimesTableApp\source\timestable.mlapp"
    "C:\workSpace\examples\TimesTableApp\tests\tAnswerIsCorrect.m"
    "C:\workSpace\examples\TimesTableApp\tests\tCurrentQuestion.m"
    "C:\workSpace\examples\TimesTableApp\tests\tNewTimesTable.m"

Open a project that references other projects. Use currentProject to create a project object.

openProject("example/project/path")
proj = currentProject;

Get the files impacted by a change to the myscript file and that belong only to the open project.

file = "source/myscript"
requiredfiles = listImpactedFiles(proj,file,AnalyzeReferences=false);

Input Arguments

collapse all

Project, specified as a matlab.project.Project object. Use currentProject to create a project object from the currently loaded project.

Path of project files including file extensions, specified as a cell array of character vectors, a string array, or a ProjectFile object array. Specify files as absolute file paths or paths relative to the project root folder. The files must be within the project root folder.

Name-Value Arguments

collapse all

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: listImpactedFiles(proj,AnalyzeReferences=true,UpdateDependencies=false)

Option to look for files inside referenced projects, specified as a numeric or logical 1 (true) or 0 (false).

Data Types: logical

Option to update dependencies before running the analysis, specified as a numeric or logical 1 (true) or 0 (false).

Setting UpdateDependencies to false runs a faster analysis but does not update the graph information. If a lot of files changed since the last dependency analysis, for accurate results, set UpdateDependencies to true.

Data Types: logical

Output Arguments

collapse all

Impacted project files, returned as a string array.

Version History

Introduced in R2021a

expand all

See Also

| |

Topics