@selfage/cli

Basic CLI to help develop apps in TypeScript.

Usage no npm install needed!

<script type="module">
  import selfageCli from 'https://cdn.skypack.dev/@selfage/cli';
</script>

README

@seflage/cli

Install

npm install @selfage/cli

Overview

Written in TypeScript and compiled to ES6 with inline source map & source. See @selfage/tsconfig for full compiler options. Provides an opinionated and basic CLI for developing apps in TypeScript. See sections below for each sub-command and see commander if you are not sure about CLI syntax.

Compile

If you specified incremental: true in your tsconfig.json, tsBuildInfoFile will not be respected and will be overriden as <file>.tsbuildinfo.

Respect merging base tsconfig via extends.

$ selfage compile -h
Usage: selfage compile|cpl [options] <file>

Compile a single TypeScript source file while respecting compilerOptions in tsconfig.json. Its file ext can be neglected and is always fixed as .ts.

Options:
  -c, --tsconfig-file <file>    The file path to tsconfig.json. If not provided, it will try to look for it at the current working directory.
  -s, --extra-files <files...>  Extra files to be compiled together with and before the source file.
  -h, --help                    display help for command

Clean

$ selfage clean -h
Usage: selfage clean [options]

Clean all ignored files by .gitignore, except node_modules/.

Options:
  -h, --help  display help for command

Run

$ selfage run -h
Usage: selfage run [options] <file> [pass-through-args...]

Compile and run the specified file under Node environment. Its file ext can be neglected and is always fixed as .ts. "--" is needed in between <file> and pass through arguments.

Options:
  -c, --tsconfig-file <file>  The file path to tsconfig.json. If not provided, it will try to look for it at the current
                              working directory.
  -h, --help                  display help for command

Run forever

$ selfage runForever -h
Usage: selfage runForever|frun [options] <file> [pass-through-args...]

Run the already compiled file under Node environment while auto restart when it crashes/ends. Its file ext can be neglected and is always fixed as .js. "--" is needed in between <file> and pass through arguments.

Options:
  -h, --help  display help for command

It's a minimalist version that does nothing more than auto-restarting crashed/ended Node program.

Format

On top of prettier, add support to sort imports in a deterministic way but will not keep comments between import statements in place. Please leave comments on top of all import statements.

$ selfage format -h
Usage: selfage format|fmt [options] <file>

Format the specified file. The file type is always fixed as '.ts'.

Options:
  --dry-run   Print the formatted content instead of overwriting the file.
  -h, --help  display help for command

Generate descriptors

See @selfage/message, @selfage/datastore_client and @selfage/service_descriptor packages for detailed explanation of various generated descritpors.

$ selfage generate -h
Usage: selfage generate|gen [options] <file>

Generate various descriptors from the specified source file. The source file ext can be neglected and is always fixed as .json. The generated file will be <file>.ts.

Options:
  -i, --index-file <indexFile>  The index yaml file for Google Cloud Datastore composite index. Its file ext can be neglected and is always fixed
                                as .yaml. Requried only if your definition file includes a datastore definition. You can also add
                                '"datastoreIndex": "./your/index_file"' to your package.json file to save typings.
  --dry-run                     Print the generated content instead of writing it to the destination file.
  -h, --help                    display help for command

API access

Please check out the corresponding .d.ts file for function signatures for each sub-command.

compile -> import { compile } from "@selfage/cli/build/compiler";

clean -> import { clean } from "@selfage/cli/build/cleaner";

run -> import { run } from "@selfage/cli/run/runner";

runForever -> import { run } from "@selfage/cli/run/forever_runner";

format -> import { format } from "@selfage/cli/formatter";

generate -> import { generate } from "@selfage/cli/generate/generator"

E.g., you could import { compile } from '@selfage/cli/build/compiler'; and call await compile('some_source', 'tsconfig.json') to compile a single file.