Reorganizing + fixing hubl auto detection by brandenrodgers · Pull Request #295 · HubSpot/hubspot-cms-vscode

brandenrodgers · 2025-10-17T22:06:11Z

Some mostly structural updates to the project to make it easier to build on. This makes some fixes to the hubl auto detection functionality that seems to have not been working. The major changes:

hubl auto detection should work now (I could have just been testing this incorrectly, but it wasn't working for me originally)
Reorganizing the folder structure to be a bit more intuitive
Grouping common utils into files in lib/
Moving features out of the lib folder
Creating a dedicated "Events" folder
Turning certain registered commands into standard js functions in areas where they don't need to be registered
Cleaning up some dead code
Removing some unnecessary deps
Organizing imports for all files

brandenrodgers · 2025-10-20T14:05:12Z

src/features/autoDetectHubl.ts

  fileAssoc[`*.html`] = HUBL_HTML_ID;
  fileAssoc[`*.css`] = HUBL_CSS_ID;
-  filesConfig.update('associations', fileAssoc);
+  filesConfig.update('associations', fileAssoc, ConfigurationTarget.Workspace);


We should be explicit here and save the "this project uses hubl" setting at the workspace level.

brandenrodgers · 2025-10-20T14:10:28Z

src/features/autoDetectHubl.ts

@@ -4,47 +4,67 @@ import {
  window,


There were two issues in this. The loop for the hubl detection wasn't reading the first character, and the hubl check logic wasn't running for documents that were already opened in the editor.

…n tracking

brandenrodgers · 2025-10-20T15:02:20Z

package.json

                "command": "hubspot.remoteFs.hardRefresh",
-                "title": "Refresh"
-            },
-            {


These commands can be deleted from here. This project uses a pattern where we have "events" and "commands".

commands - user-facing commands that can be executed via some form of ui interaction

events - internal-only "commands" that cannot be directly triggered by a user through the ui

Anything that is purely an event, does not need to be configured here in the package.json file. I cleaned up everything in here that was defined as a command, has a "when: false" clause, and is not referenced anywhere else in the package.json file (i.e. menu options or something else).

brandenrodgers · 2025-10-20T15:35:13Z

webpack.config.js

        loader: 'node-loader',
      },
-      {
-        test: /\.lyaml$/,


We removed the lyaml file as part of the migration from cli-lib to local-dev-lib, so we don't need this anymore.

brandenrodgers · 2025-10-20T15:56:53Z

src/lib/commands/globalState.ts

-import * as dayjs from 'dayjs';
-import { COMMANDS } from '../constants';
-
-export const registerCommands = (context: ExtensionContext) => {


Per the patterns of this project, this is actually an "event" instead of a command. But it also isn't leveraged anywhere in the package.json file, so we can remove this completely. It's just a thin wrapper around the context.globalState.update() function. I added two utils to the helpers.ts file, updated the panels/feedback.ts file, and then updated all the code that previously called executeCommand(COMMANDS.GLOBAL_STATE.UPDATE_DELAY) to directly call the global state update function instead.

brandenrodgers · 2025-10-20T16:05:22Z

src/events/index.ts

@@ -0,0 +1,11 @@
+import { ExtensionContext } from 'vscode';


I'm still ramping up here, but from what I can tell so far this "Events" pattern is adding unnecessary complexity. In most (all?) cases there isn't a need to leverage VSCode's event bus to execute logic like this. AFAIK the primary reason to register events is to expose them as user-facing functionality in the contributes section of the package.json.

I undid some of it (all the terminal logic that checks the installation status for npm and the cli, and also the global state events), but not all of it because some events are pretty deeply rooted.

brandenrodgers · 2025-10-20T16:07:34Z

src/lib/commands/terminal.ts

-import { COMMANDS, POLLING_INTERVALS } from '../constants';
-
-export const registerCommands = (context: ExtensionContext) => {
-  context.subscriptions.push(


This is an example of "events" that don't need to be events. These aren't referenced anywhere in the package.json file, so there's no reason for them to leverage the register/execute event bus pattern. I ported all of these into the terminal.ts file and now they're called directly as standard js functions

brandenrodgers · 2025-10-20T16:08:27Z

src/lib/constants.ts

@@ -1,13 +1,3 @@
-export const TEMPLATE_ERRORS_TYPES = {


I removed some constants from here that are only used in a single place

brandenrodgers · 2025-10-20T16:09:06Z

src/lib/helpers.ts

@@ -1,11 +1,5 @@
-import { dirname } from 'path';


This file was operating as a catch-all so I moved some of the utils to dedicated lib files

brandenrodgers · 2025-10-20T16:10:37Z

src/providers/index.ts

@@ -0,0 +1,11 @@
+import { ExtensionContext } from 'vscode';


Mostly just moving files around for all these providers so they follow the same registration pattern that we're using for panels, commands, and events

camden11

Still ramping up with the VScode extension so not entirely sure whats going on 100% of the time here, but nothing stood out to me. Still need to test things out

camden11 · 2025-10-22T21:13:57Z

package-lock.json

Might be good to update the repo to use yarn since everything else we own does

Good call. I'll do that in a separate pr since I already have too many changes bundled into this one

camden11

Still looking through the code, but when testing I noticed that the "Authenticate Additional HubSpot Account" button doesn't seem to be working. Not sure if that's just an issue with my local setup, but it works as expected in my installed version of the extension

camden11

Once again, not really a VSCode expert but code here LGTM. Only issue I can find is the auth button not working

brandenrodgers · 2025-12-05T20:55:50Z

@camden11 good catch. I fixed the key in de9debe

camden11

Nice, auth button is working again! LGTM

Reorganizing this project

5e5bf1b

brandenrodgers commented Oct 20, 2025

View reviewed changes

Remove commands from package.json, cleanup constants, remove awaits o…

ed8a47f

…n tracking

brandenrodgers commented Oct 20, 2025

View reviewed changes

global state does not need to be an event

3e3e448

brandenrodgers commented Oct 20, 2025

View reviewed changes

brandenrodgers requested review from TanyaScales, camden11, chiragchadha1, joe-yeager and jsines October 20, 2025 15:58

brandenrodgers commented Oct 20, 2025

View reviewed changes

brandenrodgers added 2 commits October 21, 2025 17:40

Merge branch 'master' into br/organizing

ad3ae16

Merge branch 'master' into br/organizing

3b8c81e

camden11 reviewed Oct 22, 2025

View reviewed changes

brandenrodgers force-pushed the br/organizing branch from 8c5be8b to 3b8c81e Compare December 4, 2025 15:37

Merge branch 'master' into br/organizing

c47f70e

camden11 reviewed Dec 4, 2025

View reviewed changes

fix key

de9debe

brandenrodgers requested a review from camden11 December 5, 2025 20:55

camden11 approved these changes Dec 5, 2025

View reviewed changes

brandenrodgers merged commit 675a722 into master Dec 5, 2025
1 check passed

brandenrodgers deleted the br/organizing branch December 5, 2025 22:26

Comments

Conversation

brandenrodgers commented Oct 17, 2025

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!

brandenrodgers Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

camden11 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!

camden11 left a comment

Choose a reason for hiding this comment

Uh oh!

camden11 left a comment

Choose a reason for hiding this comment

Uh oh!

brandenrodgers commented Dec 5, 2025

Uh oh!

camden11 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

brandenrodgers Oct 20, 2025 •

edited

Loading