Atlantis Toolset

Monorepo with a set of tools and utilities, developed by our team, to ease our day-to-day work on projects.

Tools are designed to be used in projects with Javascript and Typescript and are designed to increase developer performance as well as unify development experience.

Start

IMPORTANT: we use our custom yarn bundle

To start using it:

First time:

• yarn set version https://raw.githubusercontent.com/atls/raijin/master/yarn/cli/dist/yarn.mjs - installs our latest custom yarn bundle in the project scope.

Upgrade already installed bundle:

• yarn set version atls - updates bundle to latest version and updates @atls/code-runtime dependency to latest

Commonly used scrips yarn

Besides standard yarn scripts we developed our custom ones for ease of work:

General

• yarn check - executes typecheck, lint, format. Executes automatically on commits via husky. Execute before createing Pull Request
• yarn files changed list - print out list of changed files
• yarn commit ... - work with git commits
  • message - create commit message
  • staged - move commit to stage

Checks

• yarn typecheck - executes type check
• yarn lint - executes ESLint
  • --cache - executes ESLint with cache

Code formatting

• yarn format - reformats whole project based on our prettier config

Build

• yarn service build - build as service bundle
• yarn service dev - run service in dev mode
• yarn library build - build as library
• yarn image pack - build as docker image via buildpacks

Image pack config

In package.json of entrypoint you can add following options:

  "packConfiguration": {
    "builderTag": "22",
    "buildpackVersion": "0.1.1",
    "require": [
      "curl",
      "htop"
    ]
  }

Where:

• builderTag - NodeJS version to use. Available options
• buildpackVersion - buildpacks to use. Available options
• require - array of additional dependencies to be available in final image. Available options are here under atlantislab/buildpack-extension-...

Testing

• yarn test ... - run tests
  • integration - integration tests. Runs tests in integration folders
  • unit - runs all tests besides ones in integration folders
    • name of file/test suite - runs only tests matching pattern

Options:

• --watch - run tests and rerun upon changes in linked files
• --watchAll - run tests in any changes in repo

Check project for build errors

• yarn workspaces changed foreach image pack - build services with local changes
• yarn workspaces foreach image pack - build all services

Generation

• yarn generate project - generate project schematics
• yarn badges generate - generates badges in root README.md based on version in root package.json

Our configs