mirror of
https://github.com/material-components/material-components-ios.git
synced 2026-02-20 08:27:32 +08:00
6733f7c44b
* Add README.md to scripts/check. * Generalized the check_components script. * Renamed `missing_readme` to `readme`. * Added documentation to the `scripts/check` directory. * Disabled the `scripts/check/missing_example_language` script. * Cleanup verbose echoing in check_components script. * Added more verbosity options. * Added check for accessible URLs. * Added option parsing. * Added left-nav checks. * Added license stanza check. * Added reporting of failed components to check_components script. * Added a script to convert between naming conventions. * Added script to check for videos. * Added check for video still. * Added script to check for site icon. * Added DO NOT SUBMIT check. * Properly quoted output file paths. * Added check for examples. * Updated checklist docs for new script setup. * Added check for example languages in README.md files. Deleted old PHP code. * Added missing exit(-1) from example_languages. * Added uniform error output to example_languages.
16 lines
823 B
Markdown
16 lines
823 B
Markdown
# Component checking scripts
|
|
|
|
Scripts in this directory check a "component" for various things. They are generally run by the
|
|
driver script `scripts/check_components`, but can be run by themselves.
|
|
|
|
## Script requirements
|
|
|
|
1. Each script should take a single directory path to a component and perform some check on the
|
|
component. For example, a script might check to see that a component has a README.md file.
|
|
* If the component passes the check, print nothing and exit with a status of zero (success).
|
|
* If the component does not pass the check, print a brief error message and exit with a non-zero
|
|
status (failure).
|
|
2. To be identified as a check script to be run by the `scripts/check_components` driver script, each
|
|
check script should be marked executable (e.g. `chmod +x check/the_check_script`).
|
|
|