ODK 2.0 <-> [friendly] JSON Converter

About

This library was seeded by Typescript Library Starter. See the link or below for more information.

We make heavy use of the following dependencies:

js-xlsx Apache 2.0
js-base64 BSD-3-Clause
benetech/app-designer

Design

This library is meant to facilitate conversion between a friendly JSON format and the ODK2.0 XLSX format. At a high leve, the converter should 1) validate the input (JSON or ODK2.0 XLSX), 2) store the input in a common format using js-xlsx, and 3) export (JSON or ODK2.0 XLSX).

Development

To submit changes, please create a pull request. Please use the following checklist as a guideline:

Are all tests passing?
- npm run prepush
Did the pull request include a description of all changes? Does it account for any new or updated dependencies?
Does the pull request solve more than one problem? Could it be broken down into several, independent PRs?

It's important to note that these are only guidelines and can and should be broken when appropriate. However a healthy code culture can be more easily cultivated when we all agree to and follow a set of simple rules.

TypeScript library starter

A starter project that makes creating a TypeScript library extremely easy.

Usage

git clone https://github.com/alexjoverm/typescript-library-starter.git YOURFOLDERNAME
cd YOURFOLDERNAME

# Run npm install and write your library name when asked. That's all!
npm install

Start coding! package.json and entry files are already set up for you, so don't worry about linking to your main file, typings, etc. Just keep those files with the same names.

Features

Zero-setup. After running npm install things will be setup for you 😉
RollupJS for multiple optimized bundles following the standard convention and Tree-shaking.
Tests, coverage and interactive watch mode using Jest
Prettier and TSLint for code formatting and consistency.
Docs automatic generation and deployment to gh-pages, using TypeDoc
Automatic types (*.d.ts) file generation
Travis integration and Coveralls report
(Optional) Automatic releases and changelog, using Semantic release, Commitizen, Conventional changelog and Husky (for the git hooks)

Excluding peerDependencies

On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.

The good news is that you only need to include the dependency name in the external property within rollup.config.js. For example, if you wanna exclude lodash, just write external: ['lodash'].

NPM scripts

npm t: Run test suite
npm start: Runs npm run build in watch mode
npm run test:watch: Run test suite in interactive watch mode
npm run test:prod: Run linting and generate coverage
npm run build: Generage bundles and typings, create docs
npm run lint: Lints code
npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉)

Automatic releases

If you'd like to have automatic releases with Semantic Versioning, follow these simple steps.

Prerequisites: you need to create/login accounts and add your project to:

npm
Travis
Coveralls

Run the following command to prepare hooks and stuff:

npm run semantic-release-prepare

Follow the console instructions to install semantic release and run it (answer NO to "Generate travis.yml").

Note: make sure you've setup repository.url in your package.json file

npm install -g semantic-release-cli
semantic-release setup
# IMPORTANT!! Answer NO to "Generate travis.yml" question. Is already prepared for you :P

From now on, you'll need to use npm run commit, which is a convenient way to create conventional commits.

Automatic releases are possible thanks to semantic release, which publishes your code automatically on Github and npm, plus generates a changelog automatically. This setup is highly influenced by Kent C. Dodds course on egghead.io

Git Hooks

There is already set a precommit hook for formatting your code with Prettier 💅

By default, there are two disabled git hooks. They're set up when you run the npm run semantic-release-prepare script. They make sure:

You follow a conventional commit message
Your build is not gonna fail in Travis (or your CI server), since it's runned locally before git push

This makes more sense in combination with automatic releases

FAQ

`Array.prototype.from`, `Promise`, `Map`... is undefined?

TypeScript or Babel only provides down-emits on syntactical features (class, let, async/await...), but not on functional features (Array.prototype.find, Set, Promise...), . For that, you need Polyfills, such as core-js or babel-polyfill (which extends core-js).

For a library, core-js plays very nicely, since you can import just the polyfills you need:

import "core-js/fn/array/find"
import "core-js/fn/string/includes"
import "core-js/fn/promise"
...

What is `npm install` doing when I run it for the first time?

It runs the script tools/init which sets up everything for you. In short, it:

Configures RollupJS for the build, which creates the bundles.
Configures package.json (typings file, main file, etc)
Renames main src and test files

What if I don't want git-hooks, automatic releases or semantic-release?

Then you may want to:

Remove commitmsg, postinstall scripts from package.json. That will not use those git hooks to make sure you make a conventional commit
Remove npm run semantic-release from .travis.yml