Giter VIP home page Giter VIP logo

atco's Introduction

Atco

The tool that provide powerful additional options for Typescript Compiler

Requirements

  • nodejs >= v12.16.0
  • npm >= v6.14.0 (or yarn >= v1.22.0)

Installation

using npm

npm install --save-dev typescript atco

Or using yarn

yarn add --dev typescript atco

Usage

  • Navigate to project root

  • Create tsconfig.json, inside it you have to specific the output directory using compilerOptions.outDir and specific the target directory using include, like the following example

{
  "compilerOptions": {
    "outDir": "./dist"  
  },
  "include": ["./src/**/*"]
}
  • In package.json add these two scripts
{
  "scripts": {
    "start:dev": "atco -w --exec \"node ./dist/index.js\"",
    "start:prod": "atco && node ./dist/index.js"
  }
}
  • To start app in development mode run the following command
# Using npm
npm start:dev
# Or using yarn
yarn start:dev
  • Or start it in production mode using
# Using npm
npm start:prod
# Or using yarn
yarn start:prod

Examples

The Additional Options (API)

AdditionalOption Type Default Description
--copyOthers boolean true Copy files (which doesn't end with extension .js or .ts) and directories (which doesn't contain any file end with extension .js or .ts)
--cleanOutDir boolean true Remove all files and directories in output directory before start running
--exec string Execute the given command when compiling (and copying if --copyOthers set to true) done successfully

NOTE: if output directory not exists atco will automatically create it, the puropse of --cleanOutDir is clean the output directory if it was exists

The other options except (--project, -p, --version,--help) will be forward to Typescript Compiler (take a look at typescript compiler options)

Known Problems

The following problems is currently happening however we will try to fix it in the future

  • In watch mode atco doesn't track remove event (so if you remove file or directory you have to rerun command)

atco's People

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.