CHANGES.md

ColorHelper

6.2.0

• NEW: Since browsers do not and may not introduce Color Level 4
  gamut mapping until some future spec, make gamut mapping approach
  configurable. Use clipping by default to match browsers as this is
  likely what people expect even if it is not an ideal approach. Use
  gamut_map in settings option to manually control the approach.
• NEW: Upgrade ColorAide to 2.3.
• FIX: Fix regression where contrast logic could not adjust to a
  given contrast due to a property access.

6.1.2

• FIX: Update to ColorAide 1.7.1.

6.1.1

• FIX: Fix broken gamut mapping logic after recent port of latest coloraide.

6.1.0

• NEW: Update to ColorAide 1.5.
• FIX: Fix issue where if a view does not have a syntax it could
  cause an exception.

6.0.3

• FIX: Fix registration of color spaces in custom color objects.

6.0.2

• FIX: Fix issue where default, dynamic color class wasn't always
  properly.

6.0.1

• FIX: Fix absolute import reference that should have been relative.

6.0.0

WARNING: We finally made it to a stable coloraide 1.x.x release,
but some more unforeseen changes had to be made. This has been a long
road to get the underlying color library to a stable state.

• User created custom plugins may need refactoring again, but most should be unaffected.
• If you tweaked the newadd_to_default_spaces, please compare against the default list as some plugins were renamed and user settings may need to get updated. Color space plugins that do not properly load should show log entries in the console.

• NEW: Upgraded to the stable coloraide 1.1. This should hopefully
  eliminate API churn as it is now a stable release.
• NEW: Log when default color space loading fails.
• FIX: Fix color picker slider issue.

5.0.1

• FIX: Fix issue with Sublime ColorMod.

5.0.0

BREAKING CHANGE: Newest coloraide was updated. It is approaching
a 1.0 release. In the path to a 1.0 release some refactoring and
reworking caused custom color classes to break. All internal color
classes should be fine, but any users that created custom local
color classes will need to update the color classes and color spaces
to work with the latest version.

• NEW: Upgrade to latest coloraide.
• NEW: Many new color spaces have been added and can optionally
  be included via the new add_to_default_spaces option. Some that
  were available previously are no longer registered by default.
  See add_to_default_spaces in the settings file to enable more
  spaces. A restart of Sublime Text is required when changing this
  setting.
• NEW: Add new add_to_default_spaces which allows a user to add
  NEW color spaces to the default color space so that the new spaces
  can be saved and recognized in palettes and other areas of ColorHelper.
  Modifying this setting requires a restart of Sublime Text. Custom
  color classes should only be used to modifying previously added
  color spaces to add to recognized input and output formats.

4.3.1

• NEW: Upgrade underlying coloraide library to fix a color parsing
  bug.

4.3.0

• NEW: Upgrade coloraide, along with various improvements brings
  the new HSLuv color space.
• NEW: New coloraide enforces the old Lch gamut mapping as some
  issues with the CSS recommended Oklch were discovered.
• NEW: Add HSLuv based color picker. Can be enabled in the settings.

4.2.0

• NEW: Upgrade coloraide library which brings back color mapping
  mapping in CIELCH. While interpolation is great in Oklab/Oklch, gamut
  mapping with chroma reduction in Oklch has some less desirable corner
  cases. Using Oklch is in the early stages in the CSS Color Level 4 spec
  and there needs to be more time for this to mature and be tested more.
• NEW: oklab() and oklch() CSS format is now available. This form
  is based on the published CSS Level 4 spec and requires lightness to be
  a percentage. In the future, it is likely that percentages will be
  optional for lightness and could even be applied to some of the other
  components, but currently, such changes are in some early drafts and
  not currently included in ColorHelper.

4.1.1

• FIX: Fix palette update logic that would not properly format the
  version.

4.1.0

• NEW: Add minimal color support in Sublime's built-in GraphViz
  syntax files. Colors are currently limited to hex RGB/RGBA and color
  names outside of HTML and full CSS support inside HTML. Support is
  experimental, and if false positives are a problem, the rule can be
  disabled in the settings.
• NEW: Don't default tmtheme custom class output to X11 names,
  default to hex codes instead.
• FIX: Fix some additional custom class issues related to latest
  coloraide update.

4.0.1

• FIX: Fix built-in custom color class match return. This caused files
  using one of the built-in color classes to fail in creating previews.

4.0.0

BREAKING CHANGE If you have defined custom colors rules and specifically reference xyz
rules should be updated to refer to xyz as xyz-d65.

• NEW: Update to latest coloraide which provides minor bug fixes.
  As the new version now includes type annotations, ColorHelper now
  requires the typing dependency until it can be migrated to use Python
  3.8. Typing refactor did moderately affect custom color classes.
• NEW: xyz is now known as xyz-d65 in the settings file.
  If you have custom rules that override or add xyz, please update
  the rules to reference xyz-d65 instead.
• NEW: Gamut mapping now uses Oklch instead of CIE LCH per CSS recnet
  specifications changes to the CSS Level 4 specification.
• NEW: Expose sRGB Linear color space per the CSS specification.
• FIX: Fix blend and blenda regression in emulation of Sublime's
  ColorMod implementation.
• FIX: ColorPicker should not show colors maps with opacity in the
  color map square.

3.8.0

• NEW: Allow selecting the preview gamut to control what RGB space
  images previews are rendered in. For example, before this change,
  macOS computers with Display P3 monitors would render sRGB colors
  as Display P3 colors and could provide inaccurate previews. Now
  you can set gamut_space to display-p3 and sRGB and Display P3
  colors will be closer to their actual color. Gamut can be set to
  srgb, display-p3, a98-rgb, prophoto-rgb, and rec2020.
  Colors will on only make sense on displays of these types with
  the appropriate color profile enabled. Directly related to
  sublimehq/sublime_text#4930.

3.7.0

• NEW: Color contrast tool will now take any color space, even non-sRGB,
  but the tool will only operate in the sRGB gamut as the compositing of
  transparent colors defaults to sRGB and the contrast targeting algorithm
  is currently done in the sRGB gamut using HWB. It will more clearly show
  that the color has been gamut mapped in the results as it will now show
  the modified color at all times.
• NEW: Upgrade coloraide which brings the possibility of using CIELuv,
  LCHuv, DIN99o, DIN99o LCH, Okhsl, and Okhsv. Small improvements and fixes
  also included.
• NEW: color(xyz x y z) now references D65 XYZ per latest CSS
  specifications. color(xyz-d50 x y z) is now the old D50 XYZ variant.
  color(xyz-d65 x y z) is also an alias for color(xyz x y z).
• NEW: HSV and HSL store non-hue channels internally in the range of
  0 - 1 instead of 0 - 100. This affects the color(space) output form.
• NEW: Color Picker for HWB is not enabled by default anymore, but can
  be enabled if desired via settings.
• NEW: ColorPicker improvements. Can now configure which color pickers
  are enabled. Can specify a preferred color picker. Can specify whether
  ColorHelper should take a color space and auto load the matching color
  picker if it is enabled. Add new HSV, Okhsl, and Okhsv color pickers.
• NEW: New coloraide dependency may break custom color spaces not
  provided with ColorHelper. If having issues, please open an issue to
  get help. It is doubtful that many have delved too deeply in this area.
• FIX: Fix typos and wording in various color tool dialogs.
• FIX: Better behavior of color picker's handling of color.
• FIX: Fix issues with Advanced Substation Alpha (ASS) support.
• FIX: Remove unnecessary dependencies.

3.6.0

• NEW: Add support for Advanced Substation Alpha (ASS).

3.5.0

• NEW: generic rule will now allow scanning in strings by default. If this
  is not desired, simply modify it in user settings to reflect desired behavior.
• NEW: Remove default palette file as it just contained examples that most
  people would never use.
• NEW: Color palettes now provide a format version so that they can be upgraded
  if needed. Due to the compatibility issue with a change for color() format,
  color palettes will be upgraded.
• FIX: color() format for lab and other colors that have percentage only
  channels must require those channels to be input as percentages per the CSS
  level 4 specifications. This affects the string output for the color() format
  as well.
• FIX: Latest coloraide improves gamut mapping.
• FIX: Small gamut fitting adjustments.
• FIX: Fix issue with duplicate previews when working with clone views.

3.4.0

• NEW: New color difference tool.
• NEW: New blend modes tool.
• NEW: Fix typo. 0xahex color class should have been named 0xhex in the
  settings.
• NEW: New coloraide brings support for oklab, oklch, jzazbz, jzczhz,
  ICtCp, D65 variations of CIELAB, CIELCH, and XYZ (none of which are enabled
  as output options by default).
• NEW: Some refactoring of coloraide caused custom color classes to get
  updated. User created custom classes may have to get updated to work.
• FIX: Upgrade coloraide which fixes issues related to inconsistent use of
  D65 white values in XYZ transforms and Bradford CAT and other lesser bug fixes
  as well. This particularly improves conversions to and from CIELAB.

3.3.1

• FIX: Ensure that contrast related functions are using XYZ with D65 white
  point instead of D50 in order to match WCAG 2.1 specifications.
• FIX: Fix some string output issues.
• FIX: Fix some algorithmic issues with Delta E 2000 which affects gamut
  mapping.

3.3.0

• NEW: preview_on_select now supports multi-select.
• NEW: Color picker channels only show 10 steps back or forward at a given
  time instead of 12 and are always perfectly scaled between 0% - 100%.
• NEW: Color box now shows hue on x-axis and saturation on y-axis. It also
  replaces the gray scale bar with a lightness bar.
• NEW: Color picker now is more compact and hides the sliders unless the
  user switches to slider mode. In that case, the color box will be hidden.
• NEW: Only the color picker's alpha channel will show a representation of
  transparency. This allows the user to clearly see the color when adjusting
  other channels.
• NEW: Color box in the color picker now shows an approximate indicator of
  where the current color falls on the color box.
• NEW: Add indication of which button is selected in the color picker.
• NEW: Vendor coloraide as ColorHelper is tightly coupled to it. Vendoring
  will ensure a better upgrade process. The default color classe is now referenced
  via ColorHelper.lib.coloraide opposed to the old coloraide.
• FIX: Fix issues related to detecting when colors are in the visible viewport.
• FIX: Ensure that when a native color picker is called with no color, that if
  the default color is picked, it will insert instead of ignore.

3.2.2

• FIX: Increase precision of palettes to properly match and store any colors.

3.2.1

• FIX: Ensure adding a color to a palette isn't shown when deleting palettes.

3.2.0

• NEW: Convert popup now lets you copy a color or insert a color.
• NEW: More tweaks to popup styles.
• NEW: Palette features, such as inserting a color from a palette and saving
  a color to a palette, are all available under the palette menu option from
  the main toolip. This consolidates options and makes the panel a bit more compact.
• NEW: Show current channel value in color picker's high resolution selector.
• FIX: Make "Out of gamut" tooltip more clear that it is referring to the preview
  gamut.
• FIX: Palettes colors were inconsistently saved and compared. This caused colors
  that were saved to "favorites" to sometimes not appear saved.
• FIX: Adjust scaling of images in regards to the graphic_size option. Medium
  should be a scale of 1, small a scale of 0.75, large a scale of 1.25. For greater
  control, use graphic_scale.
• FIX: Windows color picker should use ctypes.pointer not ctypes.byref. Fixes
  Windows color picker not working on ST4.

3.1.4

• FIX: Fix tmTheme handling of compressed hex colors.

3.1.3

• FIX: A few fixes to new style.

3.1.2

• FIX: Improved visuals for popups and TextInputHandlers. Improve consistency
  in how things are presented.
• FIX: In color picker, values in the hue channel should clamp at 359 not 360 as
  360 wraps to 0.
• FIX: Fix a few transitions between different popups.

3.1.1

• FIX: Fix Windows color picker not processing color properly.
• FIX: Make sure Windows color picker stores and retrieves custom colors.

3.1.0

• NEW: Drop support for ColorPicker package and instead implement OS color pickers
  directly in ColorHelper. Linux users will need to install kcolorchooser,
  and it must be in the path on the command line

3.0.2

• FIX: Fix typo in color trigger pattern in 3.0.1 fix.

3.0.1

• FIX: Ignore color keywords when they are preceded by $ (SCSS). Also fix issue
  with - trailing a keyword.

3.0.0

• NEW: New supported color spaces: lch, lab, display-p3, rec-2020, xyz,
  prophoto-rgb, a98-rgb, and hsv.
• NEW: rgb, hsl, and hwb all support the new CSS format rgb(r g b / a).
• NEW: gray() dropped as it is no longer part of the CSS level 4 specifications.
• NEW: All instances of blacklist and whitelist are now known as blocklist
  and allowlist respectively.
• NEW: Outputs, when inserting or converting, can be controlled in settings file.
• NEW: Color triggers (what ColorHelper searches for before testing if the text
  is a color) can be configured in settings file. This can allow a user to not trigger
  on certain formats.
• NEW: If desired, users can provided a custom color class object to use for certain
  files that can augment one or more supported color space's accepted input and output
  formats.
• NEW: Improvements to scanning. Scanning will only occur in the viewable viewport.
  Text that is not visible, both vertically or horizontally, will not be scanned until
  it scrolls into view.
• NEW: New option preview_on_select to show color previews only when the cursor is
  on the color or selecting the color (currently only applied to one selection).
• NEW: New color edit tool which allows a user to get a live update of the color as
  they alter the coordinates, and allows the user to mix it with one other color. The
  result can be inserted back into the file, or will be handed back to the color picker
  if called from there.
• NEW: New color contrast tool which allows a user to see the contrast ratio and
  see a visual representation of how the two colors contrast. The resulting foreground
  color can be inserted back into the file, or will be handed back to the color picker
  if called from there.
• NEW: New Sublime ColorMod tool which allows a user to see a color-mod expression
  update a live color preview on the fly.
• NEW: Only one color rule (defined in the settings file) will apply to a given view.
• NEW: Renamed color_scan option to color_rule.
• NEW: Massive overhaul of color scanning and color scanning options.
• NEW: Colors that are out of gamut will be gamut mapped. On hover of the preivew
  (on ST4), it will indicate that it has been gamut mapped. This can be changed via
  show_out_of_gamut_preview, and additionally a fully transparent color swatch with a
  "red-ish" border will be shown (color may vary based on color scheme). On mouse over,
  it will also indicate that it is out of gamut on ST4.
• NEW: ColorHelper will now gamut map colors in some scenarios, either due to
  necessity, or by user setting.
• NEW: New generic option is defined which provides a default input and output for
  files with no rules. Users can use the color picker, and other color tools, from any
  file now. Scanning is disabled by default and can be enabled if desired. generic can
  be tweaked to provide whatever fallback experience the user desired.
• NEW: New command added to force scanning in a file that may have scanning disabled.
  Also can force a file with scanning enabled to be disabled.
• NEW: Color helper will now recognize transparent.
• NEW: Color picker rainbow box will adjust based on the saturation of the current
  selected color.
• NEW: Color picker will give a clear indication when you are at the end of a color
  channel by showing no more boxes.
• NEW: Provide user_color_rules where a user can append rules without overwriting the
  entire rule set. If a rule uses the same name as one of the existing default rules,
  a shallow merge will be done so the values of the top level keys will be overridden
  with the user keys and/or any additional keys will be added.
• REMOVED: Color completion. It mainly got in the way. The palette can be called any
  time the user needs it.
• REMOVED: Hex shaped color picker option has been removed.
• REMOVED: Removed "current file palette". ColorHelper will no longer scan the entire
  current file and generate a palette. This only worked in a limited number of files and
  added much more complexity.
• REMOVED: Various options from rules sets. These are now controlled by the color
  class object that is being used. For instance, input and output format of colors in the
  form #AARRGGBB instead of the default #RRGGBBAA would need to use the new example
  ColorHelper.custom.ahex.ColorAhex custom color object to read in and output hex colors
  with leading alpha channels.
• FIX: Insert logic issues.
• FIX: ColorPicker now will always work in the color space of the current mode. This
  fixes some conversion issues.

2.7.1

• FIX: Fix issues with 2.7.X release and latest mdpopups.

2.7.0

• NEW: HSL can support alpha channels as hsl or hsla (per the CSS spec).
• NEW: HSL and HWB now support units deg, turn, rad, grad for the hue channel.

2.6.0

• NEW: Enable CSS level 4 colors by default.
• NEW: Reduce borders and in some cases remove borders around color previews.
• NEW: Allow insertion of colors when there is an active selection.
• NEW: Add option to override the border color used around color previews in
  the popup.
• FIX: Reduce busy processes when idle.
• FIX: Fixes for SCSS and Sass packages.
• FIX: Fix issue where inline color phantom could make the line height larger.
• FIX: Fix compressed hex with alpha handling.
• FIX: Fix hwb display in info dialog.
• FIX: Project palettes not showing up.
• FIX: Fix for compressed hex colors with alpha.
• FIX: Ensure minimum size of graphics in order to prevent issue where an
  error is thrown when image size is too small.

2.5.1

• FIX: Flicker of colors due to overly aggressive color preview deletion.
• FIX: Update to latest rgba library.

2.5.0

• NEW: Use the newer API for opening settings #78.
• NEW: Require ST 3124+ (this will also be limited in Package Control soonish).
• NEW: Add basic support for Less #92.
• FIX: Small fonts are not as small now.

2.4.2

• FIX: Fix HTML escape of palette names. #84
• FIX: Fix preview clicking. #81
• FIX: Fix margins on previews. #83

2.4.1

• FIX: Speed improvements for rendering previews.
• FIX: More fixes for duplicate preview prevention.

2.4.0

• NEW: More subtle preview borders. 7e983cd
• FIX: Setting race condition. 2336ee5
• FIX: Fix preview tagging. #72
• FIX: Fix CSS3 support. #73
• FIX: Consistent handling hex casing. #74

2.3.0

• NEW: New quickstart command in menu.
• NEW: Links in menu to navigate to official documentation and issue tracker.
• FIX: Fix for Sass. #68

2.2.0

• New: Add support for stTheme and search cdata #59.
• NEW: Workaround for Windows 10 HiDpi large image issue #61.
  See document for more info.
• NEW: Added toggle support for left/right positioned previews #65.
  See document for more info.
• FIX: Web Color insertion bug #62.
• FIX: Preview duplication bug (hopefully -- please report if not fixed) #57.

2.1.1

• FIX: CSS tweaks (minihtml)
• FIX: Support for CSS3 package

2.1.0

• NEW: Moved popup panel formatting into external template files. Requires
  mdpopups 1.9.3.
• FIX: Fix issues where certain popups (colorpicker after manual color
  edit) would get overridden by auto-popups of the color info panel.
• FIX: Issues related to inserted colors.
• FIX: Fixed issue where certain colors that required word boundaries where
  still getting marked even though they were preceeded by invalid characters such
  as @#$.-_.

2.0.5

• FIX: Fix changelog typo
• FIX: Fix odd behavior when checking padding

2.0.4

• NEW: Changelog command available in Package Settings->ColorHelper.
  Will render a full changelog in an HTML phantom in a new view.
• FIX: Move colorbox before color I like this as now the colorbox resides
  within the region of the color. And they will all line up even if color
  format is different following them. (Fixes #46)
• FIX: Fix flicker on colorbox click. (Fixes #41)

2.0.3

• FIX: Don't allow previews to truncated colors.
• FIX: When validating existing phantoms, ensure the scopes still match
  (like when code gets commented out etc.).
• FIX: Support new rem units if using mdpopups 1.8.0 for better font
  scaling.

2.0.2

• FIX: Fix breakage for ST versions without phantoms.

2.0.1

• FIX: Less clearing of inline images.
• FIX: Per os/host setting for inline_preview_offset and graphic_size.
• FIX: Single border around preview that contrasts with the the theme
  background.

2.0.0

• NEW: Show inline color previews in Sublime Text 3118+! Can be turned off
  if the feature is not desired.
• NEW: Should update mdpopups to the latest one on Package Control
  upgrade (restart required after upgrade). Haven't actually confirmed if it
  works.
• FIX: Images should scale with font size in Sublime Text 3118+. You can
  still select small, medium, and large resources, but they will be relative to
  the font size now.

1.4.2

• FIX: #39 Fix font size too small in popup.

1.4.1

• FIX: Remove distortion workarounds as later Sublime versions no longer
  distort images.
• FIX: Utilize latest mdpopups to handle font sizes.

1.4.0

• NEW: Allow disabling status message via the settings file option
  show_status_index.
• FIX: Fix decimal level tracking when indexing.

1.3.5

• FIX: Fixed issue where stored decimal size was faulty and could cause
  the current file color indexing to fail.

1.3.4

• FIX: Fix logic for populating a view's ColorHelper specific settings on
  activation and save.

1.3.3

• FIX: Fixes related to gray, hsla, and hwba.

1.3.2

• FIX: Fix version in message.

1.3.1

• FIX Forgot to strip extension on syntax compare.

1.3.0

• NEW: Color preview will now show transparent colors with and without
  transparency.
• NEW: Transparent colors can now be stored and showed in palettes.
• NEW: Specifying files for scanning has been reworked and is now more
  flexible.
• NEW: Color Helper no longer has preferred formats when inserting. It
  will always prompt the user for their desired input format.
• NEW: Added CSS4's rebeccapurple to the webcolor names.
• NEW: Added better rgb and rgba support: percentage format, decimal
  format (CSS4), percentage alpha (CSS4).
• NEW: Added support for alpha channel as percentage for hsla (CSS4).
• NEW: Support CSS4 gray, hwb, and hex values with alpha channels.
• NEW: Option to read hex with alpha channel as #AARRGGBB instead of
  #RRGGBBAA.
• NEW: Option to compress hex values if possible on output: #334455 -->
  #345.
• NEW: Can disable auto-popups if desired.
• NEW: Insert options now are now more dynamic and only show valid options
  for the current view.
• FIX: Clamp color channel values out of range.

1.2.1

• FIX: Remove project commands that do nothing

1.2.0

• NEW: Color picker will appear in palette panel if no color info panel
  is allowed.
• NEW: Added "supported_syntax_incomplete_only" for incomplete colors that
  may not yet be scoped within a valid scope due to being incomplete.
• NEW: In the color picker, instead of the select link, you now must
  choose the css format to insert via the corresponding >>> link.
• NEW: Add alternate rectangular color picker look. You can use the new
  form by disabling the hex color picker look via the use_hex_color_picker
  setting.
• NEW: Added new CSS Color Name picker (available in the color picker).
• FIX: When manually forcing the popup via the command palette, the tooltip was getting closed. ColorHelper is now aware of manual and auto popup
  tooltips and will only auto close the auto popups when ignored while typing.

1.1.0

• NEW: Color picker built into the tooltips (optionally can be overridden
  with ColorPicker Package's color picker).
• NEW: Graphic sizes are now configurable in settings.
• NEW: Color tooltip used to popup up when a user started to type a color,
  but would stay open even when the user ignored it. Now it will auto close in
  this scenario.
• NEW: Settings are accessible via Preferences->Package Settings->ColorHelper
  in the menu. Support for the SCSS package added.

1.0.3

• FIX: Use dependency that does not clash
• FIX: Add more scope support for POST CSS

1.0.2

• FIX: Typo in code where view_window should have been view.window

ColorHlper 1.0.1

• FIX: Markdown dependency needs to not clash with default Markdown
  package. Renamed to python-markdown.

1.0.0

• NEW: Initial release.