mirror of
https://github.com/hashicorp/vault.git
synced 2025-08-07 07:07:05 +02:00
0b12cdcfd1
* Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Adding explicit MPL license for sub-package. This directory and its subdirectories (packages) contain files licensed with the MPLv2 `LICENSE` file in this directory and are intentionally licensed separately from the BSL `LICENSE` file at the root of this repository. * Updating the license from MPL to Business Source License. Going forward, this project will be licensed under the Business Source License v1.1. Please see our blog post for more details at https://hashi.co/bsl-blog, FAQ at www.hashicorp.com/licensing-faq, and details of the license at www.hashicorp.com/bsl. * add missing license headers * Update copyright file headers to BUS-1.1 * Fix test that expected exact offset on hcl file --------- Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com> Co-authored-by: Sarah Thompson <sthompson@hashicorp.com> Co-authored-by: Brian Kassouf <bkassouf@hashicorp.com>
46 lines
1.6 KiB
JavaScript
Executable File
46 lines
1.6 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
/**
|
|
* Copyright (c) HashiCorp, Inc.
|
|
* SPDX-License-Identifier: BUSL-1.1
|
|
*/
|
|
|
|
/* eslint-disable */
|
|
// run this script via yarn in the ui directory:
|
|
// yarn gen-story-md some-component
|
|
//
|
|
// or if the story is for a component in an in-repo-addon or an engine:
|
|
// yarn gen-story-md some-component name-of-engine
|
|
|
|
const fs = require('fs');
|
|
const jsdoc2md = require('jsdoc-to-markdown');
|
|
var args = process.argv.slice(2);
|
|
const name = args[0];
|
|
const addonOrEngine = args[1];
|
|
const inputFile = addonOrEngine
|
|
? `lib/${addonOrEngine}/addon/components/${name}.js`
|
|
: `app/components/${name}.js`;
|
|
const outputFile = addonOrEngine ? `lib/${addonOrEngine}/stories/${name}.md` : `stories/${name}.md`;
|
|
|
|
const component = name
|
|
.split('-')
|
|
.map((word) => word.charAt(0).toUpperCase() + word.slice(1))
|
|
.join('');
|
|
const options = {
|
|
files: inputFile,
|
|
template: fs.readFileSync('./lib/story-md.hbs', 'utf8'),
|
|
'example-lang': 'js',
|
|
};
|
|
let md = jsdoc2md.renderSync(options);
|
|
|
|
const pageBreakIndex = md.lastIndexOf('---'); //this is our last page break
|
|
|
|
const seeLinks = `**See**
|
|
- [Uses of ${component}](https://github.com/hashicorp/vault/search?l=Handlebars&q=${component}+OR+${name})
|
|
- [${component} Source Code](https://github.com/hashicorp/vault/blob/main/ui/${inputFile})
|
|
`;
|
|
const generatedWarning = `<!--THIS FILE IS AUTO GENERATED. This file is generated from JSDoc comments in ${inputFile}. To make changes, first edit that file and run "yarn gen-story-md ${name}" to re-generate the content.-->
|
|
`;
|
|
md = generatedWarning + md.slice(0, pageBreakIndex) + seeLinks + md.slice(pageBreakIndex);
|
|
|
|
fs.writeFileSync(outputFile, md);
|