Adds scaffolding for publishing #124

ncordon · 2023-10-23T10:42:43Z

This PR brings a lot of changes to make the package ready for publishing:

Adds a LICENSE file to each subproject, as that will be needed.
Fixes the VSCode extension debugging. This has been done by:
- Using a different language server (a non bundled one that loads the language support package code when used) for debugging and a bundled one for run.
- Enabling source maps in the .vscode/launch file and giving them the paths of all source maps inside language support and schema-poller.
Enables TS incremental compilation. This enables to recompile projects very quickly after the first run with npm run build, unless you run a clean.
Bundles antlr4 and antlr4-c3 inside the language-support package and uses esbuild whenever possible or necessary with other packages.
Adds the typings for react-codemirror.
Configures the exports so all the projects work both with esm and commonjs.
- I've tried publishing the language-support package locally, installing it into a separate project with npm link and using it both as commonjs and esm, it works ✅ .
Cleans up the libraries and aligns the projects on Typescript 4.9.5. We have 0 library vulnerabilities now, we used to have some.

Installs changeset and aligns all versions on a 2.0.0-next.0 release.
Changes the VSCode extension settings from CypherLSP.neo4j to just neo4j namespace, which looks cleaner:

    "neo4j.connect": true,
    "neo4j.password": "pass12345",
    "neo4j.user": "neo4j"

Caveats

I don't know why but the package-lock.json has a lot of changes. I upgraded my npm locally to 9.5.0 so maybe that is caused a lot of them.

changeset pre enter next

…fore tests

CLAassistant · 2023-10-23T10:42:49Z

All committers have signed the CLA.

ncordon · 2023-10-23T10:44:45Z

.vscode/launch.json

+      "outFiles": [
+        "${workspaceRoot}/packages/vscode-extension/**/*.js",
+        "${workspaceRoot}/packages/language-support/**/*.cjs",
+        "${workspaceRoot}/packages/schema-poller/**/*.cjs"
+      ],
      "autoAttachChildProcesses": true,
-      "preLaunchTask": {
-        "type": "npm",
-        "script": "watch"
-      }
+      "sourceMaps": true


This fixes the VSCode debugging

ncordon · 2023-10-23T10:45:03Z

package.json

@@ -34,6 +35,6 @@
    "prettier-plugin-organize-imports": "^3.2.1",
    "ts-jest": "^29.1.1",
    "turbo": "^1.10.15",
-    "typescript": "^4.8.4"
+    "typescript": "4.9.5"


Aligns the same typescript version everywhere

ncordon · 2023-10-23T10:45:55Z

.changeset/pre.json

@@ -0,0 +1,15 @@
+{
+  "mode": "pre",
+  "tag": "next",


I don't know how it works but my intuition tells me we should be using this next tag instead of the alpha one? At least that's what they even describe in the changesets documentation

ncordon · 2023-10-23T10:57:48Z

packages/language-support/package.json

@@ -14,11 +22,11 @@
  },
  "scripts": {
    "gen-parser": "antlr4 -Dlanguage=TypeScript -visitor src/antlr-grammar/CypherParser.g4 src/antlr-grammar/CypherLexer.g4 -o src/generated-parser/ -Xexact-output-dir",
-    "postinstall": "npm run gen-parser",


We don't need this as far as I know. The generated parser should be included in the package

ncordon · 2023-10-23T12:21:51Z

packages/language-support/package.json

-  "module": "./esm/index.js",
+  "version": "2.0.0-next.0",
+  "main": "./dist/cjs/index.cjs",
+  "moudle": "./dist/esm/index.mjs",


ncordon · 2023-10-23T12:31:43Z

vendor/antlr4-c3/deps

@@ -0,0 +1,1606 @@
+@[email protected] /Users/ncordon/neo4j/intellisense/cypher-lsp


Remove this file

ncordon · 2023-10-23T12:36:18Z

vendor/antlr4-c3/tsconfig.json

@@ -1,7 +1,8 @@
 {
  "compilerOptions": {
    "declaration": true,
-    "target": "ES2022",
+    "target": "ESNext",


Research whether we should use ESNext vs es2020 for example

ncordon · 2023-10-23T16:39:49Z

.changeset/config.json

+  "ignore": [
+    "antlr4",
+    "antlr4-c3",
+    "vscode-extension",
+    "react-codemirror-playground",
+    "schema-poller"
+  ]


Not sure if we need this. In the description of ignore it says Packages that should not be released

ncordon · 2023-10-23T16:40:03Z

.npmignore

@@ -0,0 +1,25 @@
+# Node files


Not sure if we need this file either

ncordon · 2023-10-23T16:41:08Z

packages/language-server/package.json

-  "version": "0.0.1",
-  "main": "dist/cypher-language-server.js",
+  "version": "2.0.0-next.0",
+  "main": "./dist/server.js",


This is for VSCode debugging to work

ncordon · 2023-10-23T16:53:22Z

.vscode/launch.json

-        "type": "npm",
-        "script": "watch"
-      }


Not sure whether we need the watch but it seems broken to me locally

ncordon · 2023-10-23T16:55:43Z

packages/vscode-extension/src/extension.ts

+  const runServer = context.asAbsolutePath(
+    path.join('dist', 'cypher-language-server.js'),
+  );
+  const debugServer = context.asAbsolutePath(
+    path.join('..', 'language-server', 'dist', 'server.js'),


Use a different configuration for debug and for running (once the extension is compiled, the language server has to be living inside it, we cannot use a relative path). Also we want that language server to be minified.

ncordon · 2023-10-23T16:56:00Z

tsconfig.base.json

@@ -9,7 +9,8 @@
    "skipLibCheck": true,
    "sourceMap": true,
    "target": "ESNext",
-    "outDir": "dist"
+    "outDir": "dist",
+    "incremental": true


Enables incremental compilation

ncordon · 2023-10-23T16:59:01Z

package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@neo4j-cypher",
-  "description": "Cypher Language Support",
+  "name": "neo4j-cypher-language-support",


This name wasn't valid for the top package because of the @ 🤷‍♂️

ncordon · 2023-10-23T16:59:32Z

packages/vscode-extension/package.json

-  "name": "@neo4j-cypher/vscode-extension",
-  "description": "Neo4j's Cypher VSCode extension",
-  "author": "neo4j",
+  "name": "neo4j-cypher-vscode-extension",


The command to publish the VSCode extension doesn't like this name either

ncordon added 9 commits October 23, 2023 11:27

Adds and inits changesets

b867ee3

Adds changeset

4baf75d

Fixes versions on 1.0.0

dd418f7

Enters pre-release 2.0.0-next.0

649f6a6

changeset pre enter next

Fixes versions of typescript, compiles antlr4-c3 to cjs and esm

cc9566c

Bundles language support with antlr4 and antlr4-c3

18d9521

Fixes build types in react-codemirror package

5a2e982

Adds more changes to the packaging

59a0871

Doesn't check the semantic analysis, compiles the vscode-extension be…

bcfb4e1

…fore tests

ncordon mentioned this pull request Oct 23, 2023

Uses incremental builds and avoids checking semanticAnalysis.js #120

Closed

ncordon commented Oct 23, 2023

View reviewed changes

Makes changeset publishing access public

b5321f5

ncordon commented Oct 23, 2023

View reviewed changes

ncordon added 3 commits October 23, 2023 12:01

Adds .npmignore and more nits

e72a2e9

Corrects name of global project

039de60

concurrently exits in antlr4-c3 before it generates the output 😢

dfd300b

ncordon added the not-ready-for-review label Oct 23, 2023

ncordon commented Oct 23, 2023

View reviewed changes

ncordon added 7 commits October 23, 2023 16:55

Adds license to every sub package

e4d2b31

Cleans dep files

70dc788

Changes CypherLSP config options

58ac662

Ignores packages we do not want to publish in changeset

9c6ca8e

Updates package lock

bed1f3a

Makes the vscode extension use a different compilation for debug and run

5407155

Fixes VSCode e2e tests build steps

4713b14

Adds holder of the copyright to the LICENSEs

a5f34e2

ncordon commented Oct 23, 2023

View reviewed changes

.npmignore

@@ -0,0 +1,25 @@

# Node files

Copy link

Collaborator Author

ncordon Oct 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if we need this file either

ncordon commented Oct 23, 2023

View reviewed changes

Adds last nits

0ef0883

ncordon requested a review from OskarDamkjaer October 23, 2023 17:59

ncordon assigned OskarDamkjaer Oct 23, 2023

ncordon removed the not-ready-for-review label Oct 23, 2023

ncordon added 2 commits October 24, 2023 09:51

Fixes debugging of the codemirror extension

9714b8c

Ignores dist folder in c3

921424f

OskarDamkjaer approved these changes Oct 24, 2023

View reviewed changes

ncordon merged commit 19ffd9d into main Oct 24, 2023
3 checks passed

ncordon deleted the publishing-scaffolding branch October 24, 2023 12:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds scaffolding for publishing #124

Adds scaffolding for publishing #124

ncordon commented Oct 23, 2023 •

edited

Loading

CLAassistant commented Oct 23, 2023 •

edited

Loading

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

ncordon Oct 23, 2023

		@@ -0,0 +1,1606 @@
		@[email protected] /Users/ncordon/neo4j/intellisense/cypher-lsp

Adds scaffolding for publishing #124

Adds scaffolding for publishing #124

Conversation

ncordon commented Oct 23, 2023 • edited Loading

Caveats

CLAassistant commented Oct 23, 2023 • edited Loading

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

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

ncordon commented Oct 23, 2023 •

edited

Loading

CLAassistant commented Oct 23, 2023 •

edited

Loading