Merge branch 'tech/typescript'

README.md

@@ -1,6 +1,6 @@
 # Forem.nvim
 
-<p align="center">This plugin integrates Neovim with Forem platforms (for example, dev.to)</p>
+<p align="center">This plugin integrates Neovim with Forem platforms like [dev.to](https://dev.to)</p>
 
 https://user-images.githubusercontent.com/12272702/175755820-a2b93f4b-fd5c-416b-8b9e-d981335ef75c.mov
 
@@ -38,20 +38,37 @@ https://user-images.githubusercontent.com/12272702/175755866-62be0b6c-31b2-4f45-
 
 ## Installation
 
-Using [packer](https://github.com/wbthomason/packer.nvim):
+### Using [lazy](https://github.com/folke/lazy.nvim):
+
+```lua
+{
+    "Massolari/forem.nvim",
+    dependencies = {
+        "nvim-lua/plenary.nvim",
+        "nvim-telescope/telescope.nvim",
+        "rcarriga/nvim-notify"
+    }
+}
+```
+
+### Using [packer](https://github.com/wbthomason/packer.nvim):
 
 ```lua
 use {
     "Massolari/forem.nvim",
     requires = {
         "nvim-lua/plenary.nvim",
-        "nvim-telescope/telescope.nvim"
+        "nvim-telescope/telescope.nvim",
+        "rcarriga/nvim-notify"
     }
 }
 ```
 
 ## Setup
 
+> [!NOTE]
+> These instructions are for the dev.to platform.
+
 First, you need to generate an API key for the DEV platform.
 
 For dev.to, you can do it in [the end of the extension's page](https://dev.to/settings/extensions)
@@ -62,17 +79,15 @@ With your API key, you just need to set it into the `FOREM_API_KEY` environment
 
 The plugin has the following commands and functions available in `forem-nvim` module:
 
-| function | command | description |
-| --- | --- | --- |
-| `feed()` | `:Forem feed` | Shows fresh articles from the feed, then you can read it in Neovim or open it in the browser |
-| `my_articles()` | `:Forem my_articles` | Shows all your articles, then you can pick one to edit |
-| `new_article()` | `:Forem new_article` | Asks for a title, then creates an article with the given title and open it to edit |
-| `open_by_url()` | `:Forem open_by_url` | Asks for an URL, then opens the article |
+| function        | command              | description                                                                                  |
+| --------------- | -------------------- | -------------------------------------------------------------------------------------------- |
+| `feed()`        | `:Forem feed`        | Shows fresh articles from the feed, then you can read it in Neovim or open it in the browser |
+| `my_articles()` | `:Forem my_articles` | Shows all your articles, then you can pick one to edit                                       |
+| `new_article()` | `:Forem new_article` | Asks for a title, then creates an article with the given title and open it to edit           |
+| `open_by_url()` | `:Forem open_by_url` | Asks for a URL, then opens the article                                                       |
 
 After you save the buffer it'll automatically be saved in the cloud.
 
-**Note: these functions will only be available after the `setup` call**
-
 ## Contributing
 
 Please, don't hesitate in contributing by creating issues and opening pull requests.

package.json

@@ -8,7 +8,7 @@
   },
   "scripts": {
     "build": "make",
-    "dev": "tstl -p ./src/tsconfig.json --watch"
+    "dev": "tstl --watch"
   },
   "keywords": [],
   "author": "",

tests/minimal_init.lua

@@ -1,20 +1,20 @@
 --[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
+append = function(option, value)
+    option.append(option, value)
+end
 loadModule = function(module, source, directory)
     local moduleDir = directory or "/tmp/" .. module
     local directoryExists = vim.fn.isdirectory(moduleDir)
     if directoryExists == 0 then
         vim.fn.system({"git", "clone", source, moduleDir})
     end
+    append(vim.opt.rtp, moduleDir)
     return moduleDir
 end
 plenaryDir = os.getenv("PLENARY_DIR") or "/tmp/plenary.nvim"
 loadModule("plenary.nvim", "https://github.com/nvim-lua/plenary.nvim", plenaryDir)
 telescopeDir = loadModule("telescope.nvim", "https://github.com/nvim-telescope/telescope.nvim")
-append = function(option, value)
-    option.append(option, value)
-end
 append(vim.opt.rtp, ".")
-append(vim.opt.rtp, plenaryDir)
-append(vim.opt.rtp, telescopeDir)
 vim.cmd("runtime plugin/plenary.vim")
+vim.cmd("runtime plugin/telescope.lua")
 require("plenary.busted")

tests/minimal_init.ts

@@ -1,3 +1,7 @@
+const append = (option: any, value: any) => {
+  option.append(option, value);
+};
+
 const loadModule = (module: string, source: string, directory?: string) => {
   const moduleDir = directory || `/tmp/${module}`;
   const directoryExists = vim.fn.isdirectory(moduleDir);
@@ -6,6 +10,8 @@ const loadModule = (module: string, source: string, directory?: string) => {
     vim.fn.system(["git", "clone", source, moduleDir]);
   }
 
+  append(vim.opt.rtp, moduleDir);
+
   return moduleDir;
 };
 
@@ -21,12 +27,7 @@ const telescopeDir = loadModule(
   "https://github.com/nvim-telescope/telescope.nvim",
 );
 
-const append = (option: any, value: any) => {
-  option.append(option, value);
-};
-
 append(vim.opt.rtp, ".");
-append(vim.opt.rtp, plenaryDir);
-append(vim.opt.rtp, telescopeDir);
 vim.cmd("runtime plugin/plenary.vim");
+vim.cmd("runtime plugin/telescope.lua");
 require("plenary.busted");