cmp-feature-flipper

This plugin is a source for nvim-cmp to complete feature flipper names and descriptions when using the Ruby flipper gem.

Also, this is an early release built around my specific use case and makes many assumptions that I suggest you read through.

Setup

Prerequisites / Assumptions

You must use the flipper gem with a feature name and description file in ./config/feature-descriptions.yml.

The flipper gem lets you load flipper description data however you want. I work on apps that do it via a YAML file. The format is:

feature_flipper_one_name: feature one description
feature_flipper_two_name: feaure two description

This plugin regex parses that YAML file for the completion data.

Installation

Using with nvim-cmp

Install cmp-feature-flipper using your plugin manager of choice. For example, here it is using lazy.nvim:

{
  "hrsh7th/nvim-cmp",
  dependencies = {
    { "wassimk/cmp-feature-flipper", version = "*" },
  },
}

Then add feature-flipper source in your nvim-cmp configuration:

require("cmp").setup {
  -- ...
  sources = {
    { name = "feature-flipper" },
    -- other sources ...
  },
  -- ...
}

Using with blink.cmp

Since blink.cmp doesn't directly support nvim-cmp sources, you'll need to use the blink.compat compatibility layer. Install both plugins:

{
  'saghen/blink.compat',
  version = '2.*',
  lazy = true,
  opts = {},
  dependencies = {
    { 'wassimk/cmp-feature-flipper', version = '*' },
  },
},
{
  'saghen/blink.cmp',
  version = '1.*',
  opts = {
    sources = {
      per_filetype = {
        ruby = {
          inherit_defaults = true,
          'feature_flipper'
        },
      },
      providers = {
        feature_flipper = {
          name = 'feature_flipper',
          module = 'blink.compat.source',
        },
      },
    },
  },
}

Usage

Completion is triggered when you type any of the trigger strings followed by (". For example typing Features.enabled?(" would trigger the completion menu.

You can also trigger by ending the trigger string with a ' or : instead of the ".

Trigger Strings

• Features.enabled?
• Features.feature_enabled?
• featureEnabled
• feature_enabled?
• with_feature
• without_feature