Make title search independent from DocQuery search

Fixes #28.

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.8.0
+- Add a feature to delete an empty note automatically when closing its pane
+
+## 0.7.0
+- Add `extensions` setting
+
+## 0.5.0
+- Add `useLunrPipeline` setting
+- Improve autoselect/autocomplete logic
+- Fix a bug that autocomplete feature does not work
+
+## 0.4.0
+- Rename `notational-velocity` to `nvatom`
+- Copy `notational-velocity` settings/notes on initialization
+
 ## 0.3.0
 - Fix the bug that the default note directory is within packages directory. If it happens, it **deletes** all of existing notes. If you read this before updating the package, please check your note directory before updating it.
 

README.md

@@ -1,5 +1,7 @@
 # Notational Velocity for Atom
 
+*`notational-velocity` package is renamed to `nvatom` package due to a fatal bug. For more info, refer [migration section](#migration).*
+
 [![Build Status][3]][4]
 
 [Notational Velocity][1] is an application that stores and retrieves notes.
@@ -26,13 +28,13 @@ We do believe Notational Velocity is the precursor of the famous note-taking app
 
 ## Settings
 
-To configure your note directory, set `notational-velocity.directory`:
+To configure your note directory, set `nvatom.directory`:
 
 * Open your `~/.atom/config.cson` file from the menu: *Atom > Open Your Config*
 * Append the following lines:
 
     ```cson
-      'notational-velocity':
+      'nvatom':
         directory: '/path/to/your/notes'
     ```
 
@@ -52,9 +54,17 @@ You can also override `cmd-l` if you want to keep your muscle memory from Notati
 'atom-text-editor':
   'cmd-l': 'unset!'
 'atom-workspace':
-  'cmd-l': 'notational-velocity:toggle'
+  'cmd-l': 'nvatom:toggle'
 ```
 
+## Migration
+
+v0.1.0 under published package name `notational-velocity` had a fatal bug that sets the default value of its note directory under package directory. In that case, all notes are deleted once the user updates the package, since package directory is overwritten when the user. For more information, refer [#25][6].
+
+To resolve this problem, we renamed our package name to `nvatom`. Users who have the old `notational-velocity` need to **install `nvatom` package first**, activate the package to automatically migrate the existing notes, and then delete `notational-velocity` package.
+
+Since keymaps overlap with `notational-velocity`, follow the menu *Packages > nvAtom > Toggle* to activate this package.
+
 ## References
 
 - [Notational Velocity](http://notational.net/)
@@ -66,6 +76,7 @@ You can also override `cmd-l` if you want to keep your muscle memory from Notati
 
 [1]: http://notational.net/
 [2]: http://daringfireball.net/projects/markdown/syntax
-[3]: https://travis-ci.org/seongjaelee/notational-velocity.svg?branch=master
+[3]: https://travis-ci.org/seongjaelee/nvatom.svg?branch=master
-[4]: https://travis-ci.org/seongjaelee/notational-velocity
+[4]: https://travis-ci.org/seongjaelee/nvatom
 [5]: https://cloud.githubusercontent.com/assets/948301/7246990/2e2b4c6e-e7b9-11e4-93b0-57954e011e81.gif
+[6]: https://github.com/seongjaelee/nvatom/issues/25

keymaps/notational-velocity.cson

@@ -8,4 +8,4 @@
 # For more detailed documentation see
 # https://atom.io/docs/latest/advanced/keymaps
 'atom-workspace':
-  'alt-cmd-l': 'notational-velocity:toggle'
+  'alt-cmd-l': 'nvatom:toggle'

lib/notational-velocity-view.coffee

@@ -2,22 +2,22 @@ path = require 'path'
 fs = require 'fs-plus'
 _ = require 'underscore-plus'
 {$, $$, SelectListView} = require 'atom-space-pen-views'
-DocQuery = require 'DocQuery'
+DocQuery = require 'docquery'
 
 module.exports =
 class NotationalVelocityView extends SelectListView
   initialize: (state) ->
     @initializedAt = new Date()
     super
-    @addClass('notational-velocity from-top overlay')
+    @addClass('nvatom from-top overlay')
-    @rootDirectory = atom.config.get('notational-velocity.directory')
+    @rootDirectory = atom.config.get('nvatom.directory')
-    if !fs.existsSync(@rootDirectory)
+    unless fs.existsSync(@rootDirectory)
       throw new Error("The given directory #{@rootDirectory} does not exist. "
         + "Set the note directory to the existing one from Settings.")
-    @prevFilterQuery = ''
+    @skipPopulateList = false
     @prevCursorPosition = 0
     @documentsLoaded = false
-    @docQuery = new DocQuery(@rootDirectory, {recursive: true})
+    @docQuery = new DocQuery(@rootDirectory, {recursive: true, extensions: atom.config.get('nvatom.extensions')})
     @docQuery.on "ready", () =>
       @documentsLoaded = true
       @setLoading()
@@ -28,28 +28,15 @@ class NotationalVelocityView extends SelectListView
       @populateList() if @documentsLoaded
     @docQuery.on "removed", (fileDetails) =>
       @populateList() if @documentsLoaded
+    unless atom.config.get('nvatom.enableLunrPipeline')
+      @docQuery.searchIndex.pipeline.reset()
 
-  selectItem: (filterQuery) ->
+  isCursorProceeded: ->
-    if filterQuery.length == 0
-      @prevCursorPosition = 0
-      return null
-
-    titleItem = @docQuery.search(filterQuery)[0]
-
-    # If title item is not null, auto-fill the search panel.
-    # But we don't want to fill it when deleting.
     editor = @filterEditorView.model
     currCursorPosition = editor.getCursorBufferPosition().column
-    if titleItem != undefined && @prevCursorPosition < currCursorPosition
+    isCursorProceeded = @prevCursorPosition < currCursorPosition
-      @prevFilterQuery = titleItem.title
-      editor.setText(filterQuery + titleItem.title.slice(filterQuery.length))
-      editor.selectLeft(titleItem.title.length - filterQuery.length)
     @prevCursorPosition = currCursorPosition
-
+    return isCursorProceeded
-    return titleItem
-
-  filter: (filterQuery) ->
-    return @docQuery.search(filterQuery)
 
   getFilterKey: ->
     'filetext'
@@ -75,10 +62,11 @@ class NotationalVelocityView extends SelectListView
         @div class: 'secondary-line', "#{content}"
 
   confirmSelection: ->
-    item           = @getSelectedItem()
+    item = @getSelectedItem()
-    filePath       = null
+    filePath = null
     sanitizedQuery = @getFilterQuery().replace(/\s+$/, '')
-    calculatedPath = path.join(@rootDirectory, sanitizedQuery + '.md')
+    extension = if atom.config.get('nvatom.extensions').length then atom.config.get('nvatom.extensions')[0] else '.md'
+    calculatedPath = path.join(@rootDirectory, sanitizedQuery + extension)
     if item?
       filePath = item.filePath
     else if fs.existsSync(calculatedPath)
@@ -115,36 +103,81 @@ class NotationalVelocityView extends SelectListView
   hide: ->
     @panel?.hide()
 
+  getFilterQuery: ->
+    editor = @filterEditorView.model
+    fullText = editor.getText()
+    selectedText = editor.getSelectedText()
+    return fullText.substring(0, fullText.length - selectedText.length)
+
+  filterByTitle: (filterQuery) ->
+    if (filterQuery is "") or (filterQuery is undefined)
+      return []
+    filterQuery = filterQuery.toLowerCase()
+    matchingNotes = []
+    filteredNotes = []
+    for note in @docQuery.documents
+      title = note.title.toLowerCase()
+      if title is filterQuery
+        matchingNotes.push(note)
+      else if filteredNotes.length < @maxItems and title.startsWith(filterQuery)
+        filteredNotes.push(note)
+    notes = matchingNotes.concat(filteredNotes)
+    if notes.length > @maxItems
+      notes = notes.slice(0, @maxItems)
+    return notes
+
+  filterByLunr: (filterQuery) ->
+    notes = []
+    if (filterQuery is "") or (filterQuery is undefined)
+      notes = @docQuery.documents
+    else
+      notes = @docQuery.search(filterQuery)
+    if notes.length > @maxItems
+      notes = notes.slice(0, @maxItems)
+    return notes
+
   populateList: ->
     filterQuery = @getFilterQuery()
-    filteredItems = null
+    notesByTitle = @filterByTitle(filterQuery)
-    if filterQuery == "" || filterQuery == undefined
+    notesByLunr = @filterByLunr(filterQuery)
-      filteredItems = @docQuery.documents
+    isCursorProceeded = @isCursorProceeded()
-    else
-      filteredItems = @filter(filterQuery)
-
-    selectedItem = @selectItem(filterQuery)
 
     @list.empty()
-    if filteredItems.length
+    if notesByTitle.length + notesByLunr.length == 0
-      @setError(null)
+      @setError(@getEmptyMessage(@docQuery.documents.length, 0))
+      return
 
-      for i in [0...Math.min(filteredItems.length, @maxItems)]
+    @setError(null)
-        item = filteredItems[i]
+    for note in notesByTitle
-        itemView = $(@viewForItem(item))
+      itemView = $(@viewForItem(note))
-        itemView.data('select-list-item', item)
+      itemView.data('select-list-item', note)
-        @list.append(itemView)
+      @list.append(itemView)
 
-      if selectedItem
+    if notesByTitle.length
-        n = filteredItems.indexOf(selectedItem) + 1
+      # autoselect
-        @selectItemView(@list.find("li:nth-child(#{n})"))
+      @selectItemView(@list.find("li:nth-child(1)"))
 
-    else
+      #autocomplete
-      @setError(@getEmptyMessage(@docQuery.documents.length, filteredItems.length))
+      note = notesByTitle[0]
+      if note.title.toLowerCase() is filterQuery.toLowerCase() or isCursorProceeded
+        @skipPopulateList = true
+        editor = @filterEditorView.model
+        editor.setText(filterQuery + note.title.slice(filterQuery.length))
+        editor.selectLeft(note.title.length - filterQuery.length)
+
+    if @list.length >= @maxItems
+      return
+
+    for note in notesByLunr
+      if @list.length >= @maxItems
+        break
+      if filterQuery?.length and note.title.toLowerCase().startsWith(filterQuery.toLowerCase())
+        continue
+      itemView = $(@viewForItem(note))
+      itemView.data('select-list-item', note)
+      @list.append(itemView)
 
   schedulePopulateList: ->
-    # We can skip it when we are just moving the position of the cursor.
+    unless @skipPopulateList
-    currFilterQuery = @getFilterQuery()
-    if @prevFilterQuery != currFilterQuery
       super
-    @prevFilterQuery = currFilterQuery
+    @skipPopulateList = false

lib/notational-velocity.coffee

@@ -8,7 +8,19 @@ module.exports =
       title: 'Note Directory'
       description: 'The directory to archive notes'
       type: 'string'
-      default: path.join(process.env.ATOM_HOME, 'notational-velocity-notes')
+      default: path.join(process.env.ATOM_HOME, 'nvatom-notes')
+    extensions:
+      title: 'Extensions'
+      description: 'The first extension will be used for newly created notes.'
+      type: 'array'
+      default: ['.md', '.txt']
+      items:
+        type: 'string'
+    enableLunrPipeline:
+      title: 'Enable Lunr Pipeline'
+      description: 'Lunr pipeline preprocesses query to make search faster. However, it will skip searching some of stop words such as "an" or "be".'
+      type: 'boolean'
+      default: true
 
   notationalVelocityView: null
 
@@ -21,7 +33,7 @@ module.exports =
 
     # Register command that toggles this view
     @subscriptions.add atom.commands.add 'atom-workspace',
-      'notational-velocity:toggle': => @createView(state).toggle()
+      'nvatom:toggle': => @createView(state).toggle()
 
     handleBeforeUnload = @autosaveAll.bind(this)
     window.addEventListener('beforeunload', handleBeforeUnload, true)
@@ -35,7 +47,7 @@ module.exports =
     window.addEventListener('blur', handleBlur, true)
     @subscriptions.add new Disposable -> window.removeEventListener('blur', handleBlur, true)
 
-    @subscriptions.add atom.workspace.onWillDestroyPaneItem ({item}) => @autosave(item)
+    @subscriptions.add atom.workspace.onWillDestroyPaneItem ({item}) => @autosave(item) unless @autodelete(item)
 
   deactivate: ->
     @subscriptions.dispose()
@@ -54,31 +66,63 @@ module.exports =
     return unless paneItem?.getURI?()?
     return unless paneItem?.isModified?()
     uri = paneItem.getURI()
-    return unless uri.indexOf(@rootDirectory) == 0
+    return unless uri.indexOf(@rootDirectory) is 0
-    return unless fs.isMarkdownExtension(path.extname(uri))
+    return unless path.extname(uri) in atom.config.get('nvatom.extensions')
     paneItem?.save?()
 
+  autodelete: (paneItem) ->
+    return false unless paneItem?.getURI?()?
+    uri = paneItem.getURI()
+    return false unless uri.indexOf(@rootDirectory) is 0
+    return false unless path.extname(uri) in atom.config.get('nvatom.extensions')
+    return false unless paneItem?.isEmpty()
+    fs.unlinkSync(uri)
+    noteName = uri.substring(@rootDirectory.length + 1)
+    atom.notifications.addInfo("Empty note #{noteName} is deleted.")
+    return true
+
   autosaveAll: ->
     @autosave(paneItem) for paneItem in atom.workspace.getPaneItems()
 
   ensureNoteDirectory: ->
-    noteDirectory = atom.config.get('notational-velocity.directory')
+    noteDirectory = atom.config.get('nvatom.directory')
     packagesDirectory = path.join(process.env.ATOM_HOME, 'packages')
-    defaultNoteDirectory = path.join(packagesDirectory, 'notational-velocity', 'notebook')
+    defaultNoteDirectory = path.join(packagesDirectory, 'nvatom', 'notebook')
 
     if noteDirectory.startsWith(packagesDirectory)
-      storageDirectory = path.join(packagesDirectory, 'storage')
+      throw new Error("Note directory #{noteDirectory} cannot reside within atom packages directory. Please change its value from package settings.")
-      throw new Error("""
-          The note directory (#{noteDirectory}) should NOT nest under #{packagesDirectory}.
-          It is likely that you updated the package to a newer version from v0.1.0.
-          It is likely that the note directory is overwritten.
-          Unfortunately, I couldn't find a way to recover overwritten notes.
-          You might recover partial notes from #{storageDirectory}.
-          I am extremely sorry.
-          - Seongjae Lee""")
 
-    if !fs.existsSync(noteDirectory)
+    # Initialize note directory.
-      fs.makeTreeSync(noteDirectory)
+    unless fs.existsSync(noteDirectory)
-      fs.copySync(defaultNoteDirectory, noteDirectory)
+      @tryMigrateFromNotationalVelocity()
+      noteDirectory = atom.config.get('nvatom.directory')
+      unless fs.existsSync(noteDirectory)
+        fs.makeTreeSync(noteDirectory)
+        fs.copySync(defaultNoteDirectory, noteDirectory)
 
     return fs.realpathSync(noteDirectory)
+
+  tryMigrateFromNotationalVelocity: ->
+    prevNoteDirectory = atom.config.get('notational-velocity.directory')
+    currNoteDirectory = atom.config.get('nvatom.directory')
+    packagesDirectory = path.join(process.env.ATOM_HOME, 'packages')
+    defaultNoteDirectory = path.join(packagesDirectory, 'nvatom', 'notebook')
+
+    # notational-velocity does not exist.
+    if prevNoteDirectory is undefined
+      return
+
+    atom.notifications.addInfo('Migrating from notational-velocity package...')
+
+    unless fs.existsSync(prevNoteDirectory)
+      atom.notifications.addError("notational-velocity.directory #{prevNoteDirectory} does not exists. Migration process is failed.")
+      return
+
+    if prevNoteDirectory.startsWith(packagesDirectory)
+      fs.makeTreeSync(currNoteDirectory)
+      fs.copySync(prevNoteDirectory, currNoteDirectory)
+    else
+      if path.join(process.env.ATOM_HOME, 'nvatom-notes') == currNoteDirectory
+        atom.config.set('nvatom.directory', prevNoteDirectory)
+
+    atom.notifications.addInfo('Finished migration.')

menus/notational-velocity.cson

@@ -3,11 +3,11 @@
   {
     'label': 'Packages'
     'submenu': [
-      'label': 'Notational Velocity'
+      'label': 'nvAtom'
       'submenu': [
         {
           'label': 'Toggle'
-          'command': 'notational-velocity:toggle'
+          'command': 'nvatom:toggle'
         }
       ]
     ]

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "notational-velocity",
+  "name": "nvatom",
   "main": "./lib/notational-velocity",
-  "version": "0.3.0",
+  "version": "0.8.1",
   "private": true,
   "contributors": [
     "Seongjae Lee <seongjae@gmail.com>",
@@ -10,17 +10,17 @@
   ],
   "description": "Notational Velocity for Atom",
   "activationCommands": {
-    "atom-workspace": "notational-velocity:toggle"
+    "atom-workspace": "nvatom:toggle"
   },
-  "repository": "https://github.com/seongjaelee/notational-velocity",
+  "repository": "https://github.com/seongjaelee/nvatom",
   "license": "MIT",
   "engines": {
     "atom": ">0.50.0"
   },
   "bugs": {
-    "url": "https://github.com/seongjaelee/notational-velocity/issues"
+    "url": "https://github.com/seongjaelee/nvatom/issues"
   },
-  "homepage": "https://github.com/seongjaelee/notational-velocity",
+  "homepage": "https://github.com/seongjaelee/nvatom",
   "dependencies": {
     "atom-space-pen-views": "^2.0.3",
     "chokidar": "^1.0.5",

spec/notational-velocity-spec.coffee

@@ -1,31 +1,31 @@
 path = require 'path'
 
-describe "NotationalVelocity", ->
+describe "nvAtom", ->
-  defaultDirectory = atom.config.get('notational-velocity.directory')
+  defaultDirectory = atom.config.get('nvatom.directory')
   activationPromise = null
   workspaceElement = null
 
   beforeEach ->
     workspaceElement = atom.views.getView(atom.workspace)
-    activationPromise = atom.packages.activatePackage('notational-velocity')
+    activationPromise = atom.packages.activatePackage('nvatom')
-    atom.config.set('notational-velocity.directory', 'testdata')
+    atom.config.set('nvatom.directory', 'testdata')
 
   afterEach ->
-    atom.config.set('notational-velocity.directory', defaultDirectory)
+    atom.config.set('nvatom.directory', defaultDirectory)
 
-  describe "when the notational-velocity:toggle event is triggered", ->
+  describe "when the nvatom:toggle event is triggered", ->
     it "attaches and then detaches the view", ->
-      expect(workspaceElement.querySelector('.notational-velocity')).not.toExist()
+      expect(workspaceElement.querySelector('.nvatom')).not.toExist()
 
       # This is an activation event, triggering it will cause the package to be activated.
-      atom.commands.dispatch workspaceElement, 'notational-velocity:toggle'
+      atom.commands.dispatch workspaceElement, 'nvatom:toggle'
 
       waitsForPromise ->
         activationPromise
 
       runs ->
-        expect(workspaceElement.querySelector('.notational-velocity')).toExist()
+        expect(workspaceElement.querySelector('.nvatom')).toExist()
-        atom.commands.dispatch workspaceElement, 'notational-velocity:toggle'
+        atom.commands.dispatch workspaceElement, 'nvatom:toggle'
 
     it "checks if we banned the default directory under packages directory", ->
       atom.notifications.clear()
@@ -34,11 +34,11 @@ describe "NotationalVelocity", ->
         atom.packages.activatePackage('notifications')
 
       runs ->
-        defaultNoteDirectory = path.join(process.env.ATOM_HOME, 'packages', 'notational-velocity', 'notebook')
+        noteDirectoryUnderPackageDirectory = path.join(process.env.ATOM_HOME, 'packages', 'nvatom', 'notebook')
-        atom.config.set('notational-velocity.directory', defaultNoteDirectory)
+        atom.config.set('nvatom.directory', noteDirectoryUnderPackageDirectory)
 
         # This is an activation event, triggering it will cause the package to be activated.
-        atom.commands.dispatch workspaceElement, 'notational-velocity:toggle'
+        atom.commands.dispatch workspaceElement, 'nvatom:toggle'
 
         waitsForPromise ->
           activationPromise

styles/notational-velocity.less

@@ -4,7 +4,7 @@
 // for a full listing of what's available.
 @import "ui-variables";
 
-.notational-velocity {
+.nvatom {
   li {
     text-overflow: ellipsis;
     overflow-x: hidden;