Adrian Secord 5445fb2110 [Scripts] Add readme metadata config check (#1775)
* Added script to list the directories of our components.

* Add check for metadata to the readme check.

* Improved the output format for `list_components` on the terminal.

* Switched `check_components` script to use `list_components`.

* Update list_components
2017-08-11 10:02:19 -04:00

33 lines
1.1 KiB
Bash
Executable File

#!/bin/bash
#
# Copyright 2016-present the Material Components for iOS authors. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
readonly COMPONENT_DIR=$1
readonly README="$COMPONENT_DIR/README.md"
readonly METADATA_PATTERN="<!--docs:"
# Private components do not require a README.md.
if [[ $COMPONENT_DIR != *"/private/"* ]]; then
if [ ! -f "$README" ]; then
echo "Error: $COMPONENT_DIR is missing a README.md file."
exit -1
fi
if ! grep --quiet $METADATA_PATTERN "$README"; then
echo "Error: $README is missing configuration metadata, see https://github.com/material-components/material-components-site-generator ."
exit -1
fi
fi