tree: 2e3f92ea065d5f8c12e2671fefb7fb61174de458 [path history] [tgz]
  1. check/
  2. external/
  3. generated/
  4. install/
  5. templates/
  6. xcode/
  7. apply_all_templates
  8. apply_template
  9. build_all
  10. build_site.sh
  11. check_components
  12. clean_all
  13. convert_name
  14. export-patch
  15. format_all
  16. gendocs.sh
  17. generate_jazzy_yamls.sh
  18. generate_readme
  19. install_contributor_tools
  20. lint_all
  21. list_components
  22. manage_pods.py
  23. prep_all
  24. print_version
  25. README-release.md
  26. README.md
  27. readme_to_console
  28. release
  29. sync_icons.sh
  30. temporary_clone_at_ref
  31. test_all
  32. versionignore
scripts/README.md

Scripts

Scripts for maintaining Material Components for iOS—none of these scripts are required to use MDC or for casual contributors.

The important scripts are:

  • prep_all: prepare the Material Components catalog, tests, and demos apps for building.
  • build_all: build the Material Components catalog and each of our demo apps.
  • test_all: build and test the Material Components unit and interation tests.
  • clean_all: remove artifacts from the prep_all, build_all, and test_all scripts.
  • check_components: run component checks for documentation, examples, etc.
  • install_contributor_tools: install local contributor tools to speed up the development cycle.

Languages

Material Components follows Google's language standards for scripting. The following lanaguages can be used for scripts:

Either language can be used for a particular purpose, but larger or more complex scripts should be written in (or converted to) Python. Bash scripts get unwieldy quickly and advanced Bash scripting knowledge is currently less common than advanced Python scripting knowledge.

The intent is that the scripts will run on relatively current OS X machines with (only) Xcode installed.