@tessin/tcm v1.0.167

TCM frontend

🚨🚨🚨 this is an internal tool that we publish here out of convenience. Each point release may ship with substantial breakage. You have been warned.

Getting started

To use TCM in an existing project, install TCM as you would install any other development dependency. TCM is (amongst other things) a bundler and as such should be installed primarily as a development dependency but you can also use it to simply run tests (i.e. as a test runner). The choice is yours.

TCM adds a command line interface tcm which supports a few commands, like tcm dev (start development) and tcm test (test runner). You can get some help by adding a -h flag to those commands.

Initialize

To initialize a new application, use yarn create @tessin/tcm-app <dirname>.

This will create a couple of files that are needed for a TCM app to work.

Start development

By default, it will look for the files created by yarn create @tessin/tcm-app <dirname> command. If you changed these, you need to override the defaults with additional command line options, see tcm dev -h for more information.

tcm dev

This will start a local development server on the port specified by the environment variable PORT (default 3000). It will then compile some TypeScript and open http://localhost:3000 (this can be changed by the --open <url> flag).

Happy development!

Build

Again, by default, it will look for the files created by the create script. It will write the build output to dist/<package-name>.index. Assuming <package-name> and basename(process.cwd()) are the same thing.

tcm build

Build options

• --check building with this option will check the build for type script errors. This is optional but recommended.
• --minify building with this option will minify the build using the Google Closure Compiler. A version of the Google Closure Compiler is redistributed with NPM package but you need to have Java 8 installed for this to work.
• --es5 building with this option will create a secondary ECMAScript 5 output for each JavaScript module. This option implies --minify. ECMAScript 5 output is not used by default and you have to opt-in to use it. This option only exists to support legacy browsers, like Internet Explorer 11. By default, we target ECMAScript 2017.

Serve (run build)

Will look for output created by tcm build and run that. You can run anything you want using different options. Serve can also be configured to pull bunldes from an Azure Storage Account (or other REST like storage service). This way (depending on what type of request the server gets), it will serve various applications (or versions of the same application) backed by the same storage. This is mostly a deployment feature but it can also be used to test and run multiple versions of the same application on the same host. It greatly simplfies pull request workflows.

tcm serve

Contributing

🚨🚨🚨 while the source is not public we may revise this in the future. The primary reason for this is that we don't have the time to maintain a public repository.

Clone the source, then run yarn && yarn run tsc && yarn link in that directory to install the TCM repo as a global package. Verify installation with tcm help.

Link local setup with any project using yarn link @tessin/tcm.