Merge pull request #56 from Ruchika30/add-optional-emojis

feat: added optional title prop

Author: mergify[bot]

src/components/ContributingSection.test.tsx

@@ -8,6 +8,9 @@ describe("ContributingSection", () => {
     expect(await render(<ContributingSection />)).toContain(
       "## 🖋️ Contributing\n"
     );
+    expect(
+      await render(<ContributingSection title="Contributing" />)
+    ).toContain("## Contributing\n");
   });
 
   it("renders sentence with a link to the contributing file", async () => {

src/components/ContributingSection.tsx

@@ -5,15 +5,16 @@ import MD, { Fragment, Heading, LineBreak, Link, Text } from "jsx-md";
 /** @internal */
 interface Props {
   contributingFilePath?: string;
+  title?: string;
 }
-
 /** Displays a contributing section based on optional contributing file path. */
 export const ContributingSection: Component<Props> = ({
   contributingFilePath = "./CONTRIBUTING.md",
+  title = "🖋️ Contributing",
 }: Props) => {
   return (
     <Fragment>
-      <Heading level={2}>🖋️ Contributing</Heading>
+      <Heading level={2}>{title}</Heading>
       <Text>
         If you are interested in contributing to this repository, please read up
         on the details in our

src/components/ExamplesFromPkg.test.tsx

@@ -29,6 +29,10 @@ describe("ExamplesFromPkg", () => {
       expect(await render(<ExamplesFromPkg pkg={pkg} />)).toContain(
         "## 🔬 Examples\n"
       );
+
+      expect(
+        await render(<ExamplesFromPkg pkg={pkg} title="Examples" />)
+      ).toContain("## Examples\n");
     });
 
     it("renders the example.json file as an ExampleFile", async () => {

src/components/ExamplesFromPkg.tsx

@@ -11,6 +11,7 @@ interface Props {
   encoding?: BufferEncoding;
   replacePackageImportsWithPackageName?: boolean;
   pkg: PackageJSON;
+  title?: string;
 }
 
 /** Show all files from the example directory defined in package.json.² */
@@ -21,6 +22,7 @@ export const ExamplesFromPkg: Component<Props> = awaitComponent(
     encoding = "utf8",
     /** Whether to replace all imports from '..' with imports from 'package-name' */
     replacePackageImportsWithPackageName = true,
+    title = "🔬 Examples",
   }) => {
     const examplesFolder = pkg.directories?.example;
     if (examplesFolder === undefined) {
@@ -48,7 +50,7 @@ export const ExamplesFromPkg: Component<Props> = awaitComponent(
 
     return (
       <Fragment>
-        <Heading level={2}>🔬 Examples</Heading>
+        <Heading level={2}>{title}</Heading>
         {examples
           .sort(({ fileName: fileNameA }, { fileName: fileNameB }) =>
             fileNameA.localeCompare(fileNameB, "en", { sensitivity: "base" })

src/components/HomepageFromPkg.test.tsx

@@ -15,6 +15,10 @@ describe("HomepageFromPkg", () => {
       homepage: "https://dbartholomae.github.io/jsx-readme",
       name: "test-package",
     };
+    expect(
+      await render(<HomepageFromPkg pkg={pkg} title="Homepage" />)
+    ).toContain("## Homepage\n");
+
     expect(await render(<HomepageFromPkg pkg={pkg} />)).toContain(
       "## 🏠 Homepage\n"
     );

src/components/HomepageFromPkg.tsx

@@ -6,19 +6,21 @@ import type { PackageJSON } from "../PackageJSON";
 /** @internal */
 interface Props {
   pkg: Readonly<PackageJSON>;
+  title?: string;
 }
 
 /** Display a section linking to the homepage defined in package.json */
 export const HomepageFromPkg: Component<Readonly<Props>> = ({
   pkg: { homepage },
+  title = "🏠 Homepage",
 }) => {
   if (homepage === undefined) {
     return null;
   }
 
   return (
     <Fragment>
-      <Heading level={2}>🏠 Homepage</Heading>
+      <Heading level={2}>{title}</Heading>
       You can find more about this on <Link to={homepage}>{homepage}</Link>.
       <LineBreak />
       <LineBreak />

src/components/LicenseFromPkg.test.tsx

@@ -15,6 +15,10 @@ describe("LicenseFromPkg", () => {
       name: "test-package",
       license: "MIT",
     };
+    expect(
+      await render(<LicenseFromPkg pkg={pkg} title="License" />)
+    ).toContain("## License\n");
+
     expect(await render(<LicenseFromPkg pkg={pkg} />)).toContain(
       "## 📜 License\n"
     );

src/components/LicenseFromPkg.tsx

@@ -7,20 +7,22 @@ import type { PackageJSON } from "../PackageJSON";
 interface Props {
   licenseFilePath?: string;
   pkg: Readonly<PackageJSON>;
+  title?: string;
 }
 
 /** Display a section indicating the license defined in package.json */
 export const LicenseFromPkg: Component<Readonly<Props>> = ({
   pkg: { license },
   licenseFilePath = "./LICENSE",
+  title = "📜 License",
 }) => {
   if (license === undefined) {
     return null;
   }
 
   return (
     <Fragment>
-      <Heading level={2}>📜 License</Heading>
+      <Heading level={2}>{title}</Heading>
       {license}. See <Link to={licenseFilePath}>LICENSE file</Link> for details.
       <LineBreak />
       <LineBreak />