Skip to content
TSBB is a zero-config CLI that helps you develop, test, and publish modern TypeScript project.
Branch: master
Clone or download
Latest commit 5cd81a3 May 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example example(react-component): Update Button components. May 20, 2019
src
test/utils test: Add test cases. May 11, 2019
.gitignore
.travis.yml test: Add .travis.yml May 11, 2019
LICENSE Add LICENSE May 11, 2019
README.md
package-lock.json
package.json released v0.0.17 May 20, 2019
tsconfig.json Add compilation and rebuilds on any change. May 5, 2019

README.md

tsbb

Quick Start · Command Help · Example · npm · License

TSBB is a zero-config CLI that helps you develop, test, and publish modern TypeScript Node.js project.

TypeScript + Babel = TSBB

Features

Quickly initialize the example project and quickly enter the development mode.
♻️ Recompile the code when project files get added, removed or modified.
📚 Readable source code that encourages learning and contribution
🚀 Faster, Faster compilation speed.
⚛️ Support react component compilation.
Jest test runner setup with defaults tsbb test
🔥 Zero-config, single dependency.

Quick Start

You will need Node.js installed on your system.

$ npx tsbb create my-project
$ cd my-project

$ npm run watch # Listen compile .ts files.
$ npm run build # compile .ts files.
$ npm start

or

$ npm install tsbb -g
# Create project
$ tsbb create my-project --example=Express
# --- Example name ----------------┴ˇˇˇˇˇˇ

Command Help

Below is a help of commands you might find useful.

create · watch · build · types · test

tsbb

▶ tsbb --help
Usage: tsbb [options]

Commands:
  tsbb create <project-name> [options]  Create a new project with TSBB
  tsbb build [options]                  Build your project once and exit.
  tsbb watch [options]                  Recompile files on changes.
  tsbb types [options]                  Create type files for the project.
  tsbb test [options]                   Run jest test runner in watch mode.

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

Examples:

  $ tsbb build            Build your project once and exit.
  $ tsbb watch            Rebuilds on any change.
  $ tsbb test             Run test suites related.
  $ tsbb test --coverage  Test coverage information should be collected

Copyright 2019

tsbb create

▶ tsbb create --help
tsbb create <project-name> [options]

Create a new project with TSBB

Options:
  --version    Show version number                                     [boolean]
  --help, -h   Show help.                                              [boolean]
  --force, -f  force create.                          [boolean] [default: false]
  --example    Example from
               https://github.com/jaywcjlove/tsbb/tree/master/example
               example-path.                         [string] [default: "basic"]

Examples:
  $ tsbb create my-app                    Create my project.
  $ tsbb create my-app --example express  Create an Express example project.

tsbb build

▶ tsbb build --help
tsbb build [options]

Build your project once and exit.

Options:
  --version          Show version number                               [boolean]
  --help, -h         Show help.                                        [boolean]
  --source-root, -s  The root from which all sources are relative.
                                                       [string] [default: "src"]
  --copy-files       When compiling a directory copy over non-compilable files.
                                                       [boolean] [default: true]
  --source-maps      Source Map options.
              [string] [choices: true, "inline", "both", "none"] [default: true]
  --output, -o       Output directory.                 [string] [default: "lib"]
  --target           Specify your target environment.
                                             [string] [choices: "react", "node"]
  --comments         decide whether a given comment should be included in the
                     output code.                      [boolean] [default: true]

Examples:
  $ tsbb build                Build your project.
  $ tsbb build --no-comments  Build your project and remove the comments.

tsbb watch

▶ tsbb watch --help
tsbb watch [options]

Recompile files on changes.

Options:
  --version          Show version number                               [boolean]
  --help, -h         Show help.                                        [boolean]
  --source-root, -s  The root from which all sources are relative.
                                                       [string] [default: "src"]
  --copy-files       When compiling a directory copy over non-compilable files.
                                                       [boolean] [default: true]
  --source-maps      Source Map options.
              [string] [choices: true, "inline", "both", "none"] [default: true]
  --output, -o       Output directory.                 [string] [default: "lib"]
  --target           Specify your target environment.
                                             [string] [choices: "react", "node"]
  --comments         decide whether a given comment should be included in the
                     output code.                      [boolean] [default: true]
  --timer, -t        Compile interval.                   [number] [default: 300]

Examples:
  $ tsbb watch   Rebuilds on any change.

tsbb test

Runs the test watcher (Jest) in an interactive mode.

▶ tsbb test --help
tsbb test [options]

Run jest test runner in watch mode.

Options:
  --version   Show version number                                      [boolean]
  --help, -h  Show help.                                               [boolean]
  --coverage  Indicates that test coverage information should be collected and
              reported in the output.                 [boolean] [default: false]
  --env       The test environment used for all tests.[string] [default: "node"]
  --config    The path to a Jest config file specifying how to find and execute
              tests.                                                    [string]

Examples:
  $ tsbb test             Run test suites related
  $ tsbb test --coverage  Test coverage information should be collected

tsbb types

▶ tsbb types --help
tsbb types [options]

Create type files for the project.

Options:
  --version                Show version number                         [boolean]
  --help, -h               Show help.                                  [boolean]
  --project                Compile the project given the path to its
                           configuration file, or to a folder with a
                           'tsconfig.json'.             [string] [default: "./"]
  --out-dir                Redirect output structure to the directory.
                                                       [string] [default: "lib"]
  --target                 Specify ECMAScript target version.
        [string] [choices: "ES3", "ES5", "ES2015", "ES2016", "ES2017", "ES2018",
                                         "ES2019", "ESNEXT"] [default: "ES2015"]
  --watch                  Watch input files.         [boolean] [default: false]
  --emit-declaration-only  to enable declarations only output
                                                       [boolean] [default: true]
  --tsconf                 TypeScript other options.                    [string]

Examples:
  $ tsbb types          Create types your project.
  $ tsbb types --watch  Create type files for the project And to run in --watch
                        mode.

Example

Initialize the project from one of the examples:

$ npx tsbb create my-app -e <Example Name>
# --- E.g: ----------------┴ˇˇˇˇˇˇˇˇˇˇˇˇˇˇ
# npx tsbb create my-app -e Basic

License

MIT © Kenny Wong

You can’t perform that action at this time.