Merge branch 'main' into rfc-0016-instances-vs-types

jvalue · Feb 23, 2024 · 86d0f5a · 86d0f5a
2 parents e7a2ed1 + 0e505f2
commit 86d0f5a
Show file tree

Hide file tree

Showing 32 changed files with 147 additions and 29 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -44,3 +44,11 @@ jobs:
 
       - name: Test
         run: npx nx affected --target=test --parallel=3 --base=remotes/origin/main --head=HEAD --ci
+
+      # Ensure this works for future release publishing
+      - name: Publish Dry-Run
+        run: npx nx affected --target=pre-publish --parallel=3 --base=remotes/origin/main --head=HEAD --ci
+
+      # Ensure this works for future release publishing
+      - name: Pack VSCode Extension
+        run: npx nx run vs-code-extension:pack:prod
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@ SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
 SPDX-License-Identifier: AGPL-3.0-only
 -->
 
+![Jayvee Mascot](./assets/mascot1.png)
+
 # Jayvee
 
 Jayvee is a domain-specific language (DSL) for automated processing of data pipelines.

diff --git a/apps/docs/docs/dev/01-intro.md → apps/docs/docs/dev/01-intro.mdx b/apps/docs/docs/dev/01-intro.md → apps/docs/docs/dev/01-intro.mdx
@@ -4,6 +4,18 @@ sidebar_position: 1
 
 # Introduction for Jayvee Developers
 
+import MascotImageUrl from '@site/static/img/mascots/mascot3.png';
+
+<div style={{ display: 'flex', flexDirection: 'row', flexWrap: 'none', alignItems: 'center'}}>
+  <div>
+    <img src={MascotImageUrl} width="400px" style={{ float: 'left' }} />
+  </div>
+
+  <span className={"text--center"}>
+    <h2>"On the tracks of Jayvee's internals"</h2>
+  </span>
+</div>
+
 ## How to contribute
 
 In order to contribute to the Jayvee project, please have a look at our [contribution guide](https://github.com/jvalue/jayvee/blob/main/CONTRIBUTING.md). Before planning a contribution, please read the [design principles](./05-design-principles.md) and consider if your changes fit the vision expressed there.

diff --git a/apps/docs/docs/dev/01-intro.md.license → apps/docs/docs/dev/01-intro.mdx.license b/apps/docs/docs/dev/01-intro.md.license → apps/docs/docs/dev/01-intro.mdx.license
diff --git a/apps/docs/docs/user/intro/intro.md → apps/docs/docs/user/intro/intro.mdx b/apps/docs/docs/user/intro/intro.md → apps/docs/docs/user/intro/intro.mdx
@@ -5,6 +5,18 @@ title: Getting Started
 
 # Introduction to Jayvee
 
+import MascotImageUrl from '@site/static/img/mascots/mascot2.png';
+
+<div style={{ display: 'flex', flexDirection: 'row', flexWrap: 'none', alignItems: 'center'}}>
+  <div>
+    <img src={MascotImageUrl} width="400px" style={{ float: 'left' }} />
+  </div>
+
+  <span className={"text--center"}>
+    <h2>"Making data engineering easy, reliable, and safe"</h2>
+  </span>
+</div>
+
 Jayvee is a domain-specific language (DSL) for automated processing of data pipelines.
 The Jayvee interpreter allows executing such data pipelines on local machines.
 Data engineers can use Jayvee and its interpreter to clean and preprocess data for later activities like data science or machine learning.

diff --git a/apps/docs/docs/user/intro/intro.md.license → apps/docs/docs/user/intro/intro.mdx.license b/apps/docs/docs/user/intro/intro.md.license → apps/docs/docs/user/intro/intro.mdx.license
diff --git a/apps/docs/src/pages/index.tsx b/apps/docs/src/pages/index.tsx
@@ -9,42 +9,43 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import Layout from '@theme/Layout';
 import HomepageFeatures from '@site/src/components/HomepageFeatures';
 
+import MascotImageUrl from '@site/static/img/mascots/mascot1.png';
+
 import styles from './index.module.css';
 
 function HomepageHeader() {
   return (
     <div>
-      <TitleBanner/>
+      <TitleBanner />
     </div>
   );
 }
 
-
 function TitleBanner(): JSX.Element {
   return (
     <header className={clsx('hero hero--primary', styles.titleBanner)}>
       <div className="container">
         <div className={styles.titleBannerTitle}>
-          🥳 
-          <span className={styles.titleBannerTitleText}><b>Jayvee</b>'s alpha is now available!</span>
+          🥳
+          <span className={styles.titleBannerTitleText}>
+            <b>Jayvee's</b> Alpha is now available!
+          </span>
           🎉
         </div>
 
         <div className={styles.titleBannerTagline}>
-          A <b>domain-specific language</b> for everyone to <b>participate</b> in building <b>data pipelines</b>!
+          A <b>domain-specific language</b> for everyone to <b>participate</b>{' '}
+          in building <b>data pipelines</b>!
         </div>
 
         <div className={styles.titleBannerButtons}>
-          <Link
-            className="button button--primary"
-            to="/docs/user/intro"
-          >
+          <span className="mascot-container">
+            <img src={MascotImageUrl} width="120px" />
+          </span>
+          <Link className="button button--primary" to="/docs/user/intro">
             Get Started
           </Link>
-          <Link
-            className="button button--info"
-            to="/docs/user/examples/cars"
-          >
+          <Link className="button button--info" to="/docs/user/examples/cars">
             Example
           </Link>
           <span className={styles.titleBannerButtonsGitHubButtonWrapper}>
@@ -59,7 +60,7 @@ function TitleBanner(): JSX.Element {
         </div>
       </div>
     </header>
-  )
+  );
 }
 
 export default function Home(): JSX.Element {

diff --git a/apps/docs/static/img/mascots/mascot1.png b/apps/docs/static/img/mascots/mascot1.png
diff --git a/apps/docs/static/img/mascots/mascot1.png.license b/apps/docs/static/img/mascots/mascot1.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/apps/docs/static/img/mascots/mascot2.png b/apps/docs/static/img/mascots/mascot2.png
diff --git a/apps/docs/static/img/mascots/mascot2.png.license b/apps/docs/static/img/mascots/mascot2.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/apps/docs/static/img/mascots/mascot3.png b/apps/docs/static/img/mascots/mascot3.png
diff --git a/apps/docs/static/img/mascots/mascot3.png.license b/apps/docs/static/img/mascots/mascot3.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/apps/interpreter/project.json b/apps/interpreter/project.json
@@ -48,7 +48,8 @@
         "commands": [
           "node tools/scripts/interpreter/prepend-shebang.mjs interpreter main.js",
           "node tools/scripts/add-package-json-version.mjs interpreter",
-          "node tools/scripts/interpreter/rewrite-version-mainjs.mjs interpreter"
+          "node tools/scripts/interpreter/rewrite-version-mainjs.mjs interpreter",
+          "node tools/scripts/publish.mjs interpreter false" // dry-run
         ],
         "parallel": false
       }
@@ -57,7 +58,7 @@
       "executor": "nx:run-commands",
       "dependsOn": ["pre-publish"],
       "options": {
-        "commands": ["node tools/scripts/publish.mjs interpreter"],
+        "commands": ["node tools/scripts/publish.mjs interpreter true"],
         "parallel": false
       }
     },

diff --git a/apps/language-server-web-worker/project.json b/apps/language-server-web-worker/project.json
@@ -46,15 +46,25 @@
         "jestConfig": "apps/language-server-web-worker/jest.config.ts"
       }
     },
-    "publish": {
+    "pre-publish": {
       "executor": "nx:run-commands",
       "dependsOn": ["build"],
       "options": {
         "commands": [
           // Manually delete all dependencies in package.json because the "externalDependencies": "none" setting in "build" above seems to have no effect on the generated package.json
           "node tools/scripts/delete-dependencies.mjs language-server-web-worker",
           "node tools/scripts/add-package-json-version.mjs language-server-web-worker",
-          "node tools/scripts/publish.mjs language-server-web-worker"
+          "node tools/scripts/publish.mjs language-server-web-worker false" // dry-run
+        ],
+        "parallel": false
+      }
+    },
+    "publish": {
+      "executor": "nx:run-commands",
+      "dependsOn": ["pre-publish"],
+      "options": {
+        "commands": [
+          "node tools/scripts/publish.mjs language-server-web-worker true"
         ],
         "parallel": false
       }

diff --git a/assets/docs-banner.png.license b/assets/docs-banner.png.license
@@ -1,3 +1,7 @@
 SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
 
 SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/assets/mascot1.original.png b/assets/mascot1.original.png
diff --git a/assets/mascot1.original.png.license b/assets/mascot1.original.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/assets/mascot1.png b/assets/mascot1.png
diff --git a/assets/mascot1.png.license b/assets/mascot1.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/assets/mascot2.original.png b/assets/mascot2.original.png
diff --git a/assets/mascot2.original.png.license b/assets/mascot2.original.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/assets/mascot2.png b/assets/mascot2.png
diff --git a/assets/mascot2.png.license b/assets/mascot2.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/assets/mascot3.original.png b/assets/mascot3.original.png
diff --git a/assets/mascot3.original.png.license b/assets/mascot3.original.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/assets/mascot3.png b/assets/mascot3.png
diff --git a/assets/mascot3.png.license b/assets/mascot3.png.license
@@ -0,0 +1,7 @@
+SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg
+
+SPDX-License-Identifier: AGPL-3.0-only
+
+Info: This image is based on a generated image by Midjourney (Basic subscription).
+Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service.
+Date of creation: 2024-02-06
diff --git a/libs/interpreter-lib/project.json b/libs/interpreter-lib/project.json
@@ -32,7 +32,8 @@
       "options": {
         "commands": [
           "node tools/scripts/relax-peer-dependency-versions.mjs interpreter-lib",
-          "node tools/scripts/add-package-json-version.mjs interpreter-lib"
+          "node tools/scripts/add-package-json-version.mjs interpreter-lib",
+          "node tools/scripts/publish.mjs interpreter-lib false" // dry-run
         ],
         "parallel": false
       }
@@ -41,7 +42,7 @@
       "executor": "nx:run-commands",
       "dependsOn": ["pre-publish"],
       "options": {
-        "commands": ["node tools/scripts/publish.mjs interpreter-lib"],
+        "commands": ["node tools/scripts/publish.mjs interpreter-lib true"],
         "parallel": false
       }
     },

diff --git a/libs/language-server/project.json b/libs/language-server/project.json
@@ -49,7 +49,8 @@
       "options": {
         "commands": [
           "node tools/scripts/relax-peer-dependency-versions.mjs language-server",
-          "node tools/scripts/add-package-json-version.mjs language-server"
+          "node tools/scripts/add-package-json-version.mjs language-server",
+          "node tools/scripts/publish.mjs language-server false"
         ],
         "parallel": false
       }
@@ -58,7 +59,7 @@
       "executor": "nx:run-commands",
       "dependsOn": ["pre-publish"],
       "options": {
-        "commands": ["node tools/scripts/publish.mjs language-server"],
+        "commands": ["node tools/scripts/publish.mjs language-server true"],
         "parallel": false
       }
     },

diff --git a/libs/monaco-editor/project.json b/libs/monaco-editor/project.json
@@ -51,7 +51,8 @@
           "node tools/scripts/relax-peer-dependency-versions.mjs monaco-editor",
           "node tools/scripts/monaco-editor/delete-vscode-peer-dependency.mjs monaco-editor",
           "node tools/scripts/monaco-editor/relax-react-version.mjs monaco-editor",
-          "node tools/scripts/add-package-json-version.mjs monaco-editor"
+          "node tools/scripts/add-package-json-version.mjs monaco-editor",
+          "node tools/scripts/publish.mjs monaco-editor false" // dry-run
         ],
         "parallel": false
       }
@@ -60,7 +61,7 @@
       "executor": "nx:run-commands",
       "dependsOn": ["pre-publish"],
       "options": {
-        "commands": ["node tools/scripts/publish.mjs monaco-editor"],
+        "commands": ["node tools/scripts/publish.mjs monaco-editor true"],
         "parallel": false
       }
     },

diff --git a/tools/scripts/publish.mjs b/tools/scripts/publish.mjs
@@ -2,12 +2,14 @@
 //
 // SPDX-License-Identifier: AGPL-3.0-only
 
-import {execSync} from 'child_process';
-import {getOutputPath} from "./shared-util.mjs";
+import { execSync } from 'child_process';
+import { getOutputPath } from './shared-util.mjs';
 
-// Executing this script: node path/to/publish.mjs {projectName}
-const [, , projectName] = process.argv;
+// Executing this script: node path/to/publish.mjs {projectName} {no-dry-run}
+const [, , projectName, isNoDryRun] = process.argv;
+
+const isDryRun = isNoDryRun !== 'true';
 
 const outputPath = getOutputPath(projectName);
 
-execSync(`npm publish ${outputPath}`);
+execSync(`npm publish ${outputPath} ${!isDryRun ? '' : '--dry-run'}`);