refactor: updated create readme and license function (#77)

defi-wonderland · Oct 20, 2023 · 24e0149 · 24e0149
1 parent 1863726
commit 24e0149
Show file tree

Hide file tree

Showing 5 changed files with 103 additions and 14 deletions.
diff --git a/dist/index.js b/dist/index.js
diff --git a/dist/index.js.map b/dist/index.js.map
diff --git a/src/createPackage.ts b/src/createPackage.ts
@@ -26,8 +26,7 @@ export const createPackage = (
   fse.emptyDirSync(exportDir);
   fse.writeJsonSync(`${exportDir}/package.json`, packageJson, { spaces: 4 });
 
-  createReadmeAndLicense(packageJson.name, typingType, exportDir);
-
+  let interfaceName = '';
   // list all of the solidity interfaces
   glob(interfacesGlob, (err, interfacePaths) => {
     if (err) throw err;
@@ -41,7 +40,7 @@ export const createPackage = (
       fse.outputFileSync(path.join(interfacesDestination, contractPath), relativeInterfaceFile);
 
       // get the interface name
-      const interfaceName = interfacePath.substring(interfacePath.lastIndexOf('/') + 1, interfacePath.lastIndexOf('.'));
+      interfaceName = interfacePath.substring(interfacePath.lastIndexOf('/') + 1, interfacePath.lastIndexOf('.'));
 
       // copy interface abi to the export directory
       fse.copySync(`${outDir}/${interfaceName}.sol/${interfaceName}.json`, `${abiDestination}/${interfaceName}.json`);
@@ -66,6 +65,8 @@ export const createPackage = (
       });
     }
 
+    createReadmeAndLicense(packageJson.name, typingType, exportDir, interfaceName);
+
     // install package dependencies
     console.log(`Installing abi dependencies`);
     execSync(`cd ${exportDir} && yarn`);

diff --git a/src/createReadmeAndLicense.ts b/src/createReadmeAndLicense.ts
@@ -2,12 +2,20 @@ import fse from 'fs-extra';
 import { TypingType } from './constants';
 import { publicTypeLabels } from './types';
 
-export const createReadmeAndLicense = (packageName: string, typingType: TypingType, exportDir: string) => {
+export const createReadmeAndLicense = (
+  packageName: string,
+  typingType: TypingType,
+  exportDir: string,
+  sampleInterfaceName: string,
+) => {
   const readmeContent = `
+  [![npm version](https://img.shields.io/npm/v/${packageName}/latest.svg)](https://www.npmjs.com/package/${packageName}/v/latest)
+
   # ${packageName}
 
-  ${packageName} offers ${publicTypeLabels[typingType]} for seamless interactions with smart contracts. Integrate these interfaces effortlessly into your projects.
-  
+  ${packageName} offers support for ${publicTypeLabels[typingType]} typing for seamless interactions with smart contracts. 
+  Integrate these interfaces effortlessly into your projects.
+
   ## Installation
   
   You can easily install this package using either npm or yarn:
@@ -22,6 +30,25 @@ export const createReadmeAndLicense = (packageName: string, typingType: TypingTy
   npm install ${packageName}
   \`\`\`
   
+
+  ## Usage
+
+  This is an example of how you can import an interface:
+
+  \`\`\`typescript
+  import { ${sampleInterfaceName} } from '${packageName}';
+  \`\`\`
+
+  And then you can interact with it in the way you need.
+
+  ## Repository
+
+  To learn more about this package, please visit the [interface-exporter-action-private](https://github.com/defi-wonderland/interface-exporter-action-private) repo.
+
+  ## Contributors
+
+  Maintained with love by [Wonderland](https://defi.sucks). Made possible by viewers like you.
+
   ## License
   
   ${packageName} is licensed under the [MIT License](LICENSE).

diff --git a/test/unit/createReadmeAndLicense.spec.ts b/test/unit/createReadmeAndLicense.spec.ts
@@ -16,7 +16,44 @@ describe('createReadmeAndLicense', () => {
 
   it('should create abi README.MD file with correct package name', () => {
     const packageName = 'test-package';
-    createReadmeAndLicense(packageName, TypingType.ABI, exportDir);
+    const sampleInterface = 'ISampleInterface';
+    createReadmeAndLicense(packageName, TypingType.ABI, exportDir, sampleInterface);
+
+    const readmePath = `${exportDir}/README.MD`;
+    expect(fse.existsSync(readmePath)).to.be.true;
+
+    const readmeContent = fse.readFileSync(readmePath, 'utf8');
+    expect(readmeContent).to.include(`# ${packageName}`);
+  });
+
+  it('should create ethers v6 README.MD file with correct package name', () => {
+    const packageName = 'test-package';
+    const sampleInterface = 'ISampleInterface';
+    createReadmeAndLicense(packageName, TypingType.ABI, exportDir, sampleInterface);
+
+    const readmePath = `${exportDir}/README.MD`;
+    expect(fse.existsSync(readmePath)).to.be.true;
+
+    const readmeContent = fse.readFileSync(readmePath, 'utf8');
+    expect(readmeContent).to.include(`# ${packageName}`);
+  });
+
+  it('should add the sample interface on the README.MD file', () => {
+    const packageName = 'test-package';
+    const sampleInterface = 'ISampleInterface';
+    createReadmeAndLicense(packageName, TypingType.ABI, exportDir, sampleInterface);
+
+    const readmePath = `${exportDir}/README.MD`;
+    expect(fse.existsSync(readmePath)).to.be.true;
+
+    const readmeContent = fse.readFileSync(readmePath, 'utf8');
+    expect(readmeContent).to.include(`${sampleInterface}`);
+  });
+
+  it('should create web3 README.MD file with correct package name', () => {
+    const packageName = 'test-package';
+    const sampleInterface = 'ISampleInterface';
+    createReadmeAndLicense(packageName, TypingType.CONTRACTS, exportDir, sampleInterface);
 
     const readmePath = `${exportDir}/README.MD`;
     expect(fse.existsSync(readmePath)).to.be.true;
@@ -27,7 +64,8 @@ describe('createReadmeAndLicense', () => {
 
   it('should create LICENSE file if it exists', () => {
     const packageName = 'test-package';
-    createReadmeAndLicense(packageName, TypingType.CONTRACTS, exportDir);
+    const sampleInterface = 'ISampleInterface';
+    createReadmeAndLicense(packageName, TypingType.CONTRACTS, exportDir, sampleInterface);
 
     const licenseFilePath = `${exportDir}/LICENSE`;
     expect(fse.existsSync(licenseFilePath)).to.be.true;