docs.sheetjs.com/docz/docs/09-miscellany/05-contributing.md

sidebar_position
5

Contributing

Due to the precarious nature of the Open Specifications Promise, it is very important to ensure code is cleanroom. Contribution Notes

File organization (click to show)

Folders:

folder	contents
bin	server-side bin scripts (xlsx.njs)
bits	raw source files that make up the final script
dist	dist files for web browsers and nonstandard JS environments
misc	miscellaneous supporting scripts
modules	TypeScript source files that generate some of the bits
packages	Support libraries and tools
test_files	test files (pulled from the test files repository)
tests	browser tests (run make ctest to rebuild)
types	TypeScript definitions and tests

After cloning the repo, running make help will display a list of commands.

OS-Specific Setup

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

The MacOS/Linux workflow works in WSL. Initial setup is involved:

1. Install mercurial and subversion.

# Install support programs for the build and test commands
sudo add-apt-repository ppa:mercurial-ppa/releases
sudo apt-get update
sudo apt-get install mercurial subversion
sudo add-apt-repository --remove ppa:mercurial-ppa/releases

2. Install NodeJS

# Install bootstrap NodeJS and NPM within the WSL
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt-get install -y nodejs

# CLOSE AND REOPEN SHELL BEFORE CONTINUING

# Switch to `n`-managed NodeJS
sudo npm i -g n
sudo n 16

3. Build and install a version of Git with proper SSL support:

# Git does not support OpenSSL out of the box, must do this
curl -LO https://github.com/paul-nelson-baker/git-openssl-shellscript/raw/main/compile-git-with-openssl.sh
chmod +x compile-git-with-openssl.sh
./compile-git-with-openssl.sh

(instructions continued in the MacOS/Linux part)

Initial setup:

0. Ensure mercurial, subversion, and NodeJS are installed. The WSL instructions will have installed these dependencies, so WSL users can skip to step 1.

:::note

The official NodeJS site provides installers for "LTS" and "Current" releases. The "LTS" version should be installed.

:::

Mercurial and Subversion:

On Linux, install using the system package manager. Debian and Ubuntu use apt:

sudo apt-get install mercurial subversion

Other Linux distributions may use other package managers.

Steam Deck (click to show)

Desktop Mode on the Steam Deck uses pacman. It also requires a few steps.

0. Switch to Desktop mode and open Konsole

1. Set a password for the user by running passwd and following instructions.

2. Disable read-only mode:

sudo steamos-readonly disable

(When prompted, enter the password assigned in step 1)

3. Configure keyring:

echo "keyserver hkps://keyserver.ubuntu.com" >> /etc/pacman.d/gnupg/gpg.conf
sudo pacman-key --init
sudo pacman-key --populate
sudo pacman-key --refresh-keys

4. Install dependencies:

yay -S base-devel mercurial subversion

On MacOS, install using Homebrew.

0. Open a terminal window and install Homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

1. Close the window, open a new terminal window, and disable analytics:

brew analytics off

To confirm analytics are disabled, run

brew analytics state

It should print Analytics are disabled.

2. Install Mercurial and Subversion:

brew install mercurial subversion

1. Install NodeJS modules for building the scripts

# Install dev dependencies
npm install

# Install global dependencies
sudo npm i -g mocha@2.5.3 voc @sheetjs/uglify-js

:::note Older Versions of Dependencies

Some of the dependencies are wildly out of date. While SheetJS aims to run in older versions of NodeJS and browsers, some libraries have chosen to break backwards compatibility. The specific versions are used because they are known to work and known to produce consistent results.

:::

2. Initialize the test files:

make init

This step may take a while as it will be downloading a number of test files.

3. Run a short test, then run a build

# Short test
make test_misc

# Full Build
cd modules; make; cd ..
make dist

4. (For Deno testing) Install Deno:

curl -fsSL https://deno.land/install.sh | sh

5. (For Bun testing) Install Bun:

curl https://bun.sh/install | bash

Development

The xlsx.js and xlsx.mjs files are constructed from the files in the bits subfolder. The build script (run make) will concatenate the individual bits to produce the scripts.

To produce the dist files, run make dist. The dist files are updated in each version release and should not be committed between versions.

Tests

The test_misc target runs the targeted feature tests. It should take 5-10 seconds to perform feature tests without testing against the full test battery. New features should be accompanied with tests for the relevant file formats.

For tests involving the read side, an appropriate feature test would involve reading an existing file and checking the resulting workbook object. If a parameter is involved, files should be read with different values to verify that the feature is working as expected.

For tests involving a new write feature which can already be parsed, appropriate feature tests would involve writing a workbook with the feature and then opening and verifying that the feature is preserved.

For tests involving a new write feature without an existing read ability, please add a feature test to the kitchen sink tests/write.js.