Breaking Changes & Deprecation

[ful1e5]

Subscribe to this discussion to receive updates on breaking changes and deprecations.

[ful1e5]

88d4373 includes the removal of all supportive modules from the Vim configuration that were using vim.g.github_*. Please migrate to the setup Lua function.

For further information about the deprecated modules and their replacements, please refer to :h github-theme.deprecated or gt_deprecated.txt

[ful1e5]

Date: April 11, 2023
Ref: 33369e9

The theme_style option has been removed from the setup and the method of setting the colorscheme has changed. To set the colorscheme, use the :colorscheme command after calling setup.

Old approach for setting the theme:

  require('github-theme').setup({
    theme_style = 'dark',
    --- ...
  })

A new approach for setting the theme:

  require('github-theme').setup({
    --- ...
  })

  vim.cmd('colorscheme github_dark')
  -- or
  -- vim.cmd.colorscheme('github_dark')

[ful1e5]

Date: April 12, 2023
Ref: a5f6d56

The configuration for defining styles has been migrated to options.styles. As part of this migration, msg_area_style has been removed.

require('github-theme').setup({
   ...
-  comment_style = "Italic",
-  function_style = "NONE",
-  keyword_style = "Italic",
-  variable_style = "NONE",
-  msg_are_style = "NONE",    -- Removed
+  options = {
+    styles = {
+      comments = "Italic",
+      functions = "NONE",
+      keywords = "Italic",
+      variables = "NONE"
+    },
+  },
   ...
}

Here are the updated config keys:

• comment_style -> options.styles.comments
• function_style -> options.styles.functions
• keyword_style -> options.styles.keywords
• variable_style -> options.styles.variables
• msg_area_style -> Removed.

[ful1e5]

Date: April 23, 2023
Ref: 1a96bd0

The way to override color variables has been updated. You can now use the specs table to change colors for a specific colorscheme or for all of them with the all table. To override highlight groups, use the groups table in the configuration.

Some changes have been made to the names of the colorschemes. You can check the names of the colorschemes in the "colors" directory in the project root, or by using the :colorscheme vim command.

The deprecated colorschemes will no longer support any overriding highlight groups or color variables. The updated colorscheme list:

• github_dark_default -> github_dark_high_contrast
• github_dimmed -> github_dark_dimmed
• github_light_default -> github_light_high_contrast
• github_dark_tritanopia -> New!
• github_light_tritanopia -> New!

The updated configuration keys are:

• colors -> Use specs and palettes instead.
• overrides -> Use groups instead.

Example :

require('github-theme').setup({
  --- ...
  palettes = {
    github_dark = {
      canvas = {
        default = '#000000',
      },
    },
    all = {
      danger = {
        fg = '#FF0000',
      },
    },
  },
  specs = {
    github_dark_dimmed = {
      bg0 = '#111111',
    },
    all = {
      diag = {
        error = '#FF0000',
      },
    },
  },
  groups = {
    github_dark = {
      Error = { fg = '#FF0000' },
    },
    all = {
      ErrorMsg = { link = 'Error' },
    },
  },
})

vim.cmd.colorscheme('github_dark_colorblind')