runChecks

Запуск всех проверок проекта

Свернуть все на странице

Синтаксис

checkResults = runChecks(proj)

Описание

пример

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

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

Примеры

свернуть все

Откройте проект Times Table App. Использовать 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 App. Использовать 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

Документация MATLAB

Поддержка

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