mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-07 15:17:03 +02:00
e61bd967e3
* move script to scripts folder * add docfy to router and scripts * add docfy to router and scripts * fix jsdoc syntax * add component markdown files to gitignore * improve error handling for scripts * tidy up remaining jsdoc syntax * add sample jsdoc components * add known issue info * make not using multi-line components clearer * make generating docs clearer * update copy * final how to docfy cleanup * fix ts file @module syntax * fix read more syntax * make docfy typescript compatible
19 lines
636 B
Bash
19 lines
636 B
Bash
#!/usr/bin/env bash
|
|
# Copyright (c) HashiCorp, Inc.
|
|
# SPDX-License-Identifier: BUSL-1.1
|
|
|
|
echo "Generating markdown files for components in core addon..."
|
|
|
|
# iterate over every .ts and .js file in core/addon/components (including nested files)
|
|
# skip .hbs files and shamir/ directory
|
|
find "./lib/core/addon/components" -type f ! -name "*.hbs" -not -path "*/shamir*" -print0 | while IFS= read -r -d '' file; do
|
|
component=`eval "echo $file | cut -d/ -f6"`;
|
|
|
|
# skip replication components
|
|
if [[ "$component" == replication* ]]; then
|
|
echo "🔃 skipping $component"
|
|
continue
|
|
fi
|
|
|
|
yarn docfy-md $component core $file
|
|
done |