10201660184

Committed 01 Aug 2024 03:57PM UTC coverage: 15.842% (-0.09%) from 15.93%

Build # 10201660184

Build Type

push

github

Committed by

web-flow

Commit Message

Simplify logger factory (#8677)

* simplify logger factory

* fix main

* fix lint

* super-randomize string pks in seed

---------

Co-authored-by: rotorsoft <rotorsoft@outlook.com>

Run Details

3572 of 21020 branches covered (16.99%)

Branch coverage included in aggregate %.

83 of 114 new or added lines in 104 files covered. (72.81%)

98 existing lines in 9 files now uncovered.

4714 of 31283 relevant lines covered (15.07%)

5.04 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/packages/commonwealth/scripts/add-component-showcase.ts

import { dispose, logger } from '@hicommonwealth/core';
import fs from 'fs';
import path from 'path';
import process from 'process';
import readlineSync from 'readline-sync';

const log = logger(import.meta);

const ComponentType = {
  Foundations: 'Foundations',
  Components: 'Components',
};

const PATH = 'client/scripts/views/pages/ComponentsShowcase';

const createComponentShowcaseFile = (displayName: string) => {
  const filePath = path.join(
    process.cwd(),
    `${PATH}/components/${displayName}.showcase.tsx`,
  );

  const reactComponentBoilerplate = `import React from 'react';

const ${displayName}Showcase = () => {
  return <>{/* ${displayName} component goes here */}</>;
};

export default ${displayName}Showcase;
`;

  fs.writeFileSync(filePath, reactComponentBoilerplate);
};

const modifyComponentsListFile = (
  displayName: string,
  componentType: string,
): void => {
  const filePath = path.join(process.cwd(), `${PATH}/componentsList.ts`);
  const fileContent = fs.readFileSync(filePath, 'utf-8');

  // eslint-disable-next-line max-len
  const newImportStatement = `import ${displayName}Showcase from 'views/pages/ComponentsShowcase/components/${displayName}.showcase';\n`;
  const contentWithImport = newImportStatement + fileContent;
  const modifiedContent = contentWithImport
    // Adds type to ComponentPageName
    .replace(
      /export const ComponentPageName = {([^}]+)}/,
      `export const ComponentPageName = {$1  ${displayName}: '${displayName}',\n}`,
    )
    // Add object to componentItems array
    .replace(
      /export const componentItems = \[([^]+)\];/,
      // eslint-disable-next-line max-len
      `export const componentItems = [$1  {\n    ComponentPage: ${displayName}Showcase,\n    displayName: ComponentPageName.${displayName},\n    type: ComponentType.${componentType},\n  },\n];`,
    );

  fs.writeFileSync(filePath, modifiedContent);

  console.log(
    `🚀 Done! '${displayName}' of type '${componentType}' is ready to go!`,
  );
};

const addComponentShowcase = () => {
  const displayName = readlineSync.question(
    '❔ What is the name of the component that will be displayed in the showcase? Use PascalCase name. ',
  );
  const componentTypeInput = readlineSync.question(
    `❔ What is the type of the component? "${ComponentType.Foundations}" or "${ComponentType.Components}"? (F/C) `,
  );

  let componentType: string;
  if (
    componentTypeInput === ComponentType.Foundations ||
    componentTypeInput.toLowerCase() === 'f'
  ) {
    componentType = ComponentType.Foundations;
  } else if (
    componentTypeInput === ComponentType.Components ||
    componentTypeInput.toLowerCase() === 'c'
  ) {
    componentType = ComponentType.Components;
  }

  // @ts-expect-error StrictNullChecks
  if (!componentType) {
    throw new Error(
      '🛑 Invalid component type. ' +
        `Please choose either "${ComponentType.Foundations}" or "${ComponentType.Components}".`,
    );
  }

  console.log(`⏱️ Creating ${displayName} of type ${componentType}...`);

  createComponentShowcaseFile(displayName);
  modifyComponentsListFile(displayName, componentType);
};

try {
  addComponentShowcase();
  // eslint-disable-next-line @typescript-eslint/no-floating-promises
  dispose()('EXIT', true);
} catch (err) {
  log.error('Failed to add component showcase', err);
  // eslint-disable-next-line @typescript-eslint/no-floating-promises
  dispose()('ERROR', true);
}

1	import { dispose, logger } from '@hicommonwealth/core';
2	import fs from 'fs';
3	import path from 'path';
4	import process from 'process';
5	import readlineSync from 'readline-sync';
6
NEW 7	const log = logger(import.meta);	×
8
9	const ComponentType = {	×
10	Foundations: 'Foundations',
11	Components: 'Components',
12	};
13
14	const PATH = 'client/scripts/views/pages/ComponentsShowcase';	×
15
16	const createComponentShowcaseFile = (displayName: string) => {	×
17	const filePath = path.join(	×
18	process.cwd(),
19	`${PATH}/components/${displayName}.showcase.tsx`,
20	);
21
22	const reactComponentBoilerplate = `import React from 'react';	×
23
24	const ${displayName}Showcase = () => {
25	return <>{/* ${displayName} component goes here */}</>;
26	};
27
28	export default ${displayName}Showcase;
29	`;
30
31	fs.writeFileSync(filePath, reactComponentBoilerplate);	×
32	};
33
34	const modifyComponentsListFile = (	×
35	displayName: string,
36	componentType: string,
37	): void => {
38	const filePath = path.join(process.cwd(), `${PATH}/componentsList.ts`);	×
39	const fileContent = fs.readFileSync(filePath, 'utf-8');	×
40
41	// eslint-disable-next-line max-len
42	const newImportStatement = `import ${displayName}Showcase from 'views/pages/ComponentsShowcase/components/${displayName}.showcase';\n`;	×
43	const contentWithImport = newImportStatement + fileContent;	×
44	const modifiedContent = contentWithImport	×
45	// Adds type to ComponentPageName
46	.replace(
47	/export const ComponentPageName = {([^}]+)}/,
48	`export const ComponentPageName = {$1 ${displayName}: '${displayName}',\n}`,
49	)
50	// Add object to componentItems array
51	.replace(
52	/export const componentItems = \[([^]+)\];/,
53	// eslint-disable-next-line max-len
54	`export const componentItems = [$1 {\n ComponentPage: ${displayName}Showcase,\n displayName: ComponentPageName.${displayName},\n type: ComponentType.${componentType},\n },\n];`,
55	);
56
57	fs.writeFileSync(filePath, modifiedContent);	×
58
59	console.log(	×
60	`🚀 Done! '${displayName}' of type '${componentType}' is ready to go!`,
61	);
62	};
63
64	const addComponentShowcase = () => {	×
65	const displayName = readlineSync.question(	×
66	'❔ What is the name of the component that will be displayed in the showcase? Use PascalCase name. ',
67	);
68	const componentTypeInput = readlineSync.question(	×
69	`❔ What is the type of the component? "${ComponentType.Foundations}" or "${ComponentType.Components}"? (F/C) `,
70	);
71
72	let componentType: string;
73	if (	×
74	componentTypeInput === ComponentType.Foundations \|\|	×
75	componentTypeInput.toLowerCase() === 'f'
76	) {
77	componentType = ComponentType.Foundations;	×
78	} else if (	×
79	componentTypeInput === ComponentType.Components \|\|	×
80	componentTypeInput.toLowerCase() === 'c'
81	) {
82	componentType = ComponentType.Components;	×
83	}
84
85	// @ts-expect-error StrictNullChecks
86	if (!componentType) {	×
87	throw new Error(	×
88	'🛑 Invalid component type. ' +
89	`Please choose either "${ComponentType.Foundations}" or "${ComponentType.Components}".`,
90	);
91	}
92
93	console.log(`⏱️ Creating ${displayName} of type ${componentType}...`);	×
94
95	createComponentShowcaseFile(displayName);	×
96	modifyComponentsListFile(displayName, componentType);	×
97	};
98
99	try {	×
100	addComponentShowcase();	×
101	// eslint-disable-next-line @typescript-eslint/no-floating-promises
102	dispose()('EXIT', true);	×
103	} catch (err) {
104	log.error('Failed to add component showcase', err);	×
105	// eslint-disable-next-line @typescript-eslint/no-floating-promises
106	dispose()('ERROR', true);	×
107	}

hicommonwealth / commonwealth / 10201660184

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous