fix: make luarocks test work + cleanup

Author: xiaoshihou514

.busted

@@ -0,0 +1,13 @@
+return {
+  _all = {
+    coverage = false,
+    lpath = "lua/?.lua;lua/?/init.lua",
+    lua = "nlua",
+  },
+  default = {
+    verbose = true,
+  },
+  tests = {
+    verbose = true,
+  },
+}

.editorconfig

@@ -0,0 +1,3 @@
+[*.lua]
+indent_style = space
+indent_size = 2

README.md

@@ -1,41 +1,30 @@
 # Phoenix
 
-A blazing-fast asynchronous in-process server providing word and path completion.
+A blazing-fast in-process server providing word and path completion.
 
-## How fast it is ?
+## Demo
 
-It enables smooth word completion in nearly 10,000 lines of text and provides
-instant completion in projects with thousands of files.
+Smooth word completion from nearly 10,000 lines of text and instant path completion in projects with thousands of files.
 
 ![Image](https://github.com/user-attachments/assets/ec81041b-7f37-4613-ad91-419a76ee2eeb)
 
-([auto completion from my neovim config](https://github.com/glepnir/nvim/blob/main/lua/internal/completion.lua))
+Words are stored in a [Trie](https://wikipedia.org/wiki/Trie), additionally, they are weighted in frequency and last time used. Low frequency words are cleaned up periodically to speed the process up even more.
 
-In the Phoenix framework, a Trie tree is used to store words, ensuring that the
-completion results can be obtained in O(L) time (L is the length of the word).
-Additionally, the weight of each word is calculated based on its usage frequency
-and last usage time, and low-frequency words are asynchronously cleaned up periodically
-to ensure that the desired results can be obtained quickly with each input.
-
-For path completion, Phoenix uses an LRU (Least Recently Used) cache to handle
-the results, and the completion results can be obtained in O(1) time. Meanwhile,
-the cache is cleaned up based on a set time period to ensure that the directory
-status is kept synchronized.
+Path completion is done in a similar fashion.
 
 ## Usage
 
 **Require neovim nightly**
 
-```lua
-require('phoenix').setup()
-```
+You have to setup your completion to use the fake `phoenix` language server. ([Example using vim.lsp.completion](https://github.com/glepnir/nvim/blob/main/lua/internal/completion.lua)).
 
-default config and custom in `vim.g.phoenix` option table.
+Options are configured via `vim.g.phoenix`.
 
-```
+```lua
 {
   filetypes = { '*' },
-  -- Dictionary related settings
+
+  -- Internal cache settings
   dict = {
     -- Maximum number of words to store in the dictionary
     -- Higher values consume more memory but provide better completions
@@ -44,6 +33,7 @@ default config and custom in `vim.g.phoenix` option table.
     -- Minimum word length to be considered for completion
     -- Shorter words may create noise in completions
     min_word_length = 2,
+
     -- Time factor weight for sorting completions (0-1)
     -- Higher values favor recently used items more strongly
     recency_weight = 0.3,
@@ -56,9 +46,11 @@ default config and custom in `vim.g.phoenix` option table.
   -- Performance related settings
   scan = {
     cache_ttl = 5000,
+
     -- Number of items to process in each batch
     -- Higher values improve speed but may cause stuttering
     batch_size = 1000,
+
     -- Ignored the file or dictionary which matched the pattern
     ignore_patterns = {},
 

doc/phoenix.txt

@@ -597,17 +597,7 @@ function server.create()
   end
 end
 
-local function setup()
-  vim.api.nvim_create_autocmd('FileType', {
-    pattern = cfg.filetypes,
-    callback = function()
-      vim.lsp.start({
-        name = 'phoenix',
-        cmd = server.create(),
-        root_dir = vim.uv.cwd(),
-      })
-    end,
-  })
-end
-
-return { setup = setup }
+return {
+  server = server,
+  config = cfg,
+}

lua/phoenix/init.lua

@@ -0,0 +1,16 @@
+rockspec_format = '3.0'
+package = 'phoenix.nvim'
+version = 'scm-1'
+
+test_dependencies = {
+  'lua >= 5.1',
+  'nlua',
+}
+
+source = {
+  url = 'git://github.com/nvimdev/' .. package,
+}
+
+build = {
+  type = 'builtin',
+}

phoenix.nvim-scm-1.rockspec

@@ -0,0 +1,13 @@
+local phoenix = require('phoenix')
+
+vim.api.nvim_create_autocmd('FileType', {
+  pattern = phoenix.config.filetypes,
+  callback = function()
+    vim.lsp.start({
+      name = 'phoenix',
+      cmd = phoenix.server.create(),
+      ---@diagnostic disable-next-line: undefined-field
+      root_dir = vim.uv.cwd(),
+    })
+  end,
+})

plugin/phoenix.lua

@@ -0,0 +1,7 @@
+local same = assert.are.same
+
+describe('example test', function()
+  it('works', function()
+    same(1 + 1, 2)
+  end)
+end)