Remove Lerna and (mostly) set up TypeScript #1183

camden11 · 2024-09-25T19:38:20Z

Description and Context

This PR pulls everything except the actual HubSpot CLI out of this repo, and changes it from a monorepo into a repo strictly dedicated to the CLI. It also does some basic setup for typescript, and adds a typescript build step that is integrated into local commands and the release flow. For the most part, this just moves everything that existed in packages/cli before to the root of the repo. In a few places (such as package.json) I did my best to combine the top level version with the version that existed in packages/cli.

Some other things here off the top of my head

Random cleanup and housekeeping, like updating readme in some places and removing references to cms-cli
New release scripts - they should function the same as the lerna ones (and have been tested with --dry-run!) but the actual commands themselves to release will be different
There were a few other side effects of not using a monorepo
- We can't use workspaces anymore, which automatically installed deps in acceptance-tests. I added a yarn install to the beginning of the test command to make sure deps are installed when you run.
- Previously, the CLI was technically a dependancy of the top level repo. This let us run the CLI's bin commands directly from the monorepo. Since that's not the case anymore, I set up a new script in the package.json for running commands locally. I figured we probably didn't need to run hscms locally anymore, but I can add one for that too if we want to
There will be merge conflicts every time anything is changed in the CLI, so at this point i'll probably wait until this is ready to merge to take care of all of those

As part of this PR, webpack-cms-plugins and serverless-dev-runtime were removed from this repo. Here are their new repos:

There have been some version updates since I made the repos, so we'll need to get those in sync with their current versions so we don't run into issues if/when we ever want to release those again. We will also need to update webpack-cms-plugins to be public

TODO

There is still some setup that needs to be done to get the unit tests to work with typescript files. Right now, if you attempt to actually change any files to TS, you get syntax errors in the tests (since they don't expect typescript). I tried using the ts-jest preset, but this resulted in type errors in the tests. There's probably an easy solution for this, but I figured it could wait until later since this PR is already so huge.

Testing

The main way to test this is to run commands locally.
It might also be worth npm linking serverless-dev-runtime and making sure that still works as expected.
I've tested the release commands using npm publish --dry-run and it seems like they work as expected. I set up this branch do test releases so feel free to check it out locally and try yourself https://github.com/HubSpot/hubspot-cli/tree/remove-lerna-test-release

Who to Notify

@joe-yeager @kemmerle @brandenrodgers

camden11 · 2024-09-26T20:47:06Z

.github/workflows/build.yml

      - name: Verify package dependencies
        run: |
-          yarn check-deps
+          npx depcheck


Now that we don't have multiple packages in the repo, this is a bit simpler and we don't need the custom script. Figured it makes sense to just use npx (they suggest it on their npm docs https://www.npmjs.com/package/depcheck)

camden11 · 2024-09-26T20:49:15Z

docs/PublishingReleases.md

-
-1. Run `yarn publish-prerelease`. The publish command will handle bumping the version, tagging via git, and publishing the packages to NPM under the `next` dist-tag.
-1. If there are publishing errors, you can run again via `yarn lerna publish from-package --dist-tag next` ([Docs][from-package]).
-


I was going to update this with the new release commands, but wasn't sure if it even made a ton of sense to have release documentation on a public repo

Yeah I'm fine with removing this 👍 we can keep it internal

camden11 · 2024-09-26T20:50:25Z

lib/serverlessLogs.js

-} = require('../../../../hubspot-local-dev-lib/dist/config');
-const {
-  fetchScopeData,
-} = require('../../../../hubspot-local-dev-lib/dist/api/localDevAuth');


somehow these imports got messed up on the next branch

camden11 · 2024-09-26T20:51:34Z

package.json

+    "release:patch": "yarn check-main && yarn version --patch && yarn pub && yarn push",
+    "prerelease:major": "yarn check-main && yarn version --premajor --preeid=beta && yarn pub && yarn push",
+    "prerelease:minor": "yarn check-main && yarn version --preminor --preeid=beta && yarn pub && yarn push",
+    "prerelease:patch": "yarn check-main && yarn version --prepatch --preeid=beta && yarn pub && yarn push",


These are our new release scripts. They match the ones in local-dev-lib but add 3 new ones to do prereleases

kemmerle · 2024-10-03T17:50:12Z

README.md

+
+```bash
+hs hubdb delete <id or name>
+```


Do we want to take the opportunity to give a rundown of project and sandbox commands here?

UPDATE after sync: Let's delete the commands list and link to the docs.

kemmerle · 2024-10-03T17:57:47Z

package.json

-  "name": "hubspot-local-dev-tools",
-  "version": "1.0.0",
-  "description": "Local development tools for working with HubSpot",
+  "name": "@hubspot/cli",


Oh jeez, this needed an update!

kemmerle · 2024-10-03T17:59:31Z

package.json

  "scripts": {
-    "check-deps": "node bin/depcheck.js",


Can you remind me what's happening with depcheck? Do we not need this command anymore?

Still using it, but we didn't need a custom script anymore so we're just using npx (see my comment above on build.yml)

camden11 added 14 commits September 23, 2024 11:28

Remove webpack-cms-plugins

09ae7a3

Remove serverless-dev-runtime

c06b5b0

remove packages dir

4cc94aa

Remove most references to lerna

d9af474

Remove references to packages path

fdc9f92

Add new release commands

ad6341c

remove old release commands and publishing releases doc

dbf5962

use npx for depcheck

90b9268

stop ignoring bin

64c2162

Merge branch 'next' into remove-lerna

9a82d18

remove packages/cli

a92301c

run locally attempt 1

8282fdc

fix local commands

b58fad6

fix package.json version

fb09617

camden11 commented Sep 26, 2024

View reviewed changes

Base automatically changed from next to main October 1, 2024 19:35

camden11 added 3 commits October 2, 2024 16:57

Merge branch 'main' into remove-lerna

2769b8e

Merge branch 'main' into remove-lerna

af6e1ee

Add script to install acceptance-tests deps

78558b5

kemmerle reviewed Oct 3, 2024

View reviewed changes

camden11 added 5 commits October 3, 2024 15:30

remove commands section of readme

3f4afbd

Set up TS

47f4315

enable local commands

a48254c

Copy bin files

3c38ac2

Fix tests

29b2eb0

camden11 added 3 commits October 4, 2024 12:21

Add TS build to GH action

32c6c0a

Remove ts-jest (for now)

6a130ce

Build and use dist for release commands

37d6e76

camden11 changed the title ~~Remove lerna~~ Remove Lerna and (mostly) set up TypeScript Oct 4, 2024

camden11 marked this pull request as ready for review October 4, 2024 17:24

camden11 requested review from brandenrodgers and joe-yeager as code owners October 4, 2024 17:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove Lerna and (mostly) set up TypeScript #1183

Remove Lerna and (mostly) set up TypeScript #1183

camden11 commented Sep 25, 2024 •

edited

Loading

camden11 Sep 26, 2024

camden11 Sep 26, 2024

brandenrodgers Oct 4, 2024

camden11 Sep 26, 2024

camden11 Sep 26, 2024

kemmerle Oct 3, 2024

kemmerle Oct 3, 2024

kemmerle Oct 3, 2024

kemmerle Oct 3, 2024

camden11 Oct 4, 2024


		1. Run `yarn publish-prerelease`. The publish command will handle bumping the version, tagging via git, and publishing the packages to NPM under the `next` dist-tag.
		1. If there are publishing errors, you can run again via `yarn lerna publish from-package --dist-tag next` ([Docs][from-package]).

Remove Lerna and (mostly) set up TypeScript #1183

Are you sure you want to change the base?

Remove Lerna and (mostly) set up TypeScript #1183

Conversation

camden11 commented Sep 25, 2024 • edited Loading

Description and Context

TODO

Testing

Who to Notify

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

camden11 commented Sep 25, 2024 •

edited

Loading