Merge pull request #261 from krassowski/interface/diagnostics_panel/fix-caret-icons

Fix caret icon in diagnostics panel (port to JupyterLab 2.0) #258

Author: krassowski

CHANGELOG.md

@@ -6,8 +6,10 @@
 
   - fixes currently-highlighted token in dark editor themes against light lab theme
     (and vice versa) ([#195][])
+  - restores sorting order-indicating caret icons in diagnostics panel table ([#261][])
 
 [#195]: https://github.com/krassowski/jupyterlab-lsp/issues/195
+[#261]: https://github.com/krassowski/jupyterlab-lsp/issues/261
 
 ### `@krassowski/jupyterlab-lsp 1.0.0` (2020-03-14)
 

packages/jupyterlab-lsp/package.json

@@ -19,7 +19,7 @@
   "license": "BSD-3-Clause",
   "author": "Michał Krassowski",
   "files": [
-    "{lib,style,schema,src}/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf,css,json,ts,tsx}"
+    "{lib,style,schema,src}/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf,css,json,ts,tsx,txt,md}"
   ],
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

packages/jupyterlab-lsp/src/adapters/codemirror/features/diagnostics.ts

@@ -11,7 +11,8 @@ import {
   DIAGNOSTICS_LISTING_CLASS,
   DiagnosticsDatabase,
   DiagnosticsListing,
-  IEditorDiagnostic
+  IEditorDiagnostic,
+  diagnosticsIcon
 } from './diagnostics_listing';
 import { VirtualDocument } from '../../../virtual/document';
 import { VirtualEditor } from '../../../virtual/editor';
@@ -46,6 +47,7 @@ class DiagnosticsPanel {
     widget.id = 'lsp-diagnostics-panel';
     widget.title.label = 'Diagnostics Panel';
     widget.title.closable = true;
+    widget.title.icon = diagnosticsIcon;
     return widget;
   }
 

packages/jupyterlab-lsp/src/adapters/codemirror/features/diagnostics_listing.tsx

@@ -1,5 +1,6 @@
 import React, { ReactElement } from 'react';
 import { VDomModel, VDomRenderer } from '@jupyterlab/apputils';
+import { caretDownIcon, caretUpIcon, LabIcon } from '@jupyterlab/ui-components';
 import * as lsProtocol from 'vscode-languageserver-protocol';
 import * as CodeMirror from 'codemirror';
 import { IEditorPosition } from '../../../positioning';
@@ -12,6 +13,13 @@ import { Cell } from '@jupyterlab/cells';
 import { diagnosticSeverityNames } from '../../../lsp';
 import { message_without_code } from './diagnostics';
 
+import diagnosticsSvg from '../../../../style/icons/diagnostics.svg';
+
+export const diagnosticsIcon = new LabIcon({
+  name: 'lsp:diagnostics',
+  svgstr: diagnosticsSvg
+});
+
 /**
  * Diagnostic which is localized at a specific editor (cell) within a notebook
  * (if used in the context of a FileEditor, then there is just a single editor)
@@ -161,19 +169,20 @@ class Column {
 
 function SortableTH(props: { name: string; listing: DiagnosticsListing }): any {
   const is_sort_key = props.name === props.listing.sort_key;
+  const sortIcon =
+    !is_sort_key || props.listing.sort_direction === 1
+      ? caretUpIcon
+      : caretDownIcon;
   return (
     <th
       key={props.name}
       onClick={() => props.listing.sort(props.name)}
-      className={
-        is_sort_key
-          ? 'lsp-sorted ' +
-            (props.listing.sort_direction === 1 ? 'lsp-descending' : '')
-          : ''
-      }
+      className={is_sort_key ? 'lsp-sorted-header' : null}
     >
-      {props.name}
-      {is_sort_key ? <span className={'lsp-caret'} /> : null}
+      <div>
+        <label>{props.name}</label>
+        <sortIcon.react tag="span" className="lsp-sort-icon" />
+      </div>
     </th>
   );
 }
@@ -230,19 +239,29 @@ export class DiagnosticsListing extends VDomRenderer<DiagnosticsListing.Model> {
     new Column({
       name: 'Cell',
       render_cell: row => <td key={5}>{row.cell_number}</td>,
-      sort: (a, b) => (a.cell_number > b.cell_number ? 1 : -1),
+      sort: (a, b) =>
+        a.cell_number > b.cell_number
+          ? 1
+          : a.data.range.start.line > b.data.range.start.line
+          ? 1
+          : a.data.range.start.ch > b.data.range.start.ch
+          ? 1
+          : -1,
       is_available: context => context.editor.has_cells
     }),
     new Column({
-      name: 'Line',
-      render_cell: row => <td key={6}>{row.data.range.start.line}</td>,
+      name: 'Line:Ch',
+      render_cell: row => (
+        <td key={6}>
+          {row.data.range.start.line}:{row.data.range.start.ch}
+        </td>
+      ),
       sort: (a, b) =>
-        a.data.range.start.line > b.data.range.start.line ? 1 : -1
-    }),
-    new Column({
-      name: 'Ch',
-      render_cell: row => <td key={7}>{row.data.range.start.line}</td>,
-      sort: (a, b) => (a.data.range.start.ch > b.data.range.start.ch ? 1 : -1)
+        a.data.range.start.line > b.data.range.start.line
+          ? 1
+          : a.data.range.start.ch > b.data.range.start.ch
+          ? 1
+          : -1
     })
   ];
 

packages/jupyterlab-lsp/src/typings.d.ts

@@ -2,3 +2,8 @@
 // Distributed under the terms of the Modified BSD License.
 
 /// <reference path="../typings/codemirror/codemirror.d.ts"/>
+
+declare module '*.svg' {
+  const script: string;
+  export default script;
+}

packages/jupyterlab-lsp/style/diagnostics_listing.css

@@ -19,8 +19,13 @@
   overflow-x: hidden;
 }
 
+.lsp-diagnostics-listing th,
+.lsp-diagnostics-listing td {
+  padding: 4px 12px 2px 12px;
+  height: 18px;
+}
+
 .lsp-diagnostics-listing th {
-  padding: 4px 12px;
   font-weight: 500;
   text-align: left;
   border-bottom: var(--jp-border-width) solid var(--jp-border-color1);
@@ -44,37 +49,35 @@
   content: ' > ';
 }
 
-.lsp-diagnostics-listing td:first-child,
-.lsp-diagnostics-listing td:last-child {
-  padding: 4px 12px;
+.lsp-diagnostics-listing tbody tr:hover {
+  background: var(--jp-layout-color2);
+}
+
+.lsp-diagnostics-listing thead th > div {
+  flex-direction: row;
+  display: flex;
 }
 
-.lsp-diagnostics-listing tbody td:not(:first-child):not(:last-child) {
-  padding: 4px 2px;
+.lsp-diagnostics-listing thead th > div > label {
+  flex: 1;
+  text-overflow: ellipsis;
 }
 
-.lsp-diagnostics-listing tbody tr:hover {
-  background: var(--jp-layout-color2);
+.lsp-sort-icon {
+  flex: 0;
+  height: var(--jp-ui-font-size1);
+  width: var(--jp-ui-font-size1);
 }
 
-.lsp-sort-caret {
-  height: 16px;
-  width: 16px;
-  background-size: 18px;
-  background-image: 18px;
-  background-repeat: no-repeat;
-  background-position: center;
-  display: inline-block;
-  position: relative;
-  top: 3px;
+.lsp-sort-icon svg {
+  display: inline;
+  height: auto;
 }
 
-.lsp-sorted .lsp-caret {
-  background-image: var(--jp-icon-caretup);
-  margin-top: -4px;
-  left: 3px;
+.lsp-diagnostics-listing thead th:not(.lsp-sorted-header) .lsp-sort-icon {
+  opacity: 0;
 }
 
-.lsp-sorted.lsp-descending .lsp-caret {
-  background-image: var(--jp-icon-caretdown);
+.lsp-diagnostics-listing thead th:not(.lsp-sorted-header):hover .lsp-sort-icon {
+  opacity: 0.5;
 }

packages/jupyterlab-lsp/style/icons/LICENSE.materialdesignicons.txt

@@ -0,0 +1,96 @@
+Copyright (c) 2014, Austin Andrews (http://materialdesignicons.com/),
+with Reserved Font Name Material Design Icons.
+Copyright (c) 2014, Google (http://www.google.com/design/)
+uses the license at https://github.com/google/material-design-icons/blob/master/LICENSE
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

packages/jupyterlab-lsp/style/icons/README.md

@@ -0,0 +1,6 @@
+The following icons in this directory are open source, and are © their
+respective license holders:
+
+## Material Design Icons [OFL 1.1](<(./LICENSE.materialdesignicons.txt)>)
+
+- [diagnostics.svg](./diagnostics.svg)