mirror of
https://github.com/nushell/nushell.git
synced 2024-12-23 07:30:13 +01:00
3d5f853b03
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> The [nushell/demo](https://github.com/nushell/demo) project successfully demonstrated running Nushell in the browser using WASM. However, the current version of Nushell cannot be easily built for the `wasm32-unknown-unknown` target, the default for `wasm-bindgen`. This PR introduces initial support for the `wasm32-unknown-unknown` target by disabling OS-dependent features such as filesystem access, IO, and platform/system-specific functionality. This separation is achieved using a new `os` feature in the following crates: - `nu-cmd-lang` - `nu-command` - `nu-engine` - `nu-protocol` The `os` feature includes all functionality that interacts with an operating system. It is enabled by default, but can be disabled using `--no-default-features`. All crates that depend on these core crates now use `--no-default-features` to allow compilation for WASM. To demonstrate compatibility, the following script builds all crates expected to work with WASM. Direct user interaction, running external commands, working with plugins, and features requiring `openssl` are out of scope for now due to their complexity or reliance on C libraries, which are difficult to compile and link in a WASM environment. ```nushell [ # compatible crates "nu-cmd-base", "nu-cmd-extra", "nu-cmd-lang", "nu-color-config", "nu-command", "nu-derive-value", "nu-engine", "nu-glob", "nu-json", "nu-parser", "nu-path", "nu-pretty-hex", "nu-protocol", "nu-std", "nu-system", "nu-table", "nu-term-grid", "nu-utils", "nuon" ] | each {cargo build -p $in --target wasm32-unknown-unknown --no-default-features} ``` ## Caveats This PR has a few caveats: 1. **`miette` and `terminal-size` Dependency Issue** `miette` depends on `terminal-size`, which uses `rustix` when the target is not Windows. However, `rustix` requires `std::os::unix`, which is unavailable in WASM. To address this, I opened a [PR](https://github.com/eminence/terminal-size/pull/68) for `terminal-size` to conditionally compile `rustix` only when the target is Unix. For now, the `Cargo.toml` includes patches to: - Use my forked version of `terminal-size`. - ~~Use an unreleased version of `miette` that depends on `terminal-size@0.4`.~~ These patches are temporary and can be removed once the upstream changes are merged and released. 2. **Test Output Adjustments** Due to the slight bump in the `miette` version, one test required adjustments to accommodate minor formatting changes in the error output, such as shifted newlines. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> This shouldn't break anything but allows using some crates for targeting `wasm32-unknown-unknown` to revive the demo page eventually. # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use toolkit.nu; toolkit test stdlib"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` I did not add any extra tests, I just checked that compiling works, also when using the host target but unselecting the `os` feature. # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. --> ~~Breaking the wasm support can be easily done by adding some `use`s or by adding a new dependency, we should definitely add some CI that also at least builds against wasm to make sure that building for it keep working.~~ I added a job to build wasm. --------- Co-authored-by: Ian Manske <ian.manske@pm.me>
196 lines
6.7 KiB
YAML
196 lines
6.7 KiB
YAML
on:
|
|
pull_request:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
name: continuous-integration
|
|
|
|
env:
|
|
NUSHELL_CARGO_PROFILE: ci
|
|
NU_LOG_LEVEL: DEBUG
|
|
# If changing these settings also change toolkit.nu
|
|
CLIPPY_OPTIONS: "-D warnings -D clippy::unwrap_used -D clippy::unchecked_duration_subtraction"
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.head_ref && github.ref || github.run_id }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
fmt-clippy:
|
|
strategy:
|
|
fail-fast: true
|
|
matrix:
|
|
# Pinning to Ubuntu 20.04 because building on newer Ubuntu versions causes linux-gnu
|
|
# builds to link against a too-new-for-many-Linux-installs glibc version. Consider
|
|
# revisiting this when 20.04 is closer to EOL (April 2025)
|
|
#
|
|
# Using macOS 13 runner because 14 is based on the M1 and has half as much RAM (7 GB,
|
|
# instead of 14 GB) which is too little for us right now. Revisit when `dfr` commands are
|
|
# removed and we're only building the `polars` plugin instead
|
|
platform: [windows-latest, macos-13, ubuntu-20.04]
|
|
|
|
runs-on: ${{ matrix.platform }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4.1.7
|
|
|
|
- name: Setup Rust toolchain and cache
|
|
uses: actions-rust-lang/setup-rust-toolchain@v1.10.1
|
|
|
|
- name: cargo fmt
|
|
run: cargo fmt --all -- --check
|
|
|
|
# If changing these settings also change toolkit.nu
|
|
- name: Clippy
|
|
run: cargo clippy --workspace --exclude nu_plugin_* -- $CLIPPY_OPTIONS
|
|
|
|
# In tests we don't have to deny unwrap
|
|
- name: Clippy of tests
|
|
run: cargo clippy --tests --workspace --exclude nu_plugin_* -- -D warnings
|
|
|
|
- name: Clippy of benchmarks
|
|
run: cargo clippy --benches --workspace --exclude nu_plugin_* -- -D warnings
|
|
|
|
tests:
|
|
strategy:
|
|
fail-fast: true
|
|
matrix:
|
|
platform: [windows-latest, macos-latest, ubuntu-20.04]
|
|
|
|
runs-on: ${{ matrix.platform }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4.1.7
|
|
|
|
- name: Setup Rust toolchain and cache
|
|
uses: actions-rust-lang/setup-rust-toolchain@v1.10.1
|
|
|
|
- name: Tests
|
|
run: cargo test --workspace --profile ci --exclude nu_plugin_*
|
|
- name: Check for clean repo
|
|
shell: bash
|
|
run: |
|
|
if [ -n "$(git status --porcelain)" ]; then
|
|
echo "there are changes";
|
|
git status --porcelain
|
|
exit 1
|
|
else
|
|
echo "no changes in working directory";
|
|
fi
|
|
|
|
std-lib-and-python-virtualenv:
|
|
strategy:
|
|
fail-fast: true
|
|
matrix:
|
|
platform: [ubuntu-20.04, macos-latest, windows-latest]
|
|
py:
|
|
- py
|
|
|
|
runs-on: ${{ matrix.platform }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4.1.7
|
|
|
|
- name: Setup Rust toolchain and cache
|
|
uses: actions-rust-lang/setup-rust-toolchain@v1.10.1
|
|
|
|
- name: Install Nushell
|
|
run: cargo install --path . --locked --no-default-features
|
|
|
|
- name: Standard library tests
|
|
run: nu -c 'use crates/nu-std/testing.nu; testing run-tests --path crates/nu-std'
|
|
|
|
- name: Ensure that Cargo.toml MSRV and rust-toolchain.toml use the same version
|
|
run: nu .github/workflows/check-msrv.nu
|
|
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: "3.10"
|
|
|
|
- name: Install virtualenv
|
|
run: pip install virtualenv
|
|
shell: bash
|
|
|
|
- name: Test Nushell in virtualenv
|
|
run: nu scripts/test_virtualenv.nu
|
|
shell: bash
|
|
|
|
- name: Check for clean repo
|
|
shell: bash
|
|
run: |
|
|
if [ -n "$(git status --porcelain)" ]; then
|
|
echo "there are changes";
|
|
git status --porcelain
|
|
exit 1
|
|
else
|
|
echo "no changes in working directory";
|
|
fi
|
|
|
|
plugins:
|
|
strategy:
|
|
fail-fast: true
|
|
matrix:
|
|
# Using macOS 13 runner because 14 is based on the M1 and has half as much RAM (7 GB,
|
|
# instead of 14 GB) which is too little for us right now.
|
|
#
|
|
# Failure occurring with clippy for rust 1.77.2
|
|
platform: [windows-latest, macos-13, ubuntu-20.04]
|
|
|
|
runs-on: ${{ matrix.platform }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4.1.7
|
|
|
|
- name: Setup Rust toolchain and cache
|
|
uses: actions-rust-lang/setup-rust-toolchain@v1.10.1
|
|
|
|
- name: Clippy
|
|
run: cargo clippy --package nu_plugin_* -- $CLIPPY_OPTIONS
|
|
|
|
- name: Tests
|
|
run: cargo test --profile ci --package nu_plugin_*
|
|
|
|
- name: Check for clean repo
|
|
shell: bash
|
|
run: |
|
|
if [ -n "$(git status --porcelain)" ]; then
|
|
echo "there are changes";
|
|
git status --porcelain
|
|
exit 1
|
|
else
|
|
echo "no changes in working directory";
|
|
fi
|
|
|
|
build-wasm:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4.1.7
|
|
|
|
- name: Setup Rust toolchain and cache
|
|
uses: actions-rust-lang/setup-rust-toolchain@v1.10.1
|
|
|
|
- name: Add wasm32-unknown-unknown target
|
|
run: rustup target add wasm32-unknown-unknown
|
|
|
|
- run: cargo build -p nu-cmd-base --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-cmd-extra --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-cmd-lang --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-color-config --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-command --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-derive-value --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-engine --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-glob --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-json --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-parser --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-path --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-pretty-hex --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-protocol --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-std --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-system --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-table --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-term-grid --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nu-utils --no-default-features --target wasm32-unknown-unknown
|
|
- run: cargo build -p nuon --no-default-features --target wasm32-unknown-unknown
|