.github/workflows/main.yml

@@ -0,0 +1,45 @@
+name: Prod deploy
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    if: github.repository == 'LuisEnMarroquin/json-as-xlsx'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn
+      - run: yarn test
+      - run: yarn build
+      - name: Copy files to library output folder
+        run: |
+          cp README.md packages/main-library/README.md
+          cp LICENSE packages/main-library/LICENSE
+      - name: Set environment variable for GitHub
+        run: |
+          echo "CURRENT_VERSION=$(node -e "console.log('v' + require('./package.json').version)")" >> $GITHUB_ENV
+          echo CURRENT_VERSION ${{ env.CURRENT_VERSION }}
+        working-directory: packages/main-library/
+      - name: Publish package to NPM registry
+        run: |
+          echo "//registry.npmjs.org/:_authToken=$NPM_AUTH_TOKEN" > ~/.npmrc
+          npm publish --access public
+        env:
+          NPM_AUTH_TOKEN: ${{ secrets.TOKEN_NPM }}
+        working-directory: packages/main-library/
+      - name: Create a new GitHub release
+        run: |
+          echo ${{ secrets.TOKEN_GITHUB }} > nothing.md
+          gh auth login --with-token < nothing.md
+          gh release create ${{ env.CURRENT_VERSION }} -F README.md -t "Released ${{ env.CURRENT_VERSION }}"
+      - name: Prepare static files for deployment
+        run: yarn run static
+      - uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: build
+          branch: gh-pages
+          git-config-name: LuisEnMarroquin
+          git-config-email: mluis651@gmail.com

.github/workflows/tests.yml

@@ -0,0 +1,11 @@
+name: Test suites
+
+on: [push, pull_request_target]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: yarn
+      - run: yarn test

.gitignore

@@ -1,5 +1,7 @@
 # Folders
 dist/
+build/
+coverage/
 node_modules/
 
 # File managers
@@ -8,14 +10,11 @@ node_modules/
 desktop.ini
 
 # Other lockfiles
-yarn.lock
+package-lock.json
 npm-shrinkwrap.json
 
 # Log files
 *.log*
 
 # Excel files
 *.xlsx
-
-# Now this is a typescript project
-index.js

.nvmrc

@@ -0,0 +1 @@
+16.14.2

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "semi": false,
+  "printWidth": 512
+}

CNAME

@@ -0,0 +1 @@
+xlsx.marroquin.dev

CODEOWNERS

@@ -0,0 +1 @@
+* @LuisEnMarroquin

CONTRIBUTING.md

@@ -1,43 +1,33 @@
-# Dev environment
+## Requirements
 
-Here are the **node** and **npm** versions that we use to develop this project
+These are the software versions I personally use
 
 ```shell
-$ node --version && npm --version
-v14.17.4
-6.14.14
+$ node --version
+v16.14.2
+$ npm --version
+8.5.0
+$ yarn --version
+1.22.19
 ```
 
-After cloning the repository, run `npm install` to install the dependencies
+Other versions may work but I can not guarantee that
 
-## Run in dev mode
+## Develop locally
 
-You'll have to use 2 consoles to run the app, one for the actual package `index.ts`
+It will start the library and demo project in dev mode
 
 ```shell
-$ npm run start
+$ yarn start
 ```
 
-Then if you want to test the package with `VueJS` you can execute the following
+- Express: localhost:5500
+- ReactJS: localhost:6500
 
-```shell
-$ npm run start-client
-```
-
-Otherwise if you want to test with `express` use the following command
-
-```shell
-$ npm run start-server
-```
-
-## Linting code
-
-This project uses `ts-standard` for linting, included in optional dependencies
+## Code linting
 
-```shell
-$ npm run lint
-```
+This project uses `prettier` for linting code
 
 ## Deploy to NPM
 
-There is a pipeline for that, just do a PR and I'll merge it
+There is a pipeline for that, just do a PR and it will be merged

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 - present, LuisEnMarroquin <luis@marroquin.dev>
+Copyright (c) 2022, LuisEnMarroquin <xlsx@marroquin.dev>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,58 +1,104 @@
 # json-as-xlsx
 
-This is a tool that helps to build an excel from a json and it depends only on `xlsx`
+This is a tool that helps to build an excel from a json and it depends only on `xlsx` library
 
-Now with version **2.0.0** and above supports multiple sheets and custom styling
+You can see a live example of it working on any of this sites (there are many just in case):
 
-You can see a live example of how it works on this site: [luisenmarroquin.github.io/json-as-xlsx](https://luisenmarroquin.github.io/json-as-xlsx)
+- [xlsx.pages.dev](https://xlsx.pages.dev)
+- [xlsx.marroquin.dev](https://xlsx.marroquin.dev)
+- [xlsx.luismarroquin.com](https://xlsx.luismarroquin.com)
 
 ## Usage
 
-Just import and use it
-
 ```js
-let xlsx = require('json-as-xlsx')
+import xlsx from "json-as-xlsx"
+// or require
+let xlsx = require("json-as-xlsx")
 
 let data = [
   {
-    sheet: 'Adults',
+    sheet: "Adults",
     columns: [
-      { label: 'User', value: 'user' }, // Top level data
-      { label: 'Age', value: row => (row.age + ' years') }, // Run functions
-      { label: 'Phone', value: row => (row.more ? row.more.phone || '' : '') }, // Deep props
+      { label: "User", value: "user" }, // Top level data
+      { label: "Age", value: (row) => row.age + " years" }, // Custom format
+      { label: "Phone", value: (row) => (row.more ? row.more.phone || "" : "") }, // Run functions
     ],
     content: [
-      { user: 'Andrea', age: 20, more: { phone: '11111111' } },
-      { user: 'Luis', age: 21, more: { phone: '12345678' } }
-    ]
-  }, {
-    sheet: 'Children',
+      { user: "Andrea", age: 20, more: { phone: "11111111" } },
+      { user: "Luis", age: 21, more: { phone: "12345678" } },
+    ],
+  },
+  {
+    sheet: "Children",
     columns: [
-      { label: 'User', value: 'user' }, // Top level data
-      { label: 'Age', value: row => (row.age + ' years') }, // Run functions
-      { label: 'Phone', value: row => (row.more ? row.more.phone || '' : '') }, // Deep props
+      { label: "User", value: "user" }, // Top level data
+      { label: "Age", value: "age", format: '# "years"' }, // Column format
+      { label: "Phone", value: "more.phone", format: "(###) ###-####" }, // Deep props and column format
     ],
     content: [
-      { user: 'Manuel', age: 16, more: { phone: '99999999' } },
-      { user: 'Ana', age: 17, more: { phone: '87654321' } }
-    ]
-  }
+      { user: "Manuel", age: 16, more: { phone: 9999999900 } },
+      { user: "Ana", age: 17, more: { phone: 8765432135 } },
+    ],
+  },
 ]
 
 let settings = {
-  fileName: 'MySpreadsheet', // Name of the spreadsheet
+  fileName: "MySpreadsheet", // Name of the resulting spreadsheet
   extraLength: 3, // A bigger number means that columns will be wider
-  writeOptions: {} // Style options from https://github.com/SheetJS/sheetjs#writing-options
+  writeMode: "writeFile", // The available parameters are 'WriteFile' and 'write'. This setting is optional. Useful in such cases https://docs.sheetjs.com/docs/solutions/output#example-remote-file
+  writeOptions: {}, // Style options from https://docs.sheetjs.com/docs/api/write-options
+  RTL: true, // Display the columns from right-to-left (the default value is false)
 }
 
 xlsx(data, settings) // Will download the excel file
 ```
 
-## Examples
+If you want to trigger something after the file is downloaded, you can use the `callback` parameter:
+
+```js
+let callback = function (sheet) {
+  console.log("Download complete:", sheet)
+}
+
+xlsx(data, settings, callback) // Will download the excel file
+```
+
+### Column formatting
+
+> **Note:** Cell formatting is type based, i.e. the format type and value type must match.
+>
+> If you want to use a Date format, the value must be of type Date; if you want a number format, the value must be a Number.
 
-This are my files used for development, remember to change:
+Column formatting can be provided in the column object, i.e.
+
+```js
+columns: [{ label: "Income", value: "income", format: "€#,##0.00" }]
+```
+
+- A list of SheetJS format examples can be found
+  here: [SSF library](https://github.com/SheetJS/sheetjs/blob/f443aa8475ebf051fc4e888cf0a6c3e5b751813c/bits/10_ssf.js#L42)
+- ECMA-376 number formatting
+  specification: [Number formats](https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_numFmts_topic_ID0E6KK6.html)
+
+Examples
+
+```js
+// Number formats
+"$0.00" // Basic
+"\£#,##0.00" // Pound
+"0%" // Percentage
+'#.# "ft"' // Number and text
+
+// Date formats
+"d-mmm-yy" // 12-Mar-22
+"ddd" // (eg. Sat)
+"dddd" // (eg. Saturday)
+"h:mm AM/PM" // 1:10 PM
+```
+
+## Examples
 
-`require('./index.js')` and `require('../index.js')` to `require('json-as-xlsx')`
+This are files used for development, please change imports from `../../src/index` to `json-as-xlsx`
 
-* Frontend with [Vue here](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/src/App.vue)
-* Backend with [Express here](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/server.js)
+- [Express with TypeScript](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/packages/demo-express)
+- [ReactJS with TypeScript](https://github.com/LuisEnMarroquin/json-as-xlsx/blob/main/packages/demo-reactjs)