refactor: reorganize dirs (#3683)

Author: aljazerzen

.config/.markdown-link-check-local.json

@@ -1,10 +1,10 @@
 {
   "ignorePatterns": [
     {
-      "_comment_1": "Our pipeline depends only on our assets.",
+      "_comment_1": "Our pipeline should only depend on our assets.",
       "_comment_2": "If some third-party website breaks a link, we cover that in ./.markdown-link-check-all.json",
       "_comment_3": "So this excludes anything that's not a relative link to a file in our repo or a link to our file on the web.",
-      "pattern": "^(?!https://github\\.com/(PRQL|prql)|https://prql-lang\\.org|https://raw\\.githubusercontent\\.com/(PRQL|prql)|[./]+|file://).*$"
+      "pattern": "^(?!https://prql-lang\\.org|https://raw\\.githubusercontent\\.com/(PRQL|prql)|[./]+|file://).*$"
     }
   ]
 }

.config/vscode-recommended/settings.json

@@ -12,6 +12,8 @@
     "**/Thumbs.db": true,
     "web/book/book": true,
     "web/build": true,
-    ".direnv": true
+    ".direnv": true,
+    ".pytest_cache": true,
+    ".mypy_cache": true
   }
 }

.github/.codecov.yml

@@ -2,7 +2,7 @@ comment: false
 
 ignore:
   # Contains code for integration tests which don't run in coverage
-  - "crates/prql-compiler/tests/integration/**"
+  - "prqlc/prql-compiler/tests/integration/**"
 
 coverage:
   status:

.github/actions/build-prql-python/action.yaml

@@ -15,26 +15,28 @@ runs:
       if: inputs.target == 'source'
       with:
         command: sdist
-        args: -o dist -m bindings/prql-python/Cargo.toml
+        args: -o target/python -m prqlc/bindings/python/Cargo.toml
     - uses: messense/maturin-action@v1
       if: runner.os == 'Linux' && inputs.target != 'source'
       with:
         target: ${{ inputs.target }}
         manylinux: auto
         command: build
-        args: --release -o dist -m bindings/prql-python/Cargo.toml
+        args: --release -o target/python -m prqlc/bindings/python/Cargo.toml
     - uses: messense/maturin-action@v1
       if: runner.os == 'Windows' && inputs.target != 'source'
       with:
         command: build
-        args: --release -o dist -m bindings/prql-python/Cargo.toml
+        args: --release -o target/python -m prqlc/bindings/python/Cargo.toml
     - uses: messense/maturin-action@v1
       if: runner.os == 'macOS' && inputs.target != 'source'
       with:
         command: build
-        args: --release -o dist --universal2 -m bindings/prql-python/Cargo.toml
+        args:
+          --release -o target/python --universal2 -m
+          prqlc/bindings/python/Cargo.toml
     - name: Upload wheels
       uses: actions/upload-artifact@v3
       with:
         name: wheels
-        path: dist
+        path: target/python

.github/actions/build-prqlc/action.yaml

@@ -75,7 +75,7 @@ runs:
         export ARTIFACT_NAME="prqlc-v${{ github.ref_type == 'tag' && github.ref_name || 0 }}-${{ matrix.target }}.tar.gz"
         echo "ARTIFACT_NAME=${ARTIFACT_NAME}" >>"$GITHUB_ENV"
         cd target/${{ matrix.target }}/${{ inputs.profile == 'release' && 'release' || 'debug' }}
-        tar czf "../../../${ARTIFACT_NAME}" prqlc ../../../LICENSE -C ../../../crates/prqlc/ README.md
+        tar czf "../../../${ARTIFACT_NAME}" prqlc ../../../LICENSE ../../../prqlc/prqlc/README.md
 
     - name: Create artifact for Windows
       shell: bash
@@ -84,7 +84,7 @@ runs:
         export ARTIFACT_NAME="prqlc-v${{ github.ref_type == 'tag' && github.ref_name || 0 }}-${{ matrix.target }}.zip"
         echo "ARTIFACT_NAME=${ARTIFACT_NAME}" >>"$GITHUB_ENV"
         cd target/${{ matrix.target }}/${{ inputs.profile == 'release' && 'release' || 'debug' }}
-        7z a "../../../${ARTIFACT_NAME}" prqlc.exe ../../../LICENSE ../../../crates/prqlc/README.md
+        7z a "../../../${ARTIFACT_NAME}" prqlc.exe ../../../LICENSE ../../../prqlc/prqlc/README.md
 
     - name: Upload prqlc
       uses: actions/upload-artifact@v3

.github/dependabot.yml

@@ -22,7 +22,7 @@ updates:
       prefix: "chore: "
 
   - package-ecosystem: "npm"
-    directory: "/bindings/prql-js"
+    directory: "/prqlc/bindings/js"
     schedule:
       interval: daily
     ignore:

.github/workflows/release.yaml

@@ -86,7 +86,7 @@ jobs:
       - name: 📂 Checkout code
         uses: actions/checkout@v4
       - name: 👷 Build prql-compiler
-        run: cargo build --release
+        run: cargo build --release -p prqlc
       - name: Copy files into .deb package
         run: |
           mkdir -p .debpkg/usr/bin
@@ -143,7 +143,7 @@ jobs:
       - name: 📂 Checkout code
         uses: actions/checkout@v4
       - name: Move Snap to project root directory
-        run: cp -r packages/snap/ .
+        run: cp -r prqlc/packages/snap/ .
       - name: 📦 Build Snap
         id: build
         uses: snapcore/action-build@v1
@@ -211,7 +211,7 @@ jobs:
       - run:
           npm publish ${{ (github.event_name != 'release') && '--dry-run' || ''
           }}
-        working-directory: bindings/prql-js/
+        working-directory: prqlc/bindings/js/
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
@@ -223,12 +223,12 @@ jobs:
       - uses: baptiste0928/cargo-install@v2
         with:
           crate: cargo-release
-      # Currently, we can only check prql-ast which is not dependent other local crates with --dry-run.
+      # Currently, we can only check prqlc-ast which is not dependent other local crates with --dry-run.
       # https://github.com/crate-ci/cargo-release/issues/691
       # --no-verify is required to prevent build.
       - run:
           cargo release publish --no-confirm ${{ github.event_name == 'release'
-          && '--execute' || '--no-verify --package prql-ast'}}
+          && '--execute' || '--no-verify --package prqlc-ast'}}
         env:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 

.github/workflows/test-clib.yaml

@@ -0,0 +1,39 @@
+name: test-clib
+
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  test-clib:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📂 Checkout code
+        uses: actions/checkout@v4
+      - run: ./.github/workflows/scripts/set_version.sh
+      - name: 💰 Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          prefix-key: ${{ env.version }}
+          save-if: ${{ github.ref == 'refs/heads/main' }}
+          shared-key: lib
+      - name: Build
+        uses: richb-hanover/[email protected]
+        with:
+          command: build
+          # Currently requires a release build; would be useful to allow a debug build.
+          args: --release --package prqlc-clib
+      - name: Run example minimal-c
+        working-directory: prqlc/bindings/clib/examples/minimal-c
+        run: make run
+      - name: Run example minimal-cpp
+        working-directory: prqlc/bindings/clib/examples/minimal-cpp
+        run: make run
+
+      - name: 🔧 Setup Zig
+        uses: goto-bus-stop/setup-zig@v2
+        with:
+          cache: false
+      - name: Run example minimal-zig
+        working-directory: prqlc/bindings/clib/examples/minimal-zig
+        run: make run test

.github/workflows/test-dotnet.yaml

@@ -10,17 +10,16 @@ jobs:
     steps:
       - name: 📂 Checkout code
         uses: actions/checkout@v4
-      - name: 🏗 Build prql-lib
-        run: cargo build
-        working-directory: bindings/prql-lib
+      - name: 🏗 Build prqlc-clib
+        run: cargo build --package prqlc-clib
       - name: 🔧 Setup dotnet
         uses: actions/setup-dotnet@v3
         with:
           dotnet-version: 7
       - name: 🧪 Build and test
-        working-directory: bindings
+        working-directory: prqlc/bindings
         run: |
-          dotnet build prql-dotnet
-          cp ../target/debug/libprql_lib.* prql-dotnet/PrqlCompiler/bin/Debug/net*/
-          cp ../target/debug/libprql_lib.* prql-dotnet/PrqlCompiler.Tests/bin/Debug/net*/
-          dotnet test prql-dotnet
+          dotnet build dotnet
+          cp ../../target/debug/libprqlc.* dotnet/PrqlCompiler/bin/Debug/net*/
+          cp ../../target/debug/libprqlc.* dotnet/PrqlCompiler.Tests/bin/Debug/net*/
+          dotnet test dotnet

.github/workflows/test-elixir.yaml

@@ -14,7 +14,7 @@ on:
 
 defaults:
   run:
-    working-directory: bindings/prql-elixir
+    working-directory: prqlc/bindings/elixir
 
 env:
   MIX_ENV: test
@@ -53,7 +53,7 @@ jobs:
         env:
           cache-name: cache-elixir-deps
         with:
-          path: prql-elixir/deps
+          path: elixir/deps
           key:
             ${{ runner.os }}-mix-${{ env.cache-name }}-${{
             hashFiles('**/mix.lock') }}
@@ -69,7 +69,7 @@ jobs:
         env:
           cache-name: cache-compiled-build
         with:
-          path: prql-elixir/_build
+          path: elixir/_build
           key:
             ${{ runner.os }}-mix-${{ env.cache-name }}-${{
             hashFiles('**/mix.lock') }}

.github/workflows/test-java.yaml

@@ -29,5 +29,5 @@ jobs:
           save-if: ${{ github.ref == 'refs/heads/main' }}
           shared-key: lib
       - name: Maven test
-        working-directory: bindings/prql-java/java/
+        working-directory: prqlc/bindings/java/java/
         run: ./mvnw test

.github/workflows/test-js.yaml

@@ -53,4 +53,4 @@ jobs:
           save-if: false
 
       - run: npm cit
-        working-directory: bindings/prql-js
+        working-directory: prqlc/bindings/js

.github/workflows/test-lib.yaml

@@ -28,7 +28,7 @@ jobs:
       - uses: actions/download-artifact@v3
         with:
           name: wheels
-          path: dist
+          path: target/python
       - uses: actions/setup-python@v4
         with:
           python-version: "3.7"
@@ -47,4 +47,4 @@ jobs:
             hashFiles('prql-python/requirements.txt') }}
       - name: Run tests and typing
         shell: bash
-        run: nox -s tests typing -f bindings/prql-python/noxfile.py
+        run: nox -s tests typing -f prqlc/bindings/python/noxfile.py

.github/workflows/test-python.yaml

@@ -78,7 +78,7 @@ jobs:
           steps.cache.outputs.cache-hit == 'false' }}
       - name: Run docker compose
         run: docker compose up -d
-        working-directory: ./crates/prql-compiler/tests/integration
+        working-directory: ./prqlc/prql-compiler/tests/integration
         if: ${{ contains(inputs.features, 'test-dbs-external') }}
       - name: Wait for database
         uses: ifaxity/[email protected]