runChecks

Осуществите все проверки проекта

Синтаксис

checkResults = runChecks(proj)

Описание

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

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

Примеры

свернуть все

Исключите проверку производных файлов и осуществленные проверки проекта

Откройте Табличный проект Приложения "Таймс". Использование 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      "Model files saved in a different format (MDL or SLX) are added to the project.↵The original files are not currently in the project."    "Project:Checks:MDLToSLX"

Осуществите все проверки проекта

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

Входные параметры

свернуть все

`proj` — Проект
`matlab.project.Project` объект

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