Fix publishing with Lerna (#93)

The previous refactor broke the publish workflows. This is an attempt to fix them.

The use of `lerna publish` (which uses `lerna version` behind the scenes) means:
- All packages that have changes will have their version bumped and published
- All packages that have their versions bumped will be bumped to the same version
- All packages will be published as npm packages, even if they don't really need to be (e.g. `packages/extension`, which is really only intended for publishing to VS Code marketplace).

Because the versions of the packages should/will be equal, I've bumped them all up to 0.54.0, which is a minor bump over the highest existing version (extension at 53).

It's very difficult to test, since we have to push to github.com/anz-bank/vscode-sysl first.

Author: orlade-anz

.eslintrc.json

@@ -15,7 +15,7 @@
   },
   "plugins": ["@typescript-eslint"],
   "ignorePatterns": [
-    "out/",
+    "dist/",
     "node_modules/",
     "extension/lsp/utils.ts",
     "extension/lsp/go*.ts",

.github/workflows/npm-publish-model.yaml

@@ -11,10 +11,8 @@ jobs:
   deploy:
     if: ${{ github.repository_owner == 'anz-bank' }}
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: packages/extension
     steps:
       - uses: actions/checkout@v2
       - run: yarn install --frozen-lockfile
       - run: yarn vsce publish -p ${{ secrets.VSCE_TOKEN }}
+        working-directory: packages/extension

.github/workflows/npm-publish-plugin.yaml

@@ -0,0 +1,32 @@
+name: Publish packages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - ".github/**"
+      - "docs/**"
+      - "packages/**"
+
+jobs:
+  publish-to-npm:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+
+      - name: Install packages deps
+        run: yarn install --frozen-lockfile
+
+      - name: Build packages
+        run: yarn lerna run build
+
+      - name: Publish packages
+        if: ${{ github.repository_owner == 'anz-bank' }}
+        run: yarn lerna publish --contents=dist
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/npm-publish-renderer.yaml

@@ -3,10 +3,10 @@
 .vscode-test
 
 # Build
-out
+dist/
 node_modules
 *.vsix
-*error.log
+*.log
 /main.js*
 /sysl
 *.tsbuildinfo

.github/workflows/publish-extension.yaml

@@ -4,7 +4,6 @@ node_modules
 /packages/extension/src/test/screenshots
 
 # Production
-out/
 dist/
 /packages/renderer/build
 main.js*

.github/workflows/publish-packages.yaml

@@ -12,7 +12,7 @@
 				"--extensionDevelopmentPath=${workspaceFolder}/packages/extension"
 			],
 			"outFiles": [
-				"${workspaceFolder}/packages/extension/out/**/*.js",
+				"${workspaceFolder}/packages/extension/dist/**/*.js",
 				"${workspaceFolder}/packages/renderer/build/**",
 			],
 		},
@@ -25,11 +25,11 @@
 				"${workspaceFolder}/packages/extension/test/fixtures/",
 				"--disable-extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}/packages/extension",
-				"--extensionTestsPath=${workspaceFolder}/packages/extension/out/test/ui/index",
+				"--extensionTestsPath=${workspaceFolder}/packages/extension/dist/test/ui/index",
 				"--user-data-dir=${workspaceFolder}/.vscode-test/user-data"
 			],
 			"outFiles": [
-				"${workspaceFolder}/packages/extension/out/test/**/*.js",
+				"${workspaceFolder}/packages/extension/dist/test/**/*.js",
 				"${workspaceFolder}/packages/renderer/build/**"
 			]
 		},

.gitignore

@@ -1,7 +1,12 @@
 {
-  "version": "0.1.0",
+  "version": "0.54.0",
   "useWorkspaces": true,
   "npmClient": "yarn",
-  "packages": ["extension", "model", "plugin", "renderer"],
+  "packages": [
+    "extension",
+    "model",
+    "plugin",
+    "renderer"
+  ],
   "useNx": true
 }

.prettierignore

@@ -3,7 +3,7 @@ module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
   setupFilesAfterEnv: ["jest-extended/all"],
-  modulePathIgnorePatterns: ["dist", "out", "test/ui"],
+  modulePathIgnorePatterns: ["dist", "test/ui"],
   globalSetup: "../../scripts/setup.ts",
   moduleNameMapper: {
     // Help Jest resolve Sysl's subpath package exports.

.vscode/launch.json

@@ -4,7 +4,7 @@
   "description": "Write Sysl specs easily with instant visual feedback.",
   "author": "ANZ Bank",
   "publisher": "anz-bank",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "onCustomEditor:sysld.multiView",
     "workspaceContains:**/*.sysl"
   ],
-  "main": "./out/main.js",
+  "main": "./dist/main.js",
   "contributes": {
     "commands": [
       {
@@ -153,16 +153,16 @@
   },
   "scripts": {
     "vscode:prepublish": "yarn build && yarn build:renderer",
-    "esbuild-base": "esbuild ./src/main.ts --bundle --outfile=out/main.js --external:vscode --external:electron --format=cjs --platform=node",
+    "esbuild-base": "esbuild ./src/main.ts --bundle --outfile=dist/main.js --external:vscode --external:electron --format=cjs --platform=node",
     "esbuild": "npm run esbuild-base -- --sourcemap",
     "esbuild-prod": "npm run esbuild-base -- --minify",
     "prebuild": "yarn install --network-timeout 300000",
     "build": "yarn compile && yarn schema && yarn plugins && yarn build:renderer && yarn esbuild-prod",
-    "build:renderer": "yarn --cwd ../renderer build --network-timeout 300000 && cp -R ../renderer/build/. out/renderer",
+    "build:renderer": "yarn --cwd ../renderer build --network-timeout 300000 && cp -R ../renderer/build/. dist/renderer",
     "compile": "tsc",
-    "esbuild-erd": "esbuild ./src/plugins/erd/index.ts --bundle --outfile=out/plugins/erd/index.js --external:vscode --external:electron --format=cjs --platform=node",
-    "esbuild-integration": "esbuild ./src/plugins/integration/index.ts --bundle --outfile=out/plugins/integration/index.js --external:vscode --external:electron --format=cjs --platform=node",
-    "esbuild-sysld": "esbuild ./src/plugins/sysld/index.ts --bundle --outfile=out/plugins/sysld/index.js --external:vscode --external:electron --format=cjs --platform=node",
+    "esbuild-erd": "esbuild ./src/plugins/erd/index.ts --bundle --outfile=dist/plugins/erd/index.js --external:vscode --external:electron --format=cjs --platform=node",
+    "esbuild-integration": "esbuild ./src/plugins/integration/index.ts --bundle --outfile=dist/plugins/integration/index.js --external:vscode --external:electron --format=cjs --platform=node",
+    "esbuild-sysld": "esbuild ./src/plugins/sysld/index.ts --bundle --outfile=dist/plugins/sysld/index.js --external:vscode --external:electron --format=cjs --platform=node",
     "plugins": "yarn esbuild-erd && yarn esbuild-integration && yarn esbuild-sysld",
     "schema": "yarn schema-ts && yarn schema-go",
     "schema-ts": "json2ts ./src/protocol/plugin.schema.json --output ./src/protocol/plugin.d.ts && yarn prettier --write ./src/protocol/plugin.d.ts",
@@ -172,14 +172,16 @@
     "tidy": "prettier --write .",
     "lint": "eslint . --ext .ts,.tsx",
     "test": "yarn test-unit",
-    "test-ui": "node out/test/runTest",
+    "test-ui": "node dist/test/runTest",
     "test-unit": "yarn jest",
-    "test-watch": "nodemon --watch './**' --ext 'ts,json,sysl' --exec 'ts-node ./src/test/runUnitTest'"
+    "test-watch": "nodemon --watch './**' --ext 'ts,json,sysl' --exec 'ts-node ./src/test/runUnitTest'",
+    "pack": "pack",
+    "prepack": "cp package.json ../../README.md ../../LICENSE dist/ && sed -i'' -e 's|dist/index|index|g' dist/package.json"
   },
   "dependencies": {
     "@anz-bank/sysl": "^0",
-    "@anz-bank/vscode-sysl-model": "*",
-    "@anz-bank/vscode-sysl-plugin": "*",
+    "@anz-bank/vscode-sysl-model": "^0.54.0",
+    "@anz-bank/vscode-sysl-plugin": "^0.54.0",
     "lodash": "^4",
     "memoizee": "^0",
     "semver": "^7",

lerna.json

@@ -52,7 +52,7 @@ class Actions {
       if (doc && doc.uri.fsPath.endsWith(syslExt)) {
         model = await compileDoc(doc, this.sysl!).catch(() => undefined);
       }
-      return commands.executeCommand(action.id, { uri: doc?.uri.toString(), model });
+      await commands.executeCommand(action.id, { uri: doc?.uri.toString(), model });
     });
   }
 
@@ -67,9 +67,9 @@ class Actions {
       actions.map((a) => [`action:${a.id}`, a]),
       ([cmd]) => existing.includes(cmd)
     ) as [[string, Action][], [string, Action][]];
-    if (conflict)
+    if (conflict.length) {
       output.appendLine(`addActions: ignoring existing commands: [${conflict.map(([c]) => c)}]`);
-
+    }
     const disposables = fresh.map(([cmd, a]) => {
       output.appendLine(`adding action ${a.id} (command ${cmd})`);
       this.actions[a.id] = a;

packages/extension/jest.config.js

@@ -8,9 +8,12 @@ import {
 } from "@anz-bank/sysl/model";
 import { DiagramModel, DiagramObjectData } from "../../views/diagram/model";
 
-const notIgnored = (el: Element) => !el.tags.some((t) => t.value === "ignore");
+const notIgnored = (el: Element) => !el.tags.some((t) => t.name === "ignore");
 
-export async function buildModel(model: Model): Promise<DiagramModel> {
+export async function buildModel(model: Model, docUri?: string): Promise<DiagramModel> {
+  if (docUri) {
+    model = model.filterByFile(docUri);
+  }
   const nodes: DiagramObjectData[] = [];
   const edges: DiagramObjectData[] = [];
   const groups: boolean = Object.keys(model.apps).length > 1;
@@ -39,7 +42,13 @@ export async function buildModel(model: Model): Promise<DiagramModel> {
     }
   });
 
-  return { nodes, edges, templates: { diagramLayout: "LayeredDigraphLayout" } };
+  return {
+    nodes,
+    edges,
+    templates: {
+      diagramLayout: "LayeredDigraphLayout",
+    },
+  };
 }
 
 function getChildReferences(type: Type): ElementRef[] {

packages/extension/package.json

@@ -64,5 +64,5 @@ async function buildModelForKey(key: ViewKey): Promise<DiagramModel> {
     throw new Error("must have compiled model to render ERD diagram");
   }
 
-  return { meta: { ...partialMeta, key }, ...(await buildModel(model)) };
+  return { meta: { ...partialMeta, key }, ...(await buildModel(model, key.docUri)) };
 }

packages/extension/src/actions/index.ts

@@ -6,7 +6,7 @@ import { Events } from "../../types";
 const rootPath = path.join(__dirname, "..", "..", "..", "..");
 const pluginPath = path.join(
   rootPath,
-  "out",
+  "dist",
   "plugins",
   "examples",
   "spp-typescript",