/factorio-rcon

Library for interacting with a Factorio server via RCON

Primary LanguageTypeScriptMIT LicenseMIT

typescript-starter

codecov CircleCI

Boilerplate repo for personal Typescript projects

Components

Component/Framework Purpose Comments
Jest Test Framework Using ts-jest for JIT compilation
Prettier/ESLint Code style & linting
CircleCI Continuous Integration Supports publishing to NPM
Codecov Code coverage tracking

Usage

Compile

# Compile typescript to dist/
npm run compile

# Compile in watch mode
npm run watch

Lint

# Check for style issues
npm run prettier

# Automatically fix style issues
npm run prettier:fix

Test

# Run test suite
npm test

# Generate a coverage report
npm run test:coverage

CI/CD

To set up CircleCI integration, set the following env vars on the CircleCI project:

  • NPM_TOKEN: auth token granting publish access
  • CODECOV_TOKEN: token for Codecov

To publish a new version to npm:

npm version patch # or minor, or major
git push
git push --tags