Class ApiScraping
Methods for invoking and validating API Scraper
Namespace: Unity.Coding.Editor.ApiScraping
Syntax
public static class ApiScrapingMethods
Scrape()
Scrape public API based on .editorconfig rules. Rules in .editorconfig are defined as sections with glob patterns matching .asmdef files in the project.
Examples enabling API scraping for all assemblies: [*.asmdef] scrape_api = true
Examples disabling API scraping for assemblies in Test folders: [/Tests/.asmdef] scrape_api = false
Declaration
public static void Scrape()ValidateAllFilesScraped(List<String>)
Validate if all .api files match the current state of public API in the codebase. If false, the .api files can be regenerated with ApiScraping.Scrape method or by configuring API Scraper to run automatically.
Declaration
public static bool ValidateAllFilesScraped(List<string> failedFileList)Parameters
| Type | Name | Description |
|---|---|---|
| List<String> | failedFileList | List of paths to files that failed validation. |
Returns
| Type | Description |
|---|---|
| Boolean |