Negligible Psychological Misery
Miss any of our Open RFC calls?Watch the recordings here! »

@kiwicom/overlord

1.4.0 • Public • Published

Overlord

👑 One package to rule them all,

🔎 One package to find them,

✈️ One package to bring them all,

🎉 and in the awesomeness bind them.


Overlord:

  • is a Kiwi.com tailored layer on top of Next.js,
  • will power customer-facing FE apps,
  • handles setting up tooling and deps management.

► developers take care of developing features.

Repository: https://gitlab.skypicker.com/frontend/overlord Documentation: Coming soon.

Installation

To add @kiwicom/overlord to your project, run

yarn add @kiwicom/overlord
# or 
npm i --save @kiwicom/overlord

You can also bootstrap a new frontend application with

npx @kiwicom/overlord init <destination-folder>

overlord CLI

Usage

$ npm install -g @kiwicom/overlord
$ overlord COMMAND
running command...
$ overlord (-v|--version|version)
@kiwicom/overlord/1.4.0 linux-x64 node-v12.16.3
$ overlord --help [COMMAND]
USAGE
  $ overlord COMMAND
...

Commands

overlord help [COMMAND]

display help for overlord

USAGE
  $ overlord help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

overlord init [DESTINATION]

Initialize a new Overlord-powered FE app

USAGE
  $ overlord init [DESTINATION]

OPTIONS
  --name=name

EXAMPLES
  $ overlord init <destination>
  $ overlord init <destination> --name @kiwicom/fe-app

overlord keys

[deprecated] Extract translation keys from files in the current directory

USAGE
  $ overlord keys

OPTIONS
  -e, --extensions=extensions  [default: ts,tsx,js,jsx] comma-separated list of file extensions to extract translations
                               keys

  -p, --paths=paths            [default: pages,components,src] comma-separated list of folders to extract translations
                               keys

EXAMPLES
  $ overlord keys
  $ overlord keys -p pages,components,src -e ts,tsx

overlord static-scripts [DESTINATION]

Generate static data scripts

USAGE
  $ overlord static-scripts [DESTINATION]

ARGUMENTS
  DESTINATION  [default: public/data/scripts] output files destination

OPTIONS
  --data=data  [default: data] data folder with static data fetched by Nitro, required by Nitro's load function

EXAMPLE
  $ overlord static-scripts <destination>

overlord test

Run test suite in your project

USAGE
  $ overlord test

DESCRIPTION
  This is just a convenience wrapper for Jest. Out of the box, it will use some default configuration which should cover 
  most of the needs for Kiwi.com frontends.
     Should you need to tweak the configuration, you could create a 'jest.config.js' file, with the following contents 
  to add a file to 'setupFilesAfterEnv' for example:
     ```
     const defaultConfig = require('@kiwicom/overlord/bin/config/jest').default;

     module.exports = {
      ...defaultConfig,
      setupFilesAfterEnv: [...defaultConfig.setupFilesAfterEnv, 'your-file'],
     }
     ```

EXAMPLES
  $ overlord test
  $ overlord test --coverage
  $ overlord test --watch
  $ overlord test [--flags accepted by jest]

Install

npm i @kiwicom/overlord

DownloadsWeekly Downloads

286

Version

1.4.0

License

none

Unpacked Size

152 kB

Total Files

74

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar