exponenta event banner

runChecks

Выполнить все проверки проекта

Описание

пример

checkResults = runChecks(proj) выполняет проверки для указанного проекта. Проверки обнаруживают проблемы с целостностью проекта, такие как недостающие файлы, неспасенные файлы, файлы не под исходным контролем или устаревшими полученными файлами.

Для проверки актуальности производных файлов необходимо обновить зависимости проекта. Для крупных проектов это может занять много времени. Чтобы исключить производные файлы, не обновляйте зависимости перед вызовом runchecks.

Примеры

свернуть все

Откройте проект приложения Times Table. Использовать currentProject для создания объекта проекта из загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

Для крупных проектов выполните все проверки проекта, за исключением проверки производных файлов, поскольку это может занять много времени.

checkResults = runChecks(proj)
 checkResults = 

  11×1 ProjectCheckResult array with properties:

    ID
    Description
    Passed
    ProblemFiles

Создание таблицы из checkResults массив. В таблице показано, что проверка производных файлов не выполнялась.

summary = table(checkResults)
  summary =

  11×3 table

    Passed                                                   Description                                                                               ID                            
    ______    __________________________________________________________________________________________________________    _________________________________________________________

    true      "All project definition files are under source control."                                                      "Project:Checks:ProjectDefinitionFilesUnderSourceControl"
    true      "All files in the project are under source control."                                                          "Project:Checks:AllProjectFilesUnderSourceControl"       
    true      "All files under source control are in the project."                                                          "Project:Checks:AllFilesUnderSourceControlInProject"     
    true      "All project folders exist."                                                                                  "Project:Checks:ProjectFoldersExist"                     
    true      "All project files exist on the file system."                                                                 "Project:Checks:ProjectFilesExist"                       
    true      "All project folders on the MATLAB search path are on the project path."                                      "Project:Checks:ProjectPath"                             
    true      "All projects in sub-folders are referenced by this project."                                                 "Project:Checks:ReferencedSubprojects"                   
    true      "Check for project files with unsaved changes."                                                               "Project:Checks:UnsavedProjectFiles"                     
    false     "All derived files in the project are up-to-date."                                                            "Project:Checks:OutOfDateDerivedFiles"                   
    true      "There are no slprj or sfprj folders in the project."                                                         "Project:Checks:SLPRJ"                                   
    true      "New SLX files are added to the project and that the original MDL files are not currently in the project."    "Project:Checks:MDLToSLX" 

Откройте проект приложения Times Table. Использовать currentProject для создания объекта проекта из загруженного проекта.

matlab.project.example.timesTable
proj = currentProject;

Для проверки актуальности производных файлов необходимо сначала обновить зависимости проекта.

updateDependencies(proj);

Выполните все проверки проекта.

checkResults = runChecks(proj)
 checkResults = 

  11×1 ProjectCheckResult array with properties:

    ID
    Description
    Passed
    ProblemFiles

Используйте ID, Passed, и ProblemFiles для получения информации о первой проверке. Первая проверка прошла и проблем не обнаружила. Все файлы определений проекта находятся в системе управления версиями.

id = checkResults(1).ID
status = checkResults(1).Passed
problems = checkResults(1).ProblemFiles
id = 

    "Project:Checks:ProjectDefinitionFilesUnderSourceControl"


status =

  logical

   1


problems = 

  0×0 empty string array

Проверка на наличие производных файлов прошла проверку и не обнаружила ошибок. Все производные файлы обновлены.

id = checkResults(9).ID
status = checkResults(9).Passed
problems = checkResults(1).ProblemFiles
id = 

    "Project:Checks:OutOfDateDerivedFiles"


status =

  logical

   1


problems = 

  0×0 empty string array

Входные аргументы

свернуть все

Проект, указанный как matlab.project.Project объект. Использовать currentProject для создания объекта проекта из загруженного проекта.

Выходные аргументы

свернуть все

Проверки проекта, возвращаемые в виде массива ProjectCheckResult объекты со свойствами.

Представлен в R2020a