Home Reference Source Repository

REciNK - Rethink Continuous Integration for JavaScript Applications

NPM Version Build Status Code Climate API Docs

REciNK was born from our need to automate the execution of JavaScript tests. We quickly realized that we need to RETHINK (aka REciNK) entire Continuous Integration process for JavaScript applications. Similar to .travis.yml, we empower developers to simply drop the .recink.yml config file into GitHub repository and follow below Getting Started guide to use it as part of their Continuous Integration pipeline (maybe even extend to Continuous Deployment).

Features

Prerequisites

  • [x] Git >= v1.x
  • [x] Node.js >= v6.x
  • [x] NPM >= v3.x

Use nvm to install and manage different versions of Node.js; Ideally, use v8+ for faster performance

Installation

npm install -g recink

Getting Started

@See User Guide

Usage

recink run [name] [path]               # Run a generic component
recink run unit [path]                 # Run unit tests                              
recink run e2e [path]                  # Run end to end tests                        
recink configure recink [path]         # Configure REciNK                            
recink configure travis [path]         # Configure Travis                            
recink travis encrypt [path]           # Encrypt Travis environment variables        
recink travis lint [path]              # Lint Travis configuration                   
recink component generate [path]       # Generate REciNK boilerplate component       
recink component add [name...]         # Add an REciNK component to the registry     
recink component remove [name...]      # Remove an REciNK component from the registry
recink component list                  # List REciNK components from the registry    
recink help <command>                  # Display help for a specific command

Debugging

To enable debug mode for both unit and e2e runtimes use DEBUG=* recink run unit|e2e.

TestCafe offers amazing debugging capabilities documented here.

We are using Puppeteer as default browser, which provides native debugging capabilities documented here.

Use -v flag to enable verbose mode on any recink command.

Supported CI Platforms

Documentation

Components

Explore in-house built components here

Projects Using "REciNK"

To add you project to this list please open a PR ;)

Roadmap

  • [x] Implement smart cache invalidation
  • [x] Add support for external components
  • [x] Add support for fully automated Travis configuration
  • [x] Add support for End-to-End tests
  • [x] Add component development guide
  • [x] Add unit tests for critical functionality
  • [x] Decouple e2e component
  • [ ] Decouple unit component
  • [ ] Decouple coverage component
  • [ ] Add support for different CI platforms
  • [ ] Craft a cool logo for the project :alien:
  • [ ] Add unit tests to cover at least 80% of codebase

Sponsors

This repository is being sponsored by:

License

REciNK is released under the MIT license.

References

References

Class Summary

Static Public Class Summary
public

Abstract component
public

Abstract configuration manager
public

Abstract cache driver
public

Abstract coverage storage driver
public

Transformer interface
public

AWS security credentials
public

File system cache implementation
public

Cache component
public

Abstract configuration aware component
public

Configuration container
public

Apply transformations to an configuration container
public

Coverage component
public

Abstract dependency aware component
public

Emit component
public

Class representing emited test module
public

Extended Emitter implementation
public

Env

Environment helpers
public

Transformer implementation of 'eval'
public

Cache factory
public

Coverage storage factory
public

Configuration factory
public

Component factory
public

Transformer factory
public

Logger abstraction
public

Overwrites original Module to apply compilers
public

NPM component
public

Abstraction over an NPM module
public

Preprocess component
public

Recink entry point
public

AWS S3 cache driver
public

AWS S3 coverage storage driver
public

AWS S3 (unpacked) cache driver
public

Implements Promise.all() but sequential execution
public

Terminal spinner implementation
public

Test component
public

Apply transformer over a value
public

Unit test runner
public

Void cache driver
public

Volatile coverage storage driver
public

YAML configuration manager

Function Summary

Static Public Function Summary
public

fillString(str: String, length: Number, symbol: String): String

Fill string with symbols
public

findFilesByPattern(dir: String, include: RegExp, exclude: RegExp): Array

Find files by RegExp pattern except dirs
public
public

trimBoth(string: String, symbol: String): String

Remove all prefixes or suffixes from the given string
public

Compare two software version v1 == v2 => 0 v1 < v2 => -1 v1 > v2 => 1

Variable Summary

Static Public Variable Summary
public

events: {}

Cache component events
public

events: {}

Coverage component events
public

events: {}

Emit component events
public

events: {}

NPM component events
public

events: {}

Test component events
public

events: {}

REciNK main events