paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 46 Packages Projects Releases Wiki Activity

Got rid of the last brace-typed and hyphen-less params etc

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-01-09 15:56:07 +01:00
parent c8ff2df05a
commit 5333451def
72 changed files with 247 additions and 423 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/scaffolder/api-report.md
-5
View File
@@ -90,7 +90,6 @@ export const EntityTagsPicker: ({
// @public
export const EntityTagsPickerFieldExtension: () => null;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "FavouriteTemplate" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -179,8 +178,6 @@ export interface ScaffolderApi {
//
// (undocumented)
listActions(): Promise<ListActionsResponse>;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
// Warning: (ae-forgotten-export) The symbol "LogEvent" needs to be exported by the entry point index.d.ts
//
@@ -225,8 +222,6 @@ export class ScaffolderClient implements ScaffolderApi {
): Promise<TemplateParameterSchema>;
// (undocumented)
listActions(): Promise<ListActionsResponse>;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
// (undocumented)
streamLogs(opts: { taskId: string; after?: number }): Observable<LogEvent>;
plugins/scaffolder/src/api.ts
+4 -4
View File
@@ -67,8 +67,8 @@ export interface ScaffolderApi {
* Executes the scaffolding of a component, given a template and its
* parameter values.
*
* @param templateName Name of the Template entity for the scaffolder to use. New project is going to be created out of this template.
* @param values Parameters for the template, e.g. name, description
* @param templateName - Name of the Template entity for the scaffolder to use. New project is going to be created out of this template.
* @param values - Parameters for the template, e.g. name, description
*/
scaffold(templateName: string, values: Record<string, any>): Promise<string>;
@@ -149,8 +149,8 @@ export class ScaffolderClient implements ScaffolderApi {
* Executes the scaffolding of a component, given a template and its
* parameter values.
*
* @param templateName Template name for the scaffolder to use. New project is going to be created out of this template.
* @param values Parameters for the template, e.g. name, description
* @param templateName - Template name for the scaffolder to use. New project is going to be created out of this template.
* @param values - Parameters for the template, e.g. name, description
*/
async scaffold(
templateName: string,
plugins/scaffolder/src/components/FavouriteTemplate/FavouriteTemplate.tsx
+1 -1
View File
@@ -52,7 +52,7 @@ export const favouriteTemplateIcon = (isStarred: boolean) =>
/**
* IconButton for showing if a current entity is starred and adding/removing it from the favourite entities
* @param props MaterialUI IconButton props extended by required `entity` prop
* @param props - MaterialUI IconButton props extended by required `entity` prop
*/
export const FavouriteTemplate = (props: Props) => {
const classes = useStyles();