diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..00adde6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing + +TODO diff --git a/LICENSE b/LICENSE index 61b63e7..1949d63 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2024 Typir +Copyright (c) 2024 TypeFox Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 3028b8e..7cc3d26 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,20 @@ # Typir -A structure for generating validity checks associated with types. \ No newline at end of file +Engineering types for software languages in the web. + +## NPM workspace + +This repository is a NPM workspace. It contains the following packages: + +- [Typir](./packages/typir/README.md) - the core package of Typir +- [Typir-Langium](./packages/typir-langium/README.md) - a integration of Typir for [Langium](https://github.com/eclipse-langium/langium) + +## Contributing + +Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. + +We also have a release process described in [RELEASE.md](./RELEASE.md). + +## License + +[MIT License](/LICENSE) diff --git a/examples/lox/package.json b/examples/lox/package.json index 94253c5..0e1168d 100644 --- a/examples/lox/package.json +++ b/examples/lox/package.json @@ -1,7 +1,7 @@ { "name": "typir-example-lox", "displayName": "lox", - "version": "0.0.1", + "version": "0.0.2", "private": true, "description": "", "author": { @@ -30,7 +30,7 @@ "dependencies": { "commander": "~12.1.0", "langium": "~3.2.0", - "typir-langium": "~0.0.1", + "typir-langium": "~0.0.2", "vscode-languageclient": "~9.0.1", "vscode-languageserver": "~9.0.1" }, diff --git a/examples/ox/package.json b/examples/ox/package.json index 3832547..ddd4404 100644 --- a/examples/ox/package.json +++ b/examples/ox/package.json @@ -1,7 +1,7 @@ { "name": "typir-example-ox", "displayName": "ox", - "version": "0.0.1", + "version": "0.0.2", "private": true, "description": "", "author": { @@ -30,7 +30,7 @@ "dependencies": { "commander": "~12.1.0", "langium": "~3.2.0", - "typir-langium": "~0.0.1", + "typir-langium": "~0.0.2", "vscode-languageclient": "~9.0.1", "vscode-languageserver": "~9.0.1" }, diff --git a/package-lock.json b/package-lock.json index 46970e5..a55b7b4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -36,12 +36,12 @@ }, "examples/lox": { "name": "typir-example-lox", - "version": "0.0.1", + "version": "0.0.2", "license": "MIT", "dependencies": { "commander": "~12.1.0", "langium": "~3.2.0", - "typir-langium": "~0.0.1", + "typir-langium": "~0.0.2", "vscode-languageclient": "~9.0.1", "vscode-languageserver": "~9.0.1" }, @@ -66,12 +66,12 @@ }, "examples/ox": { "name": "typir-example-ox", - "version": "0.0.1", + "version": "0.0.2", "license": "MIT", "dependencies": { "commander": "~12.1.0", "langium": "~3.2.0", - "typir-langium": "~0.0.1", + "typir-langium": "~0.0.2", "vscode-languageclient": "~9.0.1", "vscode-languageserver": "~9.0.1" }, @@ -4069,18 +4069,18 @@ } }, "packages/typir": { - "version": "0.0.1", + "version": "0.0.2", "license": "MIT", "engines": { "node": ">= 18.0.0" } }, "packages/typir-langium": { - "version": "0.0.1", + "version": "0.0.2", "license": "MIT", "dependencies": { "langium": "~3.2.0", - "typir": "~0.0.1" + "typir": "~0.0.2" }, "engines": { "node": ">= 18.0.0" diff --git a/packages/typir-langium/README.md b/packages/typir-langium/README.md new file mode 100644 index 0000000..5659869 --- /dev/null +++ b/packages/typir-langium/README.md @@ -0,0 +1,21 @@ +# Typir integration for Langium + +Typir-Langium is a framework for type checking of languages developed with [Langium](https://langium.org). + +## Installation + +```bash +npm install typir-langium +``` + +## Documentation + +Will follow! + +## Examples + +Look at the examples in the `examples` folder of the repo ([here](../../examples)). There we have some demo projects for you to get started. + +## License + +[MIT License](/LICENSE) diff --git a/packages/typir-langium/package.json b/packages/typir-langium/package.json index ffce4cb..3717ddd 100644 --- a/packages/typir-langium/package.json +++ b/packages/typir-langium/package.json @@ -1,6 +1,6 @@ { "name": "typir-langium", - "version": "0.0.1", + "version": "0.0.2", "description": "Typir binding for Langium", "homepage": "https://typir.org", "author": { @@ -49,6 +49,6 @@ "bugs": "https://github.com/TypeFox/typir/issues", "dependencies": { "langium": "~3.2.0", - "typir": "~0.0.1" + "typir": "~0.0.2" } } diff --git a/packages/typir/README.md b/packages/typir/README.md new file mode 100644 index 0000000..e0beee0 --- /dev/null +++ b/packages/typir/README.md @@ -0,0 +1,21 @@ +# Typir + +Typir is a framework for type systems and type checking in the web. + +## Installation + +```bash +npm install typir +``` + +## Documentation + +Will follow! + +## Examples + +Look at the examples in the `examples` folder of the repo ([here](../../examples)). There we have some demo projects for you to get started. + +## License + +[MIT License](/LICENSE) diff --git a/packages/typir/package.json b/packages/typir/package.json index 7eb7653..83634bb 100644 --- a/packages/typir/package.json +++ b/packages/typir/package.json @@ -1,6 +1,6 @@ { "name": "typir", - "version": "0.0.1", + "version": "0.0.2", "description": "General purpose type checking library", "homepage": "https://typir.org", "author": {