refactor: rename the plugin to devto.nvim

Massolari · Massolari · commit c73273d63ad7 · 2025-03-14T18:40:19.000+01:00
We don't support other forem platforms
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Forem.nvim
+# Devto.nvim
 
-<p align="center">This plugin integrates Neovim with Forem platforms like [dev.to](https://dev.to)</p>
+<p align="center">This plugin integrates Neovim with [dev.to](https://dev.to)</p>
 
 https://user-images.githubusercontent.com/12272702/175755820-a2b93f4b-fd5c-416b-8b9e-d981335ef75c.mov
 
@@ -35,7 +35,7 @@ You can use the plugin without any dependencies, but if you have any of the foll
 
 ```lua
 {
-    "Massolari/forem.nvim",
+    "Massolari/devto.nvim",
     dependencies = {
         "nvim-lua/plenary.nvim",
         -- Optional
@@ -49,7 +49,7 @@ You can use the plugin without any dependencies, but if you have any of the foll
 
 ```lua
 use {
-    "Massolari/forem.nvim",
+    "Massolari/devto.nvim",
     requires = {
         "nvim-lua/plenary.nvim",
         -- Optional
@@ -68,18 +68,18 @@ 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)
 
-With your API key, you just need to set it into the `FOREM_API_KEY` environment variable.
+With your API key, you just need to set it into the `DEVTO_API_KEY` environment variable.
 
 ## Usage
 
-The plugin has the following commands and functions available in `forem-nvim` module:
+The plugin has the following commands and functions available in `devto-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 a URL, then opens the article                                                       |
+| `feed()`        | `:Devto feed`        | Shows fresh articles from the feed, then you can read it in Neovim or open it in the browser |
+| `my_articles()` | `:Devto my_articles` | Shows all your articles, then you can pick one to edit                                       |
+| `new_article()` | `:Devto new_article` | Asks for a title, then creates an article with the given title and open it to edit           |
+| `open_by_url()` | `:Devto open_by_url` | Asks for a URL, then opens the article                                                       |
 
 After you save the buffer it'll automatically be saved in the cloud.
 
diff --git a/lua/devto-nvim/api.lua b/lua/devto-nvim/api.lua
@@ -1,9 +1,9 @@
 local M = {}
-local notify = require("forem-nvim.notify")
-local article = require("forem-nvim.article")
+local notify = require("devto-nvim.notify")
+local article = require("devto-nvim.article")
 
 function M.key()
-  return vim.env.FOREM_API_KEY
+  return vim.env.devto_API_KEY
 end
 
 local BASE_URL = "https://dev.to/api"
@@ -102,7 +102,7 @@ local function request(method, endpoint, options)
       headers = {
         "api-key: " .. M.key(),
         "Content-Type: application/json",
-        "Accept: application/vnd.forem.api-v1+json"
+        "Accept: application/vnd.devto.api-v1+json"
       }
     },
     options
diff --git a/lua/devto-nvim/article.lua b/lua/devto-nvim/article.lua
diff --git a/lua/devto-nvim/buffer.lua b/lua/devto-nvim/buffer.lua
@@ -1,6 +1,6 @@
 local M = {}
-local Article = require("forem-nvim.article")
-local util = require("forem-nvim.util")
+local Article = require("devto-nvim.article")
+local util = require("devto-nvim.util")
 local set_locals = util.set_locals
 
 M.set_basic_options = function()
@@ -33,7 +33,7 @@ M.get_content = function()
 end
 
 M.open_my_article = function(article)
-  vim.cmd(":edit forem://my-article/" .. tostring(article.id))
+  vim.cmd(":edit devto://my-article/" .. tostring(article.id))
   local buffer = vim.api.nvim_get_current_buf()
   M.write(
     buffer,
@@ -44,7 +44,7 @@ M.open_my_article = function(article)
 end
 
 M.load_article = function(article)
-  vim.cmd(":edit forem://article/" .. article.title)
+  vim.cmd(":edit devto://article/" .. article.title)
   set_locals({ linebreak = true, textwidth = 80 })
   local buffer = vim.api.nvim_get_current_buf()
   local body = Article.get_body_lines(article)
diff --git a/lua/devto-nvim/feed.lua b/lua/devto-nvim/feed.lua
@@ -1,12 +1,12 @@
 local M = {}
-local api = require("forem-nvim.api")
-local buffer = require("forem-nvim.buffer")
-local notify = require("forem-nvim.notify")
-local util = require("forem-nvim.util")
+local api = require("devto-nvim.api")
+local buffer = require("devto-nvim.buffer")
+local notify = require("devto-nvim.notify")
+local util = require("devto-nvim.util")
 local set_locals = util.set_locals
 
 function M.open()
-  return vim.cmd("edit forem://articles/feed")
+  return vim.cmd("edit devto://articles/feed")
 end
 
 local function set_basic_options()
@@ -62,7 +62,7 @@ function M.open_article(location)
     return
   end
 
-  local article_data = _G.forem_feed_articles and _G.forem_feed_articles[title]
+  local article_data = _G.devto_feed_articles and _G.devto_feed_articles[title]
   if not article_data then
     notify.error("Could not find article data. Please reload the feed.")
     return
@@ -91,9 +91,9 @@ local function set_key_maps()
 end
 
 local function populate_global_feed_articles(articles)
-  _G.forem_feed_articles = {}
+  _G.devto_feed_articles = {}
   for _, article in ipairs(articles) do
-    _G.forem_feed_articles[article.title] = { id = article.id, url = article.url }
+    _G.devto_feed_articles[article.title] = { id = article.id, url = article.url }
   end
 end
 
diff --git a/lua/devto-nvim/init.lua b/lua/devto-nvim/init.lua
@@ -1,11 +1,11 @@
 local M = {}
-local api = require("forem-nvim.api")
-local buffer = require("forem-nvim.buffer")
-local feed = require("forem-nvim.feed")
-local notify = require("forem-nvim.notify")
-local picker = require("forem-nvim.picker")
+local api = require("devto-nvim.api")
+local buffer = require("devto-nvim.buffer")
+local feed = require("devto-nvim.feed")
+local notify = require("devto-nvim.notify")
+local picker = require("devto-nvim.picker")
 
-local NO_API_KEY_ERROR = "forem.nvim: FOREM_API_KEY environment variable is missing"
+local NO_API_KEY_ERROR = "devto.nvim: devto_API_KEY environment variable is missing"
 
 local function check_api_key(callback)
   if api.key() then
@@ -26,7 +26,7 @@ local function save_article()
   local id = tonumber(vim.fn.expand("%:t"))
 
   if not id then
-    notify.error("forem.nvim: Could not find article id")
+    notify.error("devto.nvim: Could not find article id")
     return
   end
 
@@ -79,17 +79,17 @@ local function open_by_url()
   api.get_article_by_path(path, buffer.load_article)
 end
 
-local forem_au_group = vim.api.nvim_create_augroup("forem_autocmds", {})
+local devto_au_group = vim.api.nvim_create_augroup("devto_autocmds", {})
 
 vim.api.nvim_create_autocmd("BufWriteCmd",
-  { group = forem_au_group, pattern = "forem://my-article/*", callback = save_article })
+  { group = devto_au_group, pattern = "devto://my-article/*", callback = save_article })
 vim.api.nvim_create_autocmd("BufEnter",
-  { group = forem_au_group, pattern = "forem://articles/feed", callback = feed.load })
+  { group = devto_au_group, pattern = "devto://articles/feed", callback = feed.load })
 vim.api.nvim_create_autocmd(
   "CursorMoved",
   {
-    group = forem_au_group,
-    pattern = "forem://*/floatmenu",
+    group = devto_au_group,
+    pattern = "devto://*/floatmenu",
     callback = function()
       local bufnum, line, column, off = unpack(vim.fn.getpos("."))
       if column <= 1 then
@@ -102,8 +102,8 @@ vim.api.nvim_create_autocmd(
 vim.api.nvim_create_autocmd(
   "BufEnter",
   {
-    group = forem_au_group,
-    pattern = "forem://*/floatmenu",
+    group = devto_au_group,
+    pattern = "devto://*/floatmenu",
     callback = function()
       vim.keymap.set(
         "n",
diff --git a/lua/devto-nvim/notify.lua b/lua/devto-nvim/notify.lua
@@ -1,6 +1,6 @@
 local M = {}
 local function notify(message, level)
-  vim.notify(message, vim.log.levels[level], { title = "Forem.nvim" })
+  vim.notify(message, vim.log.levels[level], { title = "Devto.nvim" })
 end
 function M.error(message) return notify(message, "ERROR") end
 
diff --git a/lua/devto-nvim/picker.lua b/lua/devto-nvim/picker.lua
@@ -1,6 +1,6 @@
 local M = {}
-local buffer = require("forem-nvim.buffer")
-local Article = require("forem-nvim.article")
+local buffer = require("devto-nvim.buffer")
+local Article = require("devto-nvim.article")
 
 local function my_articles_telescope_picker(articles)
   local telescope_config = require("telescope.config")
diff --git a/lua/devto-nvim/util.lua b/lua/devto-nvim/util.lua
@@ -62,7 +62,7 @@ function M.open_float_menu(content, options)
     true,
     content
   )
-  vim.api.nvim_buf_set_name(bufnr, "forem://feed/floatmenu")
+  vim.api.nvim_buf_set_name(bufnr, "devto://feed/floatmenu")
   vim.api.nvim_set_option_value("modifiable", false, { buf = bufnr })
   vim.api.nvim_set_option_value("bufhidden", "delete", { buf = bufnr })
   vim.api.nvim_set_option_value("cursorline", true, { win = window })
diff --git a/plugin/devto-nvim.lua b/plugin/devto-nvim.lua
@@ -1,6 +1,6 @@
 local M = {}
-local forem = require("forem-nvim")
-local notify = require("forem-nvim.notify")
+local devto = require("devto-nvim")
+local notify = require("devto-nvim.notify")
 
 local commands = {
   feed = "feed",
@@ -10,18 +10,18 @@ local commands = {
 }
 
 vim.api.nvim_create_user_command(
-  "Forem",
+  "devto",
   function(data)
     local args = data.args
 
     if args == commands.feed then
-      return forem.feed()
+      return devto.feed()
     elseif args == commands.my_articles then
-      return forem.my_articles()
+      return devto.my_articles()
     elseif args == commands.new_article then
-      return forem.new_article()
+      return devto.new_article()
     elseif args == commands.open_url then
-      return forem.open_url()
+      return devto.open_url()
     else
       notify.error("Unknown command: " .. args)
     end
diff --git a/tests/devto-nvim/setup_spec.lua b/tests/devto-nvim/setup_spec.lua
@@ -2,30 +2,30 @@ local M = {}
 local stub = require("luassert.stub")
 local spy = require("luassert.spy")
 local match = require("luassert.match")
-local article = require("forem-nvim.article")
+local article = require("devto-nvim.article")
 local busted = require("plenary.busted")
 local describe = busted.describe
 local before_each = busted.before_each
 local after_each = busted.after_each
 local it = busted.it
 
 local function mock_internal(module)
-  _G.package.loaded["forem-nvim"] = nil
+  _G.package.loaded["devto-nvim"] = nil
   _G.package.loaded[module] = nil
   local mocked = require(module)
   return mocked
 end
 
 describe(
-  "Forem.nvim",
+  "devto.nvim",
   function()
-    local forem_nvim
+    local devto_nvim
     local snapshot
 
     before_each(function()
-      vim.env.FOREM_API_KEY = "foo"
-      _G.package.loaded["forem-nvim"] = nil
-      forem_nvim = require("forem-nvim")
+      vim.env.devto_API_KEY = "foo"
+      _G.package.loaded["devto-nvim"] = nil
+      devto_nvim = require("devto-nvim")
       snapshot = assert:snapshot()
     end)
 
@@ -36,21 +36,21 @@ describe(
     it(
       "should show a notification when no api key is set",
       function()
-        vim.env.FOREM_API_KEY = nil
+        vim.env.devto_API_KEY = nil
         stub.new(vim, "notify")
-        forem_nvim.my_articles()
+        devto_nvim.my_articles()
         assert.stub(vim.notify).was.called()
       end
     )
 
     it(
       "should call the api to get the articles",
       function()
-        local mocked_api = mock_internal("forem-nvim.api")
+        local mocked_api = mock_internal("devto-nvim.api")
         mocked_api.my_articles = spy.new(function()
         end)
-        local forem_nvim_mocked = require("forem-nvim")
-        forem_nvim_mocked.my_articles()
+        local devto_nvim_mocked = require("devto-nvim")
+        devto_nvim_mocked.my_articles()
         assert.spy(mocked_api.my_articles).was.called()
       end
     )
@@ -60,21 +60,21 @@ describe(
       function()
         local input = stub.new(vim.fn, "input")
         input.returns("Title")
-        local api = mock_internal("forem-nvim.api")
+        local api = mock_internal("devto-nvim.api")
         local api_new_article = stub.new(api, "new_article")
         local new_article = {
           id = 1,
           body_markdown = article.get_template("Title")
         }
         api_new_article.returns({ status = 201, body = new_article })
-        local buffer = mock_internal("forem-nvim.buffer")
+        local buffer = mock_internal("devto-nvim.buffer")
         local buffer_open_my_article = spy.on(buffer, "open_my_article")
-        local forem_nvim_mocked = require("forem-nvim")
-        forem_nvim_mocked.new_article()
+        local devto_nvim_mocked = require("devto-nvim")
+        devto_nvim_mocked.new_article()
         assert.stub(api_new_article).was.called_with("Title")
         assert.spy(buffer_open_my_article).was_called_with(match.is_same(new_article))
         assert.are.same(
-          "forem://my-article/" .. tostring(new_article.id),
+          "devto://my-article/" .. tostring(new_article.id),
           vim.api.nvim_buf_get_name(0)
         )
         local buffer_content = vim.api.nvim_buf_get_lines(0, 0, -1, true)

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ function M.open_float_menu(content, options)`
`62`	`62`	`true,`
`63`	`63`	`content`
`64`	`64`	`)`
`65`		`- vim.api.nvim_buf_set_name(bufnr, "forem://feed/floatmenu")`
	`65`	`+ vim.api.nvim_buf_set_name(bufnr, "devto://feed/floatmenu")`
`66`	`66`	`vim.api.nvim_set_option_value("modifiable", false, { buf = bufnr })`
`67`	`67`	`vim.api.nvim_set_option_value("bufhidden", "delete", { buf = bufnr })`
`68`	`68`	`vim.api.nvim_set_option_value("cursorline", true, { win = window })`