Rember 0.0.4-rc3

Rember

Rember is a command line tool that reminds and allows you to easily run builds, tests and custom tasks automatically before pushing code and waiting for it to break the pipeline 15 minutes later.

Table of contents

• Rember
  • About
  • Installation
  • Usage
  • Roadmap

About

Rember is a command line tool that can run any task you want before pushing your code so you never push broken or unlinted code ever again. You can set it up directly from your command line for a more simplistic set up, Rember will automatically detect your language and build tool and generate a build and test task unless specified otherwise. For custom tasks a config file must be used.

Installation

• With choco

  choco install rember --pre
  

• With Nuget

  dotnet tool install --global Rember --version 0.0.4-rc3
  

Check the latest version just in case.

To install this right now for developing, assuming you have the required dotnet stuff, simply run the RefreshPackage ps script.

Usage

Running rember init from the command line automatically detects your used language and build tool, currently (hopefully) supports:

• Dotnet
• Maven
• Gradle
• NPM
• Yarn
• SBT

Use rember -h and rember init -h for more information.

The rember.yml config file

The recommended way to use this tool is by creating a yaml file. This means that you have to manually add all steps but it also means that you can add any steps you want. This makes it much easier when working in a team.

There is a sample in the repository which should be self-explanatory.

buildToolName: Dotnet
# hookDirectory: .husky
tasks:
- name: Build
  command: dotnet build
  outputEnabled: false  # Default is true
  alwaysRun: true       # Default is false

The hook directory should only be used if you, for whatever reason are not using the default git hooks location. You can check your current hook path by running git config core.hooksPath, if nothing is printed then ignore this, otherwise set it to whatever value is printed. Keep in mind that Rember will replace any pre-push hooks you already have!

In order to use it run:

rember init -f rember.yml

Roadmap

• v0.0.2-beta
  • Remove existing tasks
  • Select if u want build/test at init, ability to add either one later on
  • Ability to define custom tasks to run [a bit buggy, pushed back to 0.0.3]
• v0.0.3-beta
  • Completely remake how file accesses work [delayed to next release]
  • Fix custom task creation
  • Add save and restore
  • Ability to load settings from a yml file
• v0.0.4-rc2
  • Major refactor
  • Removed the pre-commit option for now at least, default and only option are push hooks
• v0.0.4-rc3
  • Improved readme a bit
  • Set AlwaysRun to false by default
  • Fixed a relative path bug
  • Added ability to change your git hooks path

Contributing

Take a look at the CONTRIBUTING.md file.