TimothyJones

Handover documentation

Here's a list of things I find useful to check off when writing handover documentation for source code.

General sanity checks

These get checked at the end, but they're at the front of the document because they're good to keep in mind the whole time

• Do these instructions work cross-platform? If not, which platform do they work on?
• If the source of truth is not this document, should some of the questions be answered with links (to eg confluence/other repos)

TimothyJones

const AWS = require('aws-sdk');

const encryptedEnvironmentVariableNames = ['SOME_VARIABLE', 'SOME_OTHER_VARIABLE'];

// This module exports a function that returns a promise for obtaining
// a decrypted copy of the environnment.
//
// Configure it by putting the name of each environment variable you would like to
// decrypt above.
//

TimothyJones

#!/bin/bash -eu

# (C) Timothy Jones

# This function prints the usage
function usage {
  {
    echo "Usage:"
    echo "   ${BASH_SOURCE[0]} <NAME> <VALUE> <KEY_ID>"
    echo "      NAME   - the name of the SSM variable"

TimothyJones

Improving the Pact-JS DSL

(Thanks to Andras Bubics and Matt Fellows for many discussions leading to this proposal)

Test frameworks for Javascript are diverse - some run in parallel by default, some have different testing styles or expectations (eg BDD), and they all have different ways to configure and instrument the test framework.

The Pact workflow also includes a number of (necessary) assumptions and expectations - such as the need to keep

TimothyJones

const AWS = require('aws-sdk');

const ssm = new AWS.SSM();

const configFeatures = {
  '/path/to/your/config/option': 'someOption',
  '/path/to/your/config/something_else': 'somethingElse'
};

const getConfig = () =>

TimothyJones

Prettier

Format all files in src:

prettier --config .prettierrc --write "src/**/*.js"

Or, more generally:

prettier --config --write "/**/*.js"

TimothyJones

#!/bin/bash -eu
if [ -z "${LIB_ROBUST_BASH_SH:-}" ]; then
  LIB_ROBUST_BASH_SH=included

  function error {
    echo "Error:  ${1:-}"
  }

  # Check to see that we have a required binary on the path
  function require_binary {

TimothyJones

#!/bin/bash -eu

# This script prints out git metadata information for a given commit (or head by default)
# It assumes tags of the form `v1.2.3`, and will print prerelease versions when
# not on an exact tag.
#
# It is intended to be used like so:
#
#   cd <some-git-repo>
#   $(../semver-from-git.sh)

TimothyJones

const decrypt = data =>
  new Promise((resolve, reject) =>
    kms.decrypt(
      {
        CiphertextBlob: Buffer.from(data, 'base64')
      },
      (err, data) => {
        if (err) {
          reject(err);
        } else {

TimothyJones

# start your script with
#!/bin/bash -eu

# Or

#!/usr/bin/env bash
set -o errexit
set -o nounset