support snippets.addFiletypes command

Closes #121

Author: chemzqm

CHANGELOG.md

@@ -1,4 +1,9 @@
-# 3.2
+# 3.3.0
+
+- Add command `snippets.addFiletypes` for add additional snippets filetypes.
+- Support variable `b:coc_snippets_filetypes` on buffer create.
+
+# 3.2.0
 
 - Add execContext-option to enable context-execution for completion.
 - Fix filepath on vim built with win32unix.

Readme.md

@@ -173,6 +173,8 @@ some regex patterns can't be supported by javascript, including
 - Use `:CocCommand snippets.editSnippets` to edit user's ultisnips snippets of
   current document filetype.
 - Use `:CocCommand snippets.openOutput` to open output channel of snippets.
+- Use `:CocCommand snippets.addFiletypes` to add additional filetypes of current
+  buffer.
 
 ## Options
 
@@ -212,6 +214,10 @@ some regex patterns can't be supported by javascript, including
 
 ## F.A.Q
 
+**Q:** How to add snippet filetypes on buffer create?
+
+**A:** Use autocmd like: `autocmd BufRead *.md let b:coc_snippets_filetypes = ['tex']`
+
 **Q:** How to trigger snippets completion when type special characters?
 
 **A:** Use configuration like: `"snippets.triggerCharacters": ["'"]`.

package.json

@@ -39,6 +39,10 @@
       {
         "title": "Create MassCode snippet for current filetype.",
         "command": "snippets.editMassCodeSnippets"
+      },
+      {
+        "title": "Add additional snippet filetypes to current buffer.",
+        "command": "snippets.addFiletypes"
       }
     ],
     "configuration": {

src/baseProvider.ts

@@ -1,7 +1,7 @@
 import { Document, OutputChannel, Position } from 'coc.nvim'
 import minimatch from 'minimatch'
 import { Config, Snippet, SnippetEdit } from './types'
-import { distinct } from './util'
+import { distinct, getSnippetFiletype } from './util'
 
 export default abstract class BaseProvider {
   constructor(protected config: Config, protected channel: OutputChannel) {
@@ -17,6 +17,15 @@ export default abstract class BaseProvider {
     return true
   }
 
+  // load new snippets by filetype
+  public async loadSnippetsByFiletype(_filetype: string): Promise<void> {
+  }
+
+  protected getDocumentSnippets(doc: Document): Snippet[] {
+    let filetype = getSnippetFiletype(doc)
+    return this.getSnippets(filetype)
+  }
+
   protected isIgnored(filepath: string): boolean {
     let ignored = false
     let { excludes } = this.config
@@ -69,6 +78,11 @@ export default abstract class BaseProvider {
     this.message('Info ', msg, data)
   }
 
+
+  protected warn(msg: string, data?: any) {
+    this.message('Warn ', msg, data)
+  }
+
   protected error(msg: string, data?: any) {
     this.message('Error', msg, data)
   }

src/index.ts

@@ -1,4 +1,4 @@
-import { commands, Disposable, events, ExtensionContext, languages, listManager, Position, Range, snippetManager, TextEdit, Uri, window, workspace } from 'coc.nvim'
+import { commands, Disposable, events, Document, ExtensionContext, languages, listManager, Position, Range, snippetManager, Uri, window, workspace } from 'coc.nvim'
 import merge from 'merge'
 import path from 'path'
 import { registerLanguageProvider } from './languages'
@@ -7,25 +7,23 @@ import { MassCodeProvider } from './massCodeProvider'
 import { ProviderManager } from './provider'
 import { SnipmateProvider } from './snipmateProvider'
 import { TextmateProvider } from './textmateProvider'
-import { SnippetEditWithSource, UltiSnippetOption, UltiSnipsConfig } from './types'
+import { UltiSnipsConfig } from './types'
 import { getSnippetsDirectory, UltiSnippetsProvider } from './ultisnipsProvider'
-import { sameFile, waitDocument } from './util'
+import { addFiletypes, getAdditionalFiletype, getSnippetFiletype, insertSnippetEdit, sameFile, waitDocument } from './util'
 
 interface API {
   expandable: () => Promise<boolean>
 }
 
-
-async function insertSnippetEdit(edit: SnippetEditWithSource) {
-  let ultisnips = edit.source == 'ultisnips' || edit.source == 'snipmate'
-  let option: UltiSnippetOption
-  if (ultisnips) {
-    option = {
-      regex: edit.regex,
-      context: edit.context
-    }
+function checkBufferVariable(doc: Document): void {
+  let filetypes = doc.getVar('snippets_filetypes', undefined) as string[]
+  if (!Array.isArray(filetypes)) filetypes = undefined
+  if (!filetypes) {
+    let arr = getAdditionalFiletype(doc.bufnr)
+    if (arr) doc.buffer.setVar('coc_snippets_filetypes', arr, true)
+  } else if (filetypes.length > 0) {
+    addFiletypes(doc.bufnr, filetypes)
   }
-  await commands.executeCommand('editor.action.insertSnippet', TextEdit.replace(edit.range, edit.newText), option)
 }
 
 function enableSnippetsFiletype(subscriptions: Disposable[]) {
@@ -34,15 +32,17 @@ function enableSnippetsFiletype(subscriptions: Disposable[]) {
     if (doc.uri.endsWith('.snippets')) {
       doc.buffer.setOption('filetype', 'snippets', true)
     }
+    checkBufferVariable(doc)
   })
   workspace.onDidOpenTextDocument(async document => {
     if (document.uri.endsWith('.snippets')) {
       let doc = workspace.getDocument(document.uri)
-      if (!doc) return
-      let { buffer } = doc
-      await buffer.setOption('filetype', 'snippets')
+      let buf = nvim.createBuffer(doc.bufnr)
+      buf.setOption('filetype', 'snippets', true)
     }
+    checkBufferVariable(workspace.getDocument(document.bufnr))
   }, null, subscriptions)
+
   const rtp = workspace.env.runtimepath
   let paths = rtp.split(',')
   let idx = paths.findIndex(s => /^ultisnips$/i.test(path.basename(s)))
@@ -98,6 +98,20 @@ export async function activate(context: ExtensionContext): Promise<API> {
   const manager = new ProviderManager(channel, subscriptions)
 
   enableSnippetsFiletype(subscriptions)
+  subscriptions.push(commands.registerCommand('snippets.addFiletypes', async (...args: string[]) => {
+    if (args.length === 0) {
+      let res = await window.requestInput('Filetype to add', '', { position: 'center' })
+      if (res == '') return
+      args = res.split('.')
+    }
+    let filetypes = args.join('.').split('.')
+    let buf = await nvim.buffer
+    addFiletypes(buf.id, filetypes)
+    let curr = getAdditionalFiletype(buf.id)
+    buf.setVar('coc_snippets_filetypes', curr, true)
+    manager.loadSnippetsByFiletype(filetypes.join('.'))
+  }))
+
   let excludes = configuration.get<string[]>('excludePatterns', [])
   if (!Array.isArray(excludes)) excludes = []
   excludes = excludes.map(p => workspace.expand(p))
@@ -153,11 +167,8 @@ export async function activate(context: ExtensionContext): Promise<API> {
       trace: configuration.get<boolean>('massCode.trace', false),
       excludes
     }
-
     let provider = new MassCodeProvider(channel, config)
-
     manager.regist(provider, 'massCode')
-
     subscriptions.push(commands.registerCommand('snippets.editMassCodeSnippets', provider.createSnippet.bind(provider)))
   }
 
@@ -237,7 +248,8 @@ export async function activate(context: ExtensionContext): Promise<API> {
       window.showErrorMessage('Document not found')
       return
     }
-    let files = await manager.getSnippetFiles(doc.filetype)
+    let filetype = getSnippetFiletype(doc)
+    let files = await manager.getSnippetFiles(filetype)
     if (!files.length) {
       window.showWarningMessage('No related snippet file found')
       return

src/list/snippet.ts

@@ -5,12 +5,13 @@ Author Qiming Zhao <chemzqm@gmail> (https://github.com/chemzqm)
 import { BasicList, ListContext, ListItem, Location, Mru, Position, Range, Uri, workspace } from 'coc.nvim'
 import os from 'os'
 import { ProviderManager } from '../provider'
+import { getSnippetFiletype } from '../util'
 
 export default class SnippetsList extends BasicList {
   public readonly name = 'snippets'
   public readonly description = 'snippets list'
   constructor(nvim: any, private manager: ProviderManager) {
-    super(nvim)
+    super()
     this.addLocationActions()
   }
 
@@ -21,7 +22,8 @@ export default class SnippetsList extends BasicList {
     let buf = await window.buffer
     let doc = workspace.getDocument(buf.id)
     if (!doc) return []
-    let snippets = this.manager.getSnippets(doc.filetype)
+    let filetype = getSnippetFiletype(doc)
+    let snippets = this.manager.getSnippets(filetype)
     let res: ListItem[] = []
     for (let snip of snippets) {
       let pos: Position = Position.create(snip.lnum, 0)

src/massCodeProvider.ts

@@ -80,10 +80,9 @@ export class MassCodeProvider extends BaseProvider {
 
   public async getTriggerSnippets(document: Document, position: Position, autoTrigger?: boolean): Promise<SnippetEdit[]> {
     if (autoTrigger) return []
-
     const line = document.getline(position.line)
     if (line.length == 0) return []
-    const snippets = this.getSnippets(document.filetype).filter(s => {
+    const snippets = this.getDocumentSnippets(document).filter(s => {
       if (autoTrigger && !s.autoTrigger) return false
       let match = getMatched(s, line)
       if (match == null) return false

src/provider.ts

@@ -1,16 +1,16 @@
 import { CancellationToken, CompletionItem, CompletionItemKind, CompletionItemProvider, Disposable, Document, InsertTextFormat, OutputChannel, Position, Range, snippetManager, window, workspace } from 'coc.nvim'
 import path from 'path'
 import BaseProvider from './baseProvider'
-import { Snippet, SnippetEditWithSource, VimCompletionContext, TriggerKind } from './types'
-import { characterIndex, markdownBlock } from './util'
+import { Snippet, SnippetEditWithSource, TriggerKind, VimCompletionContext } from './types'
+import { characterIndex, getSnippetFiletype, markdownBlock } from './util'
 
 export class ProviderManager implements CompletionItemProvider {
   private providers: Map<string, BaseProvider> = new Map()
   constructor(
     private channel: OutputChannel,
-    subscriptions: Disposable[]
+    private subscriptions: Disposable[]
   ) {
-    subscriptions.push(Disposable.create(() => {
+    this.subscriptions.push(Disposable.create(() => {
       this.providers.clear()
     }))
   }
@@ -28,12 +28,31 @@ export class ProviderManager implements CompletionItemProvider {
 
   public async init(): Promise<void> {
     let providers = Array.from(this.providers.values())
-    await Promise.all(providers.map(provider => {
-      return provider.init()
-    })).catch(e => {
+    await Promise.allSettled(providers.map(provider => provider.init().catch(e => {
       workspace.nvim.echoError(e)
-      this.appendError('init', e)
+      this.appendError('Error on provider init:', e)
+    })))
+
+    let promises: Promise<void>[] = []
+    workspace.documents.forEach(doc => {
+      let filetype = getSnippetFiletype(doc)
+      promises.push(this.loadSnippetsByFiletype(filetype))
     })
+    workspace.onDidOpenTextDocument(async doc => {
+      let filetype = getSnippetFiletype({ bufnr: doc.bufnr, filetype: doc.languageId })
+      await this.loadSnippetsByFiletype(filetype)
+    }, null, this.subscriptions)
+    await Promise.allSettled(promises)
+  }
+
+  public async loadSnippetsByFiletype(filetype: string): Promise<void> {
+    let promises: Promise<void>[] = []
+    for (let [name, provider] of this.providers.entries()) {
+      promises.push(provider.loadSnippetsByFiletype(filetype).catch(e => {
+        this.appendError(`Error on load "${name}" snippets:`, e)
+      }))
+    }
+    await Promise.allSettled(promises)
   }
 
   public getSnippets(filetype: string): Snippet[] {
@@ -117,7 +136,8 @@ export class ProviderManager implements CompletionItemProvider {
     let doc = workspace.getDocument(document.uri)
     if (!doc) return []
     let bufnr = doc.bufnr
-    let snippets = this.getSnippets(doc.filetype)
+    let filetype = getSnippetFiletype(doc)
+    let snippets = this.getSnippets(filetype)
     let currline = doc.getline(position.line, true)
     let { input, col, line, colnr } = context.option
     let character = characterIndex(line, col)

src/snipmateProvider.ts

@@ -27,6 +27,7 @@ function convertBody(body: string): string {
 export class SnipmateProvider extends BaseProvider {
   private fileItems: FileItem[] = []
   private snippetFiles: SnipmateFile[] = []
+  private loadedLanguageIds: Set<string> = new Set()
   constructor(
     channel: OutputChannel,
     protected config: SnipmateConfig,
@@ -50,7 +51,7 @@ export class SnipmateProvider extends BaseProvider {
   public async init(): Promise<void> {
     let { nvim } = workspace
     let author = await nvim.getVar('snips_author')
-    if (!author) await nvim.setVar('snips_author', this.config.author)
+    if (!author) nvim.setVar('snips_author', this.config.author, true)
     this.fileItems = await this.loadAllSnippetFiles()
     workspace.onDidRuntimePathChange(async e => {
       for (let rtp of e) {
@@ -65,18 +66,14 @@ export class SnipmateProvider extends BaseProvider {
         }
       }
     }, null, this.subscriptions)
-    for (let filetype of workspace.filetypes) {
-      await this.loadByFiletype(filetype)
-    }
-    workspace.onDidOpenTextDocument(async e => {
-      let doc = workspace.getDocument(e.bufnr)
-      await this.loadByFiletype(doc.filetype)
-    }, null, this.subscriptions)
   }
 
-  private async loadByFiletype(filetype: string): Promise<void> {
+  public async loadSnippetsByFiletype(filetype: string): Promise<void> {
     let filetypes = filetype ? this.getFiletypes(filetype) : []
     filetypes.push('_')
+    filetypes = filetypes.filter(filetype => !this.loadedLanguageIds.has(filetype))
+    if (filetypes.length == 0) return
+    filetypes.forEach(filetype => this.loadedLanguageIds.add(filetype))
     for (let item of this.fileItems) {
       if (!filetypes.includes(item.filetype)) continue
       await this.loadSnippetsFromFile(item.filetype, item.filepath)
@@ -90,18 +87,20 @@ export class SnipmateProvider extends BaseProvider {
     if (idx !== -1) this.fileItems.splice(idx, 1)
     if (this.isIgnored(filepath)) return
     let res = await this.parseSnippetsFile(filetype, filepath)
-    this.snippetFiles.push({ filepath, filetype, snippets: res.snippets })
-    this.info(`Loaded ${res.snippets.length} ${filetype} snipmate snippets from: ${filepath}`)
-    if (res.extends.length) {
-      let fts = res.extends
-      let curr = this.config.extends[filetype] || []
-      for (let ft of fts) {
-        await this.loadByFiletype(ft)
-        if (!curr.includes(ft)) {
-          curr.push(ft)
+    if (this.snippetFiles.findIndex(o => sameFile(o.filepath, filepath)) == -1) {
+      this.snippetFiles.push({ filepath, filetype, snippets: res.snippets })
+      this.info(`Loaded ${res.snippets.length} ${filetype} snipmate snippets from: ${filepath}`)
+      if (res.extends.length) {
+        let fts = res.extends
+        let curr = this.config.extends[filetype] || []
+        for (let ft of fts) {
+          await this.loadSnippetsByFiletype(ft)
+          if (!curr.includes(ft)) {
+            curr.push(ft)
+          }
         }
+        this.config.extends[filetype] = curr
       }
-      this.config.extends[filetype] = curr
     }
   }
 
@@ -183,7 +182,7 @@ export class SnipmateProvider extends BaseProvider {
 
   public async getTriggerSnippets(document: Document, position: Position, autoTrigger: boolean): Promise<SnippetEdit[]> {
     if (autoTrigger) return []
-    let snippets = this.getSnippets(document.filetype)
+    let snippets = this.getDocumentSnippets(document)
     let line = document.getline(position.line)
     line = line.slice(0, position.character)
     if (!line) return []