exos-scripts

Exos Scripts

This project contains a set of out-of-the-box extensible scripts that helps you with the lifecycle of your React + TypeScript applications. It is heavily inspired in Facebook' Create React App plugin.

It contains the following built-in features:

• exos-scripts start: A ready-to-be-used development experience as similar to production as it could be.
• exos-scripts build: A build script for web applications, configured and optimized to provide the best performance.
• exos-scripts test: A unit testing framework (Jest) already configured for you.
  • CI=true exos-scripts test: Also comes with coverage configured that will be executed by default in CI environments. You can trigger it this way or by running exos-scripts test --collectCoverage.
• exos-scripts lint: a static analyzer tool configured with the best practices for development with React, TypeScript, ESLint and Prettier.
  • exos-scripts lint --type=Library: Also comes with a flavor for Node Libraries using TypeScript, ESLint and Prettier.

Note: For more information about the 🛡️Exos initiative, click here.

Getting started

To use it in your projects, first install exos-scripts in your package by running:

npm i -D exos-scripts

Then, update your package.json with the following:

{
  "name": "Your App",
  "version": "0.0.1",
  ...
  "scripts": {
    "lint": "exos-scripts lint",
    "test": "exos-scripts test",
    "start": "exos-scripts start",
    "build": "exos-scripts build"
  },
}

🚀!