Support running the old transformer in timelinetestutil

.husky/pre-commit

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-npm run pre-commit
+npm run pre-commit

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": true,
+  "singleQuote": false
+}

.vscode/launch.json

@@ -4,19 +4,33 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Unit tests",
-            "runtimeExecutable": "npm",
-            "cwd": "${workspaceFolder}/packages/performance-tests/",
-            "runtimeArgs": [
-              "run",
-              "test-mocha"
-            ],
-            "skipFiles": [
-              "<node_internals>/**"
-            ]
-          }
+      {
+        "type": "node",
+        "request": "launch",
+        "name": "Regression tests",
+        "runtimeExecutable": "npm",
+        "cwd": "${workspaceFolder}/packages/performance-tests/",
+        "runtimeArgs": [
+          "run",
+          "test-mocha"
+        ],
+        "skipFiles": [
+          "<node_internals>/**"
+        ]
+      },
+      {
+        "type": "node",
+        "request": "launch",
+        "name": "Unit tests",
+        "runtimeExecutable": "npm",
+        "cwd": "${workspaceFolder}/packages/transformer/",
+        "runtimeArgs": [
+          "run",
+          "test"
+        ],
+        "skipFiles": [
+          "<node_internals>/**"
+        ]
+      }
     ]
 }

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  // "editor.formatOnSave": true, DO NOT TURN THIS ON WITH THE PRETTIER FORMATTER! Known bug with find and replace: https://github.com/prettier/prettier-vscode/issues/3040
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "eslint.experimental.useFlatConfig": true,
+}

change/@itwin-imodel-transformer-04e9e6c3-f30a-4b7f-aa82-cf728ad3965f.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "fed guid optimization test",
+  "packageName": "@itwin/imodel-transformer",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change/@itwin-imodel-transformer-60fe6e88-569a-4c60-b2bf-238eb3ca3d89.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "rerelease again",
+  "packageName": "@itwin/imodel-transformer",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

change/@itwin-imodel-transformer-f333a974-ba76-439f-8059-001157e9a47c.json

@@ -0,0 +1,7 @@
+{
+  "type": "patch",
+  "comment": "revert to original behavior of provenance ExternalSourceAspect version behavior",
+  "packageName": "@itwin/imodel-transformer",
+  "email": "[email protected]",
+  "dependentChangeType": "patch"
+}

eslint.config.js

@@ -0,0 +1,103 @@
+const itwinjsRecommended = require("@itwin/eslint-plugin/dist/configs/itwinjs-recommended");
+const iTwinPlugin = require("@itwin/eslint-plugin");
+const prettier = require("eslint-config-prettier/prettier");
+
+module.exports = [
+    {
+        files: ["**/*.ts"],
+        ...iTwinPlugin.configs.iTwinjsRecommendedConfig,
+    },
+    {
+        files: ["**/*.ts"],
+        rules: {
+            "@itwin/no-internal": [
+              "warn",
+              {
+                tag: ["internal"],
+              },
+            ],
+            "@typescript-eslint/naming-convention": [
+              ...itwinjsRecommended.rules["@typescript-eslint/naming-convention"],
+              {
+                selector: "objectLiteralProperty",
+                format: null,
+                leadingUnderscore: "allowSingleOrDouble", 
+              },
+            ],
+            "@typescript-eslint/indent": ["off"],
+            "@typescript-eslint/dot-notation": [
+              "error",
+              {
+                allowProtectedClassPropertyAccess: true,
+                allowPrivateClassPropertyAccess: true,
+              },
+            ],
+            /** The following set of rules were manually turned off by using the output of 'npx eslint-config-prettier ./src/IModelTransformer.ts' 
+             *  which shows conflicting or unnecessary rules when using eslint + prettier.
+             */
+            "@typescript-eslint/member-delimiter-style": ["off"],
+            "@typescript-eslint/no-extra-semi": ["off"],
+            "@typescript-eslint/semi": ["off"],
+            "@typescript-eslint/space-before-function-paren": ["off"],
+            "@typescript-eslint/type-annotation-spacing": ["off"],
+            "eol-last": ["off"],
+            "max-statements-per-line": ["off"],
+            "new-parens": ["off"],
+            "no-multiple-empty-lines": ["off"],
+            "no-trailing-spaces": ["off"],
+            "nonblock-statement-body-position": ["off"],
+            "quote-props": ["off"],
+            "arrow-parens": ["off"],
+            "brace-style": ["off"],
+            "comma-dangle": ["off"],
+            /** https://github.com/prettier/eslint-config-prettier#special-rules */
+            "@typescript-eslint/quotes": [
+                "error", "double", { "avoidEscape": true, "allowTemplateLiterals": false }
+            ]
+          },
+    },
+    {
+        files: ["**/*.ts"],
+        ...prettier,
+    },
+    {
+        files: ["packages/transformer/**/*.ts"],
+        languageOptions: {
+            parserOptions: {
+                project: "packages/transformer/tsconfig.json",
+                tsconfigRootDir: __dirname
+            },
+            sourceType: "commonjs",
+        }
+    },
+    {
+        files: ["packages/performance-tests/**/*.ts"],
+        rules: {
+            "@typescript-eslint/naming-convention": [
+              ...itwinjsRecommended.rules["@typescript-eslint/naming-convention"],
+              {
+                selector: ["objectLiteralProperty", "typeProperty"],
+                format: null,
+                leadingUnderscore: "allowSingleOrDouble", 
+              },
+            ],
+        },
+        languageOptions: {
+            parserOptions: {
+                project: "packages/performance-tests/tsconfig.json",
+                tsconfigRootDir: __dirname
+            },
+            sourceType: "commonjs",
+        }
+    },
+    {
+        files: ["packages/test-app/**/*.ts"],
+        languageOptions: {
+            parserOptions: {
+                project: "packages/test-app/tsconfig.json",
+                tsconfigRootDir: __dirname
+            },
+            sourceType: "commonjs",
+        }
+    }
+];

package.json

@@ -11,6 +11,7 @@
     "test": "pnpm -r test --filter !transformer-performance-tests",
     "docs": "pnpm -r docs",
     "lint": "pnpm -r lint",
+    "format": "pnpm -r format",
     "cover": "pnpm -r cover",
     "lint:copyright": "node scripts/copyrightLinter.js",
     "change": "beachball change",
@@ -19,18 +20,21 @@
     "version-bump-dev": "beachball bump --config beachball.config.dev.js --keep-change-files",
     "publish-packages": "beachball publish",
     "publish-packages-dev": "beachball publish --config beachball.config.dev.js --keep-change-files",
-    "pre-commit": "lint-staged"
+    "pre-commit": "lint-staged",
+    "prepare": "husky install"
   },
   "license": "MIT",
   "devDependencies": {
     "beachball": "^2.33.3",
     "fast-glob": "^3.2.12",
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.2"
+    "lint-staged": "^13.2.2",
+    "prettier": "^3.1.1"
   },
   "lint-staged": {
     "*.{ts,html}": [
-      "pnpm lint:copyright --fix"
+      "pnpm lint:copyright --fix",
+      "prettier --write -u"
     ]
   },
   "engines": {
@@ -44,6 +48,9 @@
       "typedoc-plugin-merge-modules": "^4.0.1",
       "typescript": "^5.0.2",
       "@typescript-eslint/eslint-plugin": "^5.59.7"
+    },
+    "patchedDependencies": {
+      "@itwin/[email protected]": "patches/@[email protected]"
     }
   }
 }

packages/old-transformer-hack/README.md

@@ -0,0 +1,14 @@
+# old-transformer-hack
+
+## Description
+
+This package exists solely for testing the @itwin/imodel-transformer. It reexports an older version of the iModelTransformer (currently 0.4.4-dev.0) so that iModels can be tested in the transition from old transformer to new transformer (^1.x). 
+
+See packages\transformer\src\test\TestUtils\TimelineTestUtil.ts for its use.
+
+
+`import { IModelTransformer as OldIModelTransformer } from "old-transformer-hack"`;
+
+## Notes
+
+Currently both the old transformer and new transformer work with the same versions of @itwin/core-backend package. This may no longer be true in the future and may require additional changes to support having two versions of the transformer with different versions of itwinjs.

packages/old-transformer-hack/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "old-transformer-hack",
+  "version": "1.0.0",
+  "private": true,
+  "description": "Used to test that behavior of the old transformer is properly transitioned over to the new transformer's behavior",
+  "main": "lib/cjs/oldTransformer.js",
+  "typings": "lib/cjs/oldTransformer",
+  "scripts": {
+    "build": "npm run -s build:cjs && npm run -s copy:test-assets",
+    "build:ci": "npm run -s build",
+    "build:cjs": "tsc 1>&2 --outDir lib/cjs",
+    "clean": "rimraf lib",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "copy:test-assets": "cpx \"./src/test/assets/**/*\" ./lib/cjs/test/assets"
+  },
+  "devDependencies": {
+    "@itwin/imodel-transformer": "0.4.4-dev.0",
+    "@itwin/build-tools": "^4.3.3",
+    "@itwin/core-backend": "^4.3.3",
+    "@itwin/core-bentley": "^4.3.3",
+    "@itwin/core-common": "^4.3.3",
+    "@itwin/core-geometry": "^4.3.3",
+    "@itwin/core-quantity": "^4.3.3",
+    "@itwin/ecschema-metadata": "^4.3.3",
+    "cpx2": "^3.0.2",
+    "typescript": "^5.0.4"
+  },
+  "author": "",
+  "license": "ISC"
+}

packages/old-transformer-hack/src/oldTransformer.ts

@@ -0,0 +1,5 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+ * See LICENSE.md in the project root for license terms and full copyright notice.
+ *--------------------------------------------------------------------------------------------*/
+export { IModelTransformer } from "@itwin/imodel-transformer";

packages/old-transformer-hack/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./node_modules/@itwin/build-tools/tsconfig-base.json",
+    "compilerOptions": {
+      "resolveJsonModule": true,
+      "rootDir": "src"
+    },
+    "include": ["./src/**/*.ts"]
+  }
+

packages/performance-scripts/package.json

@@ -12,12 +12,15 @@
     "build": "tsc -p tsconfig.json",
     "test": "echo \"Error: no tests\" && exit 0"
   },
-  "keywords": ["performance", "profiling"],
+  "keywords": [
+    "performance",
+    "profiling"
+  ],
   "author": "Bentley Systems, Inc.",
   "license": "MIT",
   "devDependencies": {
-    "@itwin/build-tools": "^3.6.0 || ^4.0.0",
-    "@itwin/core-backend": "^3.6.0 || ^4.0.0",
+    "@itwin/build-tools": "4.3.3",
+    "@itwin/core-backend": "4.3.3",
     "@types/node": "^18.11.5",
     "typescript": "~4.4.0"
   }