baptz v0.9.10

Baptz

CLI utility that helps construct names adhering to naming conventions.

Installation

npm install -g baptz

You will also need to install a naming convention configuration by doing baptz add and supplying a URL to the configuration. As such, the naming convention can be hosted externally (e.g. in a git repo).

Usage

$ baptz --help

  Usage: baptz [options] [command]


  Options:

    -V, --version  output the version number
    -h, --help     output usage information


  Commands:

    run         construct a name based on the current active naming 
                convention - default if no command specified
    add         add a new naming convention
    update      reload naming convention(s)
    nc          set naming convention to use (if multiple available)
    help [cmd]  display help for [cmd]

  Active naming convention: my-aws-naming-convention

Config

Baptz configuration is stored at <USER_HOME>/.config/configstore/baptz.json

In addition to the namingConventions config, the following config props are available:

Naming conventions

Naming conventions are json configuration files consisting of templates and questions. Examples say more than 1000 words:

{
  "name": "my-aws-naming-convention",
  "resources": [
    {
      "name": "EC2::Subnet",
      "template": "sn-{regionCode}{az}-{vpcName}"
    },
    {
      "name": "EC2::VPC",
      "template": "vpc-{regionCode}-{descriptiveName}"
    },
    {
      "name": "S3::Bucket",
      "template": "hf-s3-{regionCode}-{envCode}-{descriptiveName}-{f:randomDigits(12)}"
    }
  ],
  "questions": [
    {
      "name": "regionCode",
      "message": "Region?",
      "type": "list",
      "choices": [
        {
          "name": "eu-west-1 (Ireland)",
          "value": "ew1",
          "short": "ew1"
        },
        {
          "name": "eu-west-2 (London)",
          "value": "ew2",
          "short": "ew2"
        },
        {
          "name": "eu-central-1 (Frankfurt)",
          "value": "ec1",
          "short": "ec1"
        }
      ],
      "default": "ew1"
    },
    {
      "name": "availabilityZone",
      "message": "Availability Zone?",
      "type": "list",
      "choices": [
        "a",
        "b",
        "c"
      ]
    },
    {
      "name": "envCode",
      "message": "Environment?",
      "type": "list",
      "choices": [
        {
          "name": "Production",
          "value": "p"
        },
        {
          "name": "Staging",
          "value": "s"
        },
        {
          "name": "Development",
          "value": "d"
        }
      ]
    },
    {
      "name": "descriptiveName",
      "message": "Descriptive name:",
      "type": "input"
    }
  ]
}

Resources

A naming convention resource is described by a name and a template. Templates contain placeholders (enclosed by braces, {}). Placeholders point at questions (which are defined in the questions array of the config file). When running baptz for a given template, the placeholders will be populated by the answers to the questions associated with the placeholder.

If a placeholder references a question that is not defined in the questions array, an "input type" question will be constructed automatically based on the name.

Questions

Defines questions according to https://www.npmjs.com/package/inquirer#questions

Generator functions

Placeholders can reference "generator functions". These are prefixed with f:, such as f:randomDigits(12). When running baptz, these placeholders will be subsituted with the result of such a generator function.

The following generator functions are available:

Filter functions

Placeholders can reference "filter functions". These are prefixed with <functionName>:, such as pc:myQuestion. When running baptz, these placeholders will be substituted with the filtered output of a user's answer to the question. E.g. if the user answers "my answer", then "MyAnswer" will be the result.

The following filter functions are available:

Special placeholders/questions

Support (OS Terminals)

Baptz is based on Inquirer.js, thus you should expect mostly good support for the CLIs below:

• Mac OS:
  • Terminal.app
  • iTerm
• Windows:
  • ConEmu
  • cmd.exe
  • Powershell
  • Cygwin
• Linux (Ubuntu, openSUSE, Arch Linux, etc):
  • gnome-terminal (Terminal GNOME)
  • konsole

Issues

Submit bugs, feature requests or questions here

Source

Github

Release notes

0.9.10

• Fixed bug related to dynamic placeholders not being replaced
• Print information when no config updates were found

0.9.9

• Bugfixes

0.9.8

• Bugfixes
• Support for more filter functions

0.9.7

• Support for filter functions. Placeholders can now be prefixed with special "filter functions" in order for answers to be post-processed. E.g. to transform answers into PascalCase.
• Resources now have a shortname property. These can be referenced in your templates.
• Special "resourceRef" placeholder that can be used to prompt for other resources.

0.9.6.

• Support auto updating of configuration. Ensures that your naming convetions stays updated without having to explicitly do baptz update. Can be turned off by switching a flag in your local baptz config.

0.9.5

• First release

License

Licensed under the MIT license.