0.0.15 • Published 5 years ago

@carlsberg/tasks v0.0.15

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@carlsberg/tasks

Collection of tasks for building, linting, testing and deploying TypeScript applications.

System Requirements

$ node -v
v11.12.0

$ npm -v
6.7.0

$ yarn -v
1.15.2

$ gulp -v
CLI version 2.0.1
Local version 4.0.0

Installing

  • Add @carlsberg/tasks to your devDependencies:

    $ yarn add -D @carlsberg/tasks
  • Create a gulpfile.js in package's root directory to extend a preset:

    module.exports = require('@carlsberg/tasks/react/app');
  • Create a tsconfig.js in package's root directory to extend a preset TypeScript configuration:

    {
      "$schema": "http://json.schemastore.org/tsconfig",
      "extends": "@carlsberg/cbs/react/app/tsconfig.json",
      "compilerOptions": {
        "rootDir": "src"
      },
      "include": ["src/**/*"],
      "exclude": ["node_modules", "_build"]
    }

Presets

react/app

This preset contains tasks and base TypeScript configuration for React Apps.

Usage

module.exports = require('@carlsberg/tasks/react/app');

Tasks

  • build

    Builds a React App package.

    $ gulp build --production
  • lint

    Lints the source code.

    $ gulp lint
  • start

    Starts a React App package in watch mode along with a development server.

    $ gulp build --production

Options

  • --production - Optimizes the build for production deployment.
  • --srcDir - Specifies the source code directory.
  • --buildDir - Specifies the build directory.
  • --publicDir - Specifies the public directory (where static files such as index.html live).

Notes

  • Configuration and tasks' files are organized by presets. A full list of existing presets is available here.