Prepare 0.5.0 release

If we have a note "Atom", and if the user types "a" or "at", then lunr pipeline ignores searching them because they are stop words. However, turning off this feature might not be a good idea when we have tons of body texts. So we turn it on as a default, but provide a way to turn it off as an option.

CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.0
+- Add `useLunrPipeline` feature
+- 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

lib/notational-velocity-view.coffee

@@ -2,7 +2,7 @@ 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
@@ -14,7 +14,7 @@ class NotationalVelocityView extends SelectListView
     if !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})
@@ -28,27 +28,41 @@ class NotationalVelocityView extends SelectListView
       @populateList() if @documentsLoaded
     @docQuery.on "removed", (fileDetails) =>
       @populateList() if @documentsLoaded
+    if !atom.config.get('nvatom.enableLunrPipeline')
+      @docQuery.searchIndex.pipeline.reset()
 
-  selectItem: (filterQuery) ->
-    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.
+  isCursorProceeded: ->
     editor = @filterEditorView.model
     currCursorPosition = editor.getCursorBufferPosition().column
-    if titleItem != undefined && @prevCursorPosition < currCursorPosition
-      @prevFilterQuery = titleItem.title
-      editor.setText(filterQuery + titleItem.title.slice(filterQuery.length))
-      editor.selectLeft(titleItem.title.length - filterQuery.length)
+    isCursorProceeded = @prevCursorPosition < currCursorPosition
     @prevCursorPosition = currCursorPosition
+    return isCursorProceeded
 
-    return titleItem
+  selectItem: (filteredItems, filterQuery) ->
+    isCursorProceeded = @isCursorProceeded()
+
+    for item in filteredItems
+      if item.title.match(///^#{filterQuery}$///i) != null
+        # autoselect
+        n = filteredItems.indexOf(item) + 1
+        @selectItemView(@list.find("li:nth-child(#{n})"))
+        return
+
+    for item in filteredItems
+      if item.title.match(///^#{filterQuery}///i) != null && isCursorProceeded
+        # autocomplete
+        @skipPopulateList = true
+        editor = @filterEditorView.model
+        editor.setText(filterQuery + item.title.slice(filterQuery.length))
+        editor.selectLeft(item.title.length - filterQuery.length)
+
+        # autoselect
+        n = filteredItems.indexOf(item) + 1
+        @selectItemView(@list.find("li:nth-child(#{n})"))
 
   filter: (filterQuery) ->
+    if filterQuery == "" || filterQuery == undefined
+      return @docQuery.documents
     return @docQuery.search(filterQuery)
 
   getFilterKey: ->
@@ -75,8 +89,8 @@ class NotationalVelocityView extends SelectListView
         @div class: 'secondary-line', "#{content}"
 
   confirmSelection: ->
-    item           = @getSelectedItem()
-    filePath       = null
+    item = @getSelectedItem()
+    filePath = null
     sanitizedQuery = @getFilterQuery().replace(/\s+$/, '')
     calculatedPath = path.join(@rootDirectory, sanitizedQuery + '.md')
     if item?
@@ -115,15 +129,15 @@ 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)
+
   populateList: ->
     filterQuery = @getFilterQuery()
-    filteredItems = null
-    if filterQuery == "" || filterQuery == undefined
-      filteredItems = @docQuery.documents
-    else
-      filteredItems = @filter(filterQuery)
-
-    selectedItem = @selectItem(filterQuery)
+    filteredItems = @filter(filterQuery)
 
     @list.empty()
     if filteredItems.length
@@ -135,16 +149,12 @@ class NotationalVelocityView extends SelectListView
         itemView.data('select-list-item', item)
         @list.append(itemView)
 
-      if selectedItem
-        n = filteredItems.indexOf(selectedItem) + 1
-        @selectItemView(@list.find("li:nth-child(#{n})"))
+      @selectItem(filteredItems, filterQuery)
 
     else
       @setError(@getEmptyMessage(@docQuery.documents.length, filteredItems.length))
 
   schedulePopulateList: ->
-    # We can skip it when we are just moving the position of the cursor.
-    currFilterQuery = @getFilterQuery()
-    if @prevFilterQuery != currFilterQuery
+    if !@skipPopulateList
       super
-    @prevFilterQuery = currFilterQuery
+    @skipPopulateList = false

lib/notational-velocity.coffee

@@ -9,6 +9,11 @@ module.exports =
       description: 'The directory to archive notes'
       type: 'string'
       default: path.join(process.env.ATOM_HOME, 'nvatom-notes')
+    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
 
@@ -95,9 +100,6 @@ module.exports =
       atom.notifications.addError('notational-velocity.directory #{prevNoteDirectory} does not exists. Migration process is failed.')
       return
 
-    alert(prevNoteDirectory)
-    alert(currNoteDirectory)
-
     if prevNoteDirectory.startsWith(packagesDirectory)
       fs.makeTreeSync(currNoteDirectory)
       fs.copySync(prevNoteDirectory, currNoteDirectory)

package.json

@@ -1,7 +1,7 @@
 {
   "name": "nvatom",
   "main": "./lib/notational-velocity",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "private": true,
   "contributors": [
     "Seongjae Lee <seongjae@gmail.com>",