From 9395126016b710abb2644fc711e6f3ba471a71db Mon Sep 17 00:00:00 2001 From: ChronicStone <55083156+ChronicStone@users.noreply.github.com> Date: Wed, 6 Dec 2023 17:55:21 +0100 Subject: [PATCH] chore: update readme example --- .../workflows/snorkell-auto-documentation.yml | 19 ----------- README.md | 19 ++++++++--- test/index.test.ts | 32 +------------------ 3 files changed, 16 insertions(+), 54 deletions(-) delete mode 100644 .github/workflows/snorkell-auto-documentation.yml diff --git a/.github/workflows/snorkell-auto-documentation.yml b/.github/workflows/snorkell-auto-documentation.yml deleted file mode 100644 index 25950cb..0000000 --- a/.github/workflows/snorkell-auto-documentation.yml +++ /dev/null @@ -1,19 +0,0 @@ -# This workflow will improvise current file with AI genereated documentation and Create new PR - -name: Snorkell.ai - Revolutionizing Documentation on GitHub - -on: - push: - branches: ["main"] - workflow_dispatch: - -jobs: - Documentation: - runs-on: ubuntu-latest - steps: - - name: Snorkell DocGen Client - uses: SingularityX-ai/snorkell-documentation-client@v1.0.0 - with: - client_id: ${{ secrets.SNORKELL_CLIENT_ID }} - api_key: ${{ secrets.SNORKELL_API_KEY }} - branch_name: "main" \ No newline at end of file diff --git a/README.md b/README.md index f9c8c4c..2d31a79 100644 --- a/README.md +++ b/README.md @@ -138,15 +138,26 @@ const buffer = ExcelBuilder }, }) .sheet('User - Multiple tables') + .sheet('Multi-tables-grid', { tablesPerRow: 3 }) .addTable({ - data: users.filter((_, i) => i < 10), + data: users.filter((_, i) => i < 5), schema: assessmentExport, - select: { balance: true, email: true, createdAt: true }, + select: { firstName: true, lastName: true, email: true, createdAt: true }, }) .addTable({ - data: users.filter((_, i) => i < 10), + data: users.filter((_, i) => i < 5), schema: assessmentExport, - select: { firstName: true, lastName: true, email: true }, + select: { firstName: true, lastName: true, email: true, balance: true }, + }) + .addTable({ + data: users.filter((_, i) => i < 5), + schema: assessmentExport, + select: { firstName: true, lastName: true, email: true, balance: true }, + }) + .addTable({ + data: users.filter((_, i) => i < 5), + schema: assessmentExport, + select: { firstName: true, lastName: true, email: true, createdAt: true }, }) .build({ output: 'buffer' }) diff --git a/test/index.test.ts b/test/index.test.ts index ebb7c7e..0581440 100644 --- a/test/index.test.ts +++ b/test/index.test.ts @@ -134,7 +134,7 @@ describe('should generate the example excel', () => { 'group:org': organizations, }, }) - .sheet('User - Multiple tables', { tablesPerRow: 3 }) + .sheet('Multi-tables-grid', { tablesPerRow: 3 }) .addTable({ data: users.filter((_, i) => i < 5), schema: assessmentExport, @@ -155,36 +155,6 @@ describe('should generate the example excel', () => { schema: assessmentExport, select: { firstName: true, lastName: true, email: true, createdAt: true }, }) - .addTable({ - data: users.filter((_, i) => i < 5), - schema: assessmentExport, - select: { firstName: true, lastName: true, email: true, balance: true }, - }) - .addTable({ - data: users.filter((_, i) => i < 5), - schema: assessmentExport, - select: { firstName: true, lastName: true, email: true, createdAt: true }, - }) - .addTable({ - data: users.filter((_, i) => i < 5), - schema: assessmentExport, - select: { firstName: true, lastName: true, email: true, balance: true }, - }) - .addTable({ - data: users.filter((_, i) => i < 5), - schema: assessmentExport, - select: { firstName: true, lastName: true, email: true, createdAt: true }, - }) - .addTable({ - data: users.filter((_, i) => i < 5), - schema: assessmentExport, - select: { firstName: true, lastName: true, email: true, balance: true }, - }) - .addTable({ - data: users.filter((_, i) => i < 5), - schema: assessmentExport, - select: { firstName: true, lastName: true, email: true, createdAt: true }, - }) .build({ output: 'buffer' }) fs.writeFileSync('example.xlsx', buffer)