Text expansion support #1848

ZeroX-DG · 2018-04-20T16:34:15Z

This is a new feature and has been requested here:
#1830, #576

Basically this feature allow you to create snippet (like code snippet) and use it to boost up your typing speed.

Enough with words! here is the demo:

To use this feature, you will first need to type in the prefix of the snippet which is just a word to trigger the snippet content (in the example above it's ipsum) then press tab to expand the snippet

You can also define your own snippet at the snippet tab in setting

When you edit the snippet name or prefix or content, the snippet will automatically update so don't worry if you forget to hit the save button although there is no save button 😄

You can set more than just one prefix and separate them using commas like this:

You can delete the snippet by right click on the snippet and click delete

You can also create a note template using this feature. By adding the special string :{} you can set the cursor position in your template once it's generated.

The only problem is that I haven't add new details to the language file, will do it if I have time 😃

…pet change

Rokt33r · 2018-04-21T08:12:43Z

@ZeroX-DG Wow, it looks nice!!

ehhc · 2018-04-21T18:02:31Z

browser/components/CodeEditor.js

    const { rulers, enableRulers } = this.props
+    const emptyChars = /\t|\s|\r|\n/
+    if (!fs.existsSync(consts.SNIPPET_FILE)) {
+      const defaultSnippets = [


That are quite a lot 'default' snippets not everybody needs. Nevertheless they will be inserted by default... not sure if that's a good idea

You're right 😄 I think leaving just 1 default snippet is enough, will fix it soon

ehhc · 2018-04-21T18:04:28Z

browser/lib/consts.js

+function getAppData () {
+  return process.env.APPDATA || (process.platform === 'darwin'
+  ? process.env.HOME + 'Library/Preferences'
+  : require('os').homedir() + '/.config')


path.sep woulde be way better than a hardcoded '/' since that isn't platformindependent!

First time I heard of path.sep new stuff to learn! thanks!

Using path.sep is not the best. Please use path.join() to concatenating path.

ehhc · 2018-04-21T18:05:39Z

browser/main/lib/dataApi/createSnippet.js

+import crypto from 'crypto'
+import consts from 'browser/lib/consts'
+
+function createSnippet (snippets) {


why didn't you write any tests?!
Tests are good!

oh I was busy at that time, I'll add some tests for it 😄

…t snippet

refactored some code fixed snippet content empty on changed from list fixed snippet name not updating on list when changed

…d old snippet still display when deleted

…Boostnote into text-expansion-support

ZeroX-DG · 2018-04-27T04:37:47Z

@Rokt33r It's basically done, please tell me if you need anything

Rokt33r

I think we have to generate snippets.json file if it does not exist.

Error: ENOENT: no such file or directory, open '/Users/~/.config/Boostnote/snippets.json'

ZeroX-DG · 2018-05-02T02:09:39Z

That's weird, I have make sure that the snippets.json will be created if it's not exist everytime Boostnote is executed. Look like the path in your error is wrong, I have adjusted it, maybe it's the cause to this problem

ChasManRors · 2018-05-02T02:55:50Z

I can't wait until this lands in the main distribution.

ZeroX-DG · 2018-05-02T03:12:24Z

@ChasManRors Just a few more changes and it will be ready!
@Rokt33r I've disabled the code highlighting of codemirror in the SnippetEditor. It would be great if there is a language support feature for SnippetEditor but I'm having trouble with my school project, so right now, let just allow snippets to be in plan text only :'(

sosukesuzuki

Please confirm my reviews!

sosukesuzuki · 2018-05-21T03:08:07Z

browser/components/CodeEditor.js

+    for (let i = 0; i < snippets.length; i++) {
+      if (snippets[i].prefix.indexOf(wordBeforeCursor.text) !== -1) {
+        if (snippets[i].content.indexOf(templateCursorString) !== -1) {
+          let snippetLines = snippets[i].content.split('\n')


please use const instead of let.

sosukesuzuki · 2018-05-21T03:08:31Z

browser/components/CodeEditor.js

+          let cursorLineNumber = 0
+          let cursorLinePosition = 0
+          for (let j = 0; j < snippetLines.length; j++) {
+            let cursorIndex = snippetLines[j].indexOf(templateCursorString)


please use const instead of let.

sosukesuzuki · 2018-05-21T03:18:18Z

browser/lib/consts.js

 const fs = require('sander')
 const { remote } = require('electron')
 const { app } = remote
+const os = require('os')


Please remove os, because it is never used.

sosukesuzuki · 2018-05-21T03:22:39Z

browser/main/modals/PreferencesModal/SnippetTab.js

+    }).catch(err => { throw err })
+  }
+
+  renderSnippetList () {


I think that it is better than now, to extract renderSnippetList as stateless functional component.

sosukesuzuki · 2018-05-21T03:24:19Z

browser/main/modals/PreferencesModal/SnippetTab.js

+  renderSnippetList () {
+    const { snippets } = this.state
+    return (
+      <ul id='snippets' style={{height: 'calc(100% - 8px)', overflow: 'scroll', background: '#f5f5f5'}}>


If it is possible, I want you to write style to browser/main/modals/PreferencesModal/SnippetTab.styl.

sosukesuzuki · 2018-05-21T03:49:45Z

browser/main/modals/PreferencesModal/SnippetEditor.js

+      <div styleName='SnippetEditor' ref='root' tabIndex='-1' style={{
+        fontFamily: fontFamily.join(', '),
+        fontSize: fontSize,
+        position: 'absolute',


please write style of position, width, height to other stylus file.

sosukesuzuki · 2018-05-21T03:57:47Z

browser/main/modals/PreferencesModal/SnippetTab.js

+import React from 'react'
+import CSSModules from 'browser/lib/CSSModules'
+import styles from './SnippetTab.styl'
+import fs from 'fs'


Please remove fs, because fs is never used.

sosukesuzuki · 2018-05-21T03:58:29Z

browser/main/modals/PreferencesModal/SnippetTab.js

+import SnippetEditor from './SnippetEditor'
+import i18n from 'browser/lib/i18n'
+import dataApi from 'browser/main/lib/dataApi'
+import consts from 'browser/lib/consts'


Please remove consts. because consts is never used.

sosukesuzuki · 2018-05-21T04:01:11Z

browser/main/modals/PreferencesModal/SnippetEditor.js

+import CodeMirror from 'codemirror'
+import React from 'react'
+import _ from 'lodash'
+import fs from 'fs'


Please remove fs because fs is never used.

sosukesuzuki · 2018-05-21T04:01:42Z

browser/main/modals/PreferencesModal/SnippetEditor.js

+import React from 'react'
+import _ from 'lodash'
+import fs from 'fs'
+import consts from 'browser/lib/consts'


Please remove consts because consts is never used.

sosukesuzuki · 2018-05-21T04:19:16Z

browser/components/CodeEditor.js

+import crypto from 'crypto'
+import consts from 'browser/lib/consts'
+import fs from 'fs'
+const { ipcRenderer, remote } = require('electron')


remote is never used, please remove it.

sosukesuzuki · 2018-05-21T04:24:40Z

Snippets tab you implemented is styled for theme of White and Default.
I want you to style for other themes.

…etList into component

ZeroX-DG · 2018-05-21T11:43:17Z

@sosukesuzuki I have changed my code, please take a look 😃

sosukesuzuki

Thanks for your fix!
Please fix it a bit. Confirm my reviews:pray:
And, please confirm this comment.

sosukesuzuki · 2018-05-25T07:43:24Z

browser/main/modals/PreferencesModal/SnippetEditor.js

+import React from 'react'
+import _ from 'lodash'
+import styles from './SnippetTab.styl'
+import CSSModules from 'react-css-modules'


please usebrowser/lib/CSSModules instead of react-css-modules.

sosukesuzuki · 2018-05-25T07:46:51Z

browser/main/modals/PreferencesModal/SnippetTab.js

-                  this.handleSnippetNameOrPrefixChange()
-                }}
+                value={currentSnippet ? currentSnippet.name : ''}
+                onChange={e => { this.onSnippetNameOrPrefixChanged(e, 'name') }}


{ } is unnecessary. please write like below:

onChange={e => this.onSnippetNameOrPrefixChanged(e, 'name')}

sosukesuzuki · 2018-05-25T07:48:14Z

browser/main/modals/PreferencesModal/SnippetTab.js

-                  this.handleSnippetNameOrPrefixChange()
-                }}
+                value={currentSnippet ? currentSnippet.prefix : ''}
+                onChange={e => { this.onSnippetNameOrPrefixChanged(e, 'prefix') }}


{ } is unnecessary. please write like below:

onChange={e => this.onSnippetNameOrPrefixChanged(e, 'prefix') }

sosukesuzuki · 2018-05-25T07:54:51Z

@ZeroX-DG please fix a conflict!

ZeroX-DG · 2018-05-25T11:50:48Z

@sosukesuzuki , I have confirmed you requests.

sosukesuzuki · 2018-05-28T01:15:40Z

@ZeroX-DG
please apply style for monokai theme.
please use variables written in browser/styles/index.styl to apply styles for color themes.

ZeroX-DG · 2018-05-28T08:24:42Z

@sosukesuzuki , Sorry for missing a theme, I've added the monokai theme & switched all colors to the color variables in the index.styl file

ZeroX-DG added 8 commits April 18, 2018 19:31

added text expansion support

2e9b478

added snippet config in setting

50d2f90

improved style for snippet list

d3b3e45

added delete snippet, update snippet, create snippet and save on snip…

ff2e399

…pet change

fixed eslint error

8925f7c

Fixed appdata path error

358458a

fix eslint error

ddcd722

fixed get appdata path error

a7b85b1

Rokt33r self-requested a review April 21, 2018 08:12

ehhc suggested changes Apr 21, 2018

View reviewed changes

clean up some redundant code, changed to path.sep, remove some defaul…

a7d0a4b

…t snippet

kazup01 added the awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. label Apr 22, 2018

Rokt33r and others added 7 commits April 26, 2018 16:39

Merge branch 'master' into text-expansion-support

5e7bdf7

added fetch snippet

e88694b

refactored some code fixed snippet content empty on changed from list fixed snippet name not updating on list when changed

fixed eslint error

78957cf

refactored snippet dataApi for easy testing and added some test. Fixe…

291d766

…d old snippet still display when deleted

Merge branch 'text-expansion-support' of https://github.com/ZeroX-DG/…

a2592e4

…Boostnote into text-expansion-support

fixed eslint error

2e09501

removed path.sep and use path.join to concatenate path

8c43f3d

added import fs module that was removed by accident

106f5a5

Rokt33r added awaiting review ❇️ Pull request is awaiting a review. and removed awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. labels Apr 28, 2018

Rokt33r requested review from sosukesuzuki and removed request for Rokt33r April 28, 2018 14:55

Rokt33r requested changes May 1, 2018

View reviewed changes

Rokt33r added awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. and removed awaiting review ❇️ Pull request is awaiting a review. labels May 1, 2018

removed redundant function to get appdata

2bc0bce

disabled code highlight in snippet editor

f5a9d39

added note template feature

ce594b0

IssueHuntBot mentioned this pull request May 16, 2018

Note Templates? #576

Closed

sosukesuzuki requested changes May 21, 2018

View reviewed changes

sosukesuzuki reviewed May 21, 2018

View reviewed changes

ZeroX-DG added 2 commits May 21, 2018 18:32

cleaned up redundant variables, fixed eslint fix command, split snipp…

2b2f175

…etList into component

applied style for snippetEditor

713615e

sosukesuzuki requested changes May 25, 2018

View reviewed changes

ZeroX-DG added 2 commits May 25, 2018 18:39

changed cssmodule & applied style for solarized dark theme

680c2a2

resolved conflict

c2c5081

ZeroX-DG added 2 commits May 28, 2018 15:15

changed all colors to variables & styled for monokai theme

10500c3

fixed yarn.lock conflict

172ea82

sosukesuzuki approved these changes Jun 1, 2018

View reviewed changes

Rokt33r approved these changes Jun 1, 2018

View reviewed changes

Rokt33r merged commit e4d4041 into BoostIO:master Jun 1, 2018

sosukesuzuki added next release (v0.11.6) and removed awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. labels Jun 14, 2018

ZeroX-DG deleted the text-expansion-support branch July 26, 2019 02:02

ZeroX-DG mentioned this pull request Oct 29, 2020

How to use the Preferences/Snippet Manager? #3651

Open

Uh oh!

Text expansion support #1848

Text expansion support #1848

Uh oh!

Conversation

ZeroX-DG commented Apr 20, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Rokt33r commented Apr 21, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ZeroX-DG commented Apr 27, 2018

Uh oh!

Rokt33r left a comment

Choose a reason for hiding this comment

Uh oh!

ZeroX-DG commented May 2, 2018

Uh oh!

ChasManRors commented May 2, 2018

Uh oh!

ZeroX-DG commented May 2, 2018

Uh oh!

sosukesuzuki left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sosukesuzuki commented May 21, 2018

Uh oh!

ZeroX-DG commented May 21, 2018

Uh oh!

sosukesuzuki left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sosukesuzuki commented May 25, 2018

Uh oh!

ZeroX-DG commented May 25, 2018

Uh oh!

sosukesuzuki commented May 28, 2018

Uh oh!

ZeroX-DG commented May 28, 2018

ZeroX-DG commented Apr 20, 2018 •

edited

Loading