latex-stickies 1.4.2 → 1.4.3

package/README.md

@@ -169,6 +169,7 @@ node scripts/render-check.js      # the first-run note renders correctly
 node scripts/ghost-check.js       # autocomplete suggests, and Tab accepts
 node scripts/snapshot-check.js    # a long note is captured whole
 node scripts/conflict-check.js    # the changed-on-disk banner behaves
+node scripts/denied-check.js      # a notes folder it may not read is reported
 node scripts/verify-install.js    # the install path, end to end (macOS)
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "latex-stickies",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "Sticky notes for your desktop that render LaTeX and Markdown.",
   "main": "src/main.js",
   "scripts": {
@@ -25,6 +25,9 @@
     ],
     "mac": {
       "category": "public.app-category.productivity",
+      "extendInfo": {
+        "NSDocumentsFolderUsageDescription": "LaTeX Stickies keeps your notes as Markdown files in Documents, so you can read and edit them with any other app."
+      },
       "target": [
         "dmg",
         "zip"

package/scripts/brand-electron.js

@@ -94,6 +94,10 @@ function isCurrent(version) {
   }
 }
 
+/** Shown in the macOS prompt asking to let the app read the notes folder. */
+const DOCUMENTS_REASON = 'LaTeX Stickies keeps your notes as Markdown files in '
+  + 'Documents, so you can read and edit them with any other app.';
+
 function setPlist(plist, key, value) {
   try {
     run('plutil', ['-replace', key, '-string', value, plist]);
@@ -126,6 +130,10 @@ function build(app, version) {
   setPlist(plist, 'CFBundleDisplayName', NAME);
   setPlist(plist, 'CFBundleIdentifier', APP_ID);
   setPlist(plist, 'CFBundleExecutable', NAME);
+  // Without this key macOS denies the notes folder without ever asking. The
+  // app then starts, reads nothing and shows no window, which looks exactly
+  // like a launch that failed.
+  setPlist(plist, 'NSDocumentsFolderUsageDescription', DOCUMENTS_REASON);
 
   const from = path.join(TARGET, 'Contents', 'MacOS', 'Electron');
   const to = path.join(TARGET, 'Contents', 'MacOS', NAME);

package/src/editor/entry.js

@@ -20,7 +20,9 @@ import {
   defaultKeymap, history, historyKeymap, indentWithTab,
   cursorLineUp, cursorLineDown, selectLineUp, selectLineDown,
 } from '@codemirror/commands';
-import { markdown, markdownLanguage } from '@codemirror/lang-markdown';
+import {
+  markdown, markdownLanguage, insertNewlineContinueMarkup,
+} from '@codemirror/lang-markdown';
 import {
   syntaxTree, HighlightStyle, syntaxHighlighting, defaultHighlightStyle,
   LanguageDescription,
@@ -70,7 +72,7 @@ window.CM = {
   EditorView, keymap, Decoration, WidgetType, ViewPlugin,
   defaultKeymap, history, historyKeymap, indentWithTab,
   cursorLineUp, cursorLineDown, selectLineUp, selectLineDown,
-  markdown, markdownLanguage,
+  markdown, markdownLanguage, insertNewlineContinueMarkup,
   syntaxTree, HighlightStyle, syntaxHighlighting, defaultHighlightStyle,
   tags, codeLanguages,
   search, searchKeymap, highlightSelectionMatches, openSearchPanel,

package/src/main.js

@@ -527,6 +527,37 @@ function watchNotesFolder() {
   });
 }
 
+/**
+ * macOS can refuse the notes folder outright, and quietly.
+ *
+ * Documents is protected, and permission is tied to the app's signature -- so
+ * a rebuilt copy is a different app to the system and starts again with no
+ * access. Reading the folder then fails, nothing is restored and no window
+ * opens, which is indistinguishable from a launch that crashed. Say what
+ * happened instead, and offer the settings pane that fixes it.
+ */
+function reportNoAccess(err) {
+  // Printed as well as shown: the dialog is the answer for the person at the
+  // screen, this line is what a harness or a bug report can see.
+  console.error(`notes folder refused: ${err.code} ${store.DIR}`);
+  const settings = 'x-apple.systempreferences:com.apple.preference.security'
+    + '?Privacy_DocumentsFolder';
+  const choice = dialog.showMessageBoxSync({
+    type: 'error',
+    message: 'LaTeX Stickies cannot read your notes',
+    detail: `macOS is not letting it open ${store.DIR}.\n\n`
+      + 'Allow it under Privacy & Security, in Files and Folders, then open '
+      + `the app again.\n\n(${err.code}: ${err.message})`,
+    buttons: ['Open Privacy Settings', 'Quit'],
+    defaultId: 0,
+  });
+  if (choice === 0 && process.platform === 'darwin') shell.openExternal(settings);
+  app.quit();
+}
+
+/** True when the filesystem said no, rather than the folder being absent. */
+const denied = (err) => err && (err.code === 'EPERM' || err.code === 'EACCES');
+
 app.whenReady().then(async () => {
   // Run from npm there is no .app bundle of our own to carry the icon, so
   // macOS would show the generic Electron atom in the Dock. Set it explicitly.
@@ -546,9 +577,15 @@ app.whenReady().then(async () => {
     }
   }
 
-  await buildMenu();
-  restoreNotes();
-  watchNotesFolder();
+  try {
+    await buildMenu();
+    restoreNotes();
+    watchNotesFolder();
+  } catch (err) {
+    if (!denied(err)) throw err;
+    reportNoAccess(err);
+    return;
+  }
 
   if (SMOKE_CLOSE_MS) {
     setTimeout(() => {

package/src/renderer/live-editor.js

@@ -19,7 +19,7 @@ const {
   WidgetType, ViewPlugin, keymap, Prec,
   defaultKeymap, history, historyKeymap, indentWithTab,
   cursorLineUp, cursorLineDown, selectLineUp, selectLineDown,
-  markdown, markdownLanguage, codeLanguages,
+  markdown, markdownLanguage, codeLanguages, insertNewlineContinueMarkup,
   syntaxTree, HighlightStyle, syntaxHighlighting, defaultHighlightStyle, tags,
   search, searchKeymap, highlightSelectionMatches,
 } = window.CM;
@@ -312,6 +312,8 @@ const HIDE = Decoration.replace({});
  */
 const MARKER = Decoration.mark({ class: 'cm-md-marker' });
 
+
+
 /** Elements whose markers are shown while the caret is inside them. */
 const REVEAL = new Set([
   'Emphasis', 'StrongEmphasis', 'Strikethrough', 'InlineCode', 'FencedCode',
@@ -616,8 +618,13 @@ const markerReveal = ViewPlugin.fromClass(class {
     this.sync();
   }
 
-  update(update) {
-    if (update.docChanged || update.selectionSet || update.viewportChanged) this.sync();
+  update() {
+    // Every update, not only the ones that moved the caret. The parser runs
+    // behind the keystroke, so the first "#" of a heading arrives as a plain
+    // character and becomes a marker on a later update that changed neither
+    // the document nor the selection. Skipping those left the reveal one
+    // keystroke behind: a heading stayed hidden while it was being typed.
+    this.sync();
   }
 
   destroy() {
@@ -630,12 +637,21 @@ const markerReveal = ViewPlugin.fromClass(class {
     let from = -1;
     let to = -1;
     if (!snapshotMode) {
-      for (let node = syntaxTree(view.state).resolveInner(sel.from, 1); node; node = node.parent) {
-        if (REVEAL.has(node.name) && sel.to <= node.to) {
-          from = node.from;
-          to = node.to;
-          break;
+      const tree = syntaxTree(view.state);
+      // Both sides of the caret, and the side before it first. Typing "###"
+      // leaves the caret at the end of the line, where the node *starting*
+      // here is the document, not the heading -- so looking forward only, a
+      // heading stayed hidden the whole time you were typing it.
+      const enclosing = (side) => {
+        for (let node = tree.resolveInner(sel.from, side); node; node = node.parent) {
+          if (REVEAL.has(node.name) && sel.to <= node.to) return node;
         }
+        return null;
+      };
+      const node = enclosing(-1) || enclosing(1);
+      if (node) {
+        from = node.from;
+        to = node.to;
       }
     }
     for (const el of view.contentDOM.querySelectorAll('.cm-md-marker')) {
@@ -669,9 +685,24 @@ const livePreview = StateField.define({
 
 /* ---------- how markdown reads ---------- */
 
+/**
+ * Markers are punctuation, not prose, and should not compete with the text
+ * they mark up. CodeMirror's default paints them #404740 -- all but the ink
+ * colour -- because every marker carries tags.processingInstruction, a child
+ * of meta, and defaultHighlightStyle is loaded here for its code colours.
+ *
+ * A flat grey rather than a faded ink: fading a marker into the paper is what
+ * made an H1 and an H2 indistinguishable while one was being typed.
+ */
+const MARKER_INK = '#757575';
+
 const markdownStyle = HighlightStyle.define([
   // textDecoration: 'none' is deliberate -- defaultHighlightStyle, loaded for
   // the colours inside code fences, underlines every heading.
+  // One entry covers every marker: the hashes, the stars, the backticks, the
+  // quote arrow, the list dash, a table's pipes and a strikethrough's tildes
+  // all carry this tag.
+  { tag: tags.processingInstruction, color: MARKER_INK },
   { tag: tags.heading, textDecoration: 'none' },
   { tag: tags.heading1, fontSize: '1.35em', fontWeight: '600', textDecoration: 'none' },
   { tag: tags.heading2, fontSize: '1.18em', fontWeight: '600', textDecoration: 'none' },
@@ -777,6 +808,17 @@ function verticalStep(forward, base, extend) {
   };
 }
 
+/**
+ * Enter carries a list on: a new bullet, the next number, another empty task
+ * box, or a second quote line -- and a second Enter on an item with nothing in
+ * it ends the list instead of adding to it.
+ *
+ * Without this, pressing Enter after "- [ ] milk" left a bare line, and typing
+ * "[ ] eggs" there looks like a task and is not one: the box only means
+ * anything inside a list item.
+ */
+const continueList = [{ key: 'Enter', run: insertNewlineContinueMarkup }];
+
 const verticalKeymap = [
   { key: 'ArrowUp', run: verticalStep(false, cursorLineUp), preventDefault: true },
   { key: 'ArrowDown', run: verticalStep(true, cursorLineDown), preventDefault: true },
@@ -804,6 +846,7 @@ function createLiveEditor({ parent, doc, onChange }) {
         // Ahead of the defaults, so Mod-i and friends are not swallowed.
         Prec.high(keymap.of(shortcuts)),
         Prec.high(keymap.of(verticalKeymap)),
+        Prec.high(keymap.of(continueList)),
         // Search ahead of the defaults: Cmd+F must open the panel rather than
         // fall through to anything else bound to it.
         Prec.high(keymap.of(searchKeymap)),

package/src/renderer/note.css

@@ -237,9 +237,13 @@ body.editing #tools > * { visibility: visible; }
   opacity: 0;
   transition: max-width 0.12s ease, opacity 0.12s ease;
 }
+/* Full strength, not a hint. A revealed marker is there to be edited -- you
+   are counting hashes to see what level a heading is, or putting the caret
+   between a pair of stars -- and a washed-out one is hard to read against
+   the paper. It is the hiding that keeps the note clean, not the fading. */
 .cm-editor .cm-md-marker-open {
   max-width: 4em;
-  opacity: 0.35;
+  opacity: 1;
 }
 
 /* Sits at the end of a block's opening fence line, beside the language name. */