chore(compas-convert): init package

Signed-off-by: Dirk de Visser <[email protected]>

Author: dirkdev98

README.md

@@ -26,6 +26,8 @@ This repository is set up as a monorepo. All individual packages are set up with
 test and lint setups. The workspace root maintains the below scripts to run them across
 all packages in the workspace.
 
+Development requires Node.js 22+ & NPM 10+.
+
 ```shell
 # Install dependencies
 npm install

packages/compas-convert/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Lightbase B.V
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/compas-convert/README.md

@@ -0,0 +1,38 @@
+# Compas convert
+
+Convert Compas code-bases to TypeScript and beyond.
+
+## Context
+
+We want to migrate all active projects to TypeScript. Allowing us to use migrate to
+TypeScript powered libraries like Zod and Drizzle ORM to replace Compas.
+
+## Goals
+
+- Backwards compatibility; everything runs in production. We should be able to push the
+  output of this tool, feature-freeze for a week to execute manual testing and then use
+  our normal processes like nothing happened.
+- Completeness; we would rather spend a few extra weeks polishing the output of this tool,
+  than to have to do that work later across all projects manually.
+- DX; the developer experience on the converted projects should be better or the same. For
+  example, including the migration to Vitest in this tool will enable us to finally have
+  IDE support for tests in our projects.
+- Source-to-source; we will only change things in the project structure if it makes sense
+  for the new tools.
+
+## TODO
+
+- [ ] Fully implement the 'compas-compat' target in
+      [open-api-code-gen](../open-api-code-gen).
+- [ ] Pre-condition: verify project uses '@lightbase/eslint-config'
+- [ ] Pre-condition: verify project uses Compas
+- [ ] Initial: remove jsconfig + setup tsconfig
+- [ ] Initial: copy (almost) all files, renaming them to `.ts`
+- [ ] Pass: function doc blocks to inline types
+- [ ] Pass: @compas/test to Vitest
+- [ ] Pass: inline JSDoc blocks to inline types
+- [ ] Pass: common issues
+  - Run TypeScript and find common errors
+- [ ] Pass: build step. Fixup CI, Dockerfile, docs, etc
+- [ ] Pass: Generator compatibility. Create / improve Compas Typescript targets for
+      tighter integrations.

packages/compas-convert/eslint.config.js

@@ -0,0 +1,3 @@
+import { defineConfig } from "@lightbase/eslint-config";
+
+export default defineConfig({});

packages/compas-convert/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@lightbase/compas-convert",
+	"version": "0.0.1",
+	"description": "Convert Compas code-bases to TypeScript and beyond",
+	"type": "module",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/lightbasenl/platforms/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/lightbasenl/platforms.git",
+		"directory": "packages/compas-convert"
+	},
+	"exports": {
+		".": {
+			"import": "./dist/src/index.js"
+		}
+	},
+	"main": "./dist/src/index.js",
+	"types": "./dist/src/index.d.ts",
+	"files": ["README.md", "LICENSE", "dist/src"],
+	"scripts": {
+		"build": "tsc -p ./tsconfig.json",
+		"lint": "eslint . --fix --cache --cache-strategy content --cache-location .cache/eslint/ --color",
+		"lint:ci": "eslint .",
+		"test": "vitest",
+		"clean": "rm -rf ./.cache ./dist"
+	},
+	"dependencies": {},
+	"devDependencies": {}
+}

packages/compas-convert/src/index.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+export const foo = 5;

packages/compas-convert/tsconfig.json

@@ -0,0 +1,7 @@
+{
+	"extends": "@total-typescript/tsconfig/tsc/no-dom/library-monorepo",
+	"compilerOptions": {
+		"outDir": "dist"
+	},
+	"include": ["**/*"]
+}

packages/open-api-code-gen/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lightbase/open-api-code-gen",
-	"version": "0.2.2",
+	"version": "0.0.1",
 	"description": "Generate evolving API clients from OpenAPI specs",
 	"type": "module",
 	"license": "MIT",