xq - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #llm #rust #deep-learning #linux #nodejs #macos #cli #kubernetes #awesome-list #pytorch #mcp #openai

xq

(★ 400)

Pure rust implementation of jq

파일 탐색기

최종 버전 다운로드 (.zip)

- - cd.yml
  - ci.yml
- prelude.rs
- - .gitignore
  - build.rs
  - Cargo.toml
- - xq.rs
- .gitignore
- Cargo.lock
- Cargo.toml
- README.md
- rust-toolchain.toml
- - main.rs
- - compiler.rs
  - mod.rs
- - mod.rs
- - binary.rs
  - comparator.rs
  - index.rs
  - math.rs
  - mod.rs
  - path.rs
  - regex.rs
  - string.rs
  - time.rs
  - unary.rs
- - bytecode.rs
  - error.rs
  - machine.rs
  - mod.rs
- lib.rs
- module_loader.rs
- number.rs
- util.rs
- value.rs
- - color_output.stdout
  - color_output.toml
  - fail_compact_yaml_output.toml
  - fail_raw_input_json.toml
  - fail_raw_yaml_output.toml
  - no_color_and_color.stdout
  - no_color_and_color.toml
  - null_input.toml
  - null_slurp.toml
  - raw_compact_output.toml
  - raw_input.toml
  - raw_input_slurp.toml
  - raw_output.toml
  - yaml_input.toml
  - yaml_output.toml
- - mod.rs
- - mod.rs
- - advanced_features.rs
  - arithmetic.rs
  - assignment.rs
  - basic_filters.rs
  - condition_and_comparison.rs
  - functions.rs
  - mod.rs
  - regex.rs
  - string_format.rs
  - time.rs
  - types_and_values.rs
- - assignments.rs
  - math.rs
  - mod.rs
  - regex.rs
- cli_tests.rs
- lib.rs
.envrc
.gitignore
about.hbs
about.toml
build.rs
Cargo.lock
Cargo.toml
flake.lock
flake.nix
LICENSE
prelude.jq
README.md
release.toml
rustfmt.toml

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/MiSawa/xq

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd xq

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Rust

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Rust (rustup) rustup으로 설치하면 cargo도 함께 설치됩니다.

$ cargo install xq

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ cargo install --path path-to-cloned-dir

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ cat whatever.json | cargo run -- 'query goes here'

빌드 후 바로 실행까지 진행합니다.

$ cargo uninstall xq

이 명령어를 터미널에 그대로 입력해 실행하세요.

$ cargo release patch # to dry-run the release

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ cargo build가 에러 없이 끝나면 성공입니다. target/ 폴더에 실행 파일이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![CI](https://github.com/MiSawa/xq/actions/workflows/ci.yml/badge.svg)](https://github.com/MiSawa/xq/actions/workflows/ci.yml) [![crates.io](https://img.shields.io/crates/v/xq.svg)](https://crates.io/crates/xq)

# XQ

[JQ](https://stedolan.github.io/jq/) reimplemented purely in Rust.

## Caution
This program is under development. You probably want to use the original implementation of [jq](https://jqlang.github.io/jq/), or pure Go implementation of it called [gojq](https://github.com/itchyny/gojq/) built by [itchyny](https://github.com/itchyny) instead, or another Rust implementation called [jaq](https://github.com/01mf02/jaq).

## Current state
- Most of the jq components that require syntactical support are, hmm, implemented and tested against queries taken from the [jq user manual](https://jqlang.github.io/jq/manual/).
  Exceptions are imports and module headers.
- Many builtin functions are missing, include those require intrinsic implementation.
- Need more unit tests. Most of the CLI options are missing.
- JSON and YAML formats are supported.

## Goals
- Learn jq.

## Ideas
- Since we use [serde](https://github.com/serde-rs/serde) to deserialize input / serialize output,
  we should be able to support any format which has serde implementation (and has multi-document support) without too much effort, except those require scheme (protobuf, thrift, etc.).

- As a library, we should be able to make anything that implements `Serialize` as the input type, and anything implements `Deserialize` as the output type.
  So in theory, we should be able to write a library that can handle following;
  ```rust
  #[derive(Serialize)]
  struct GitHubRepo {
      user_name: String,
      repo_name: String,
      stars: usize,
  }
  #[derive(Deserialize)]
  struct User {
      name: String,
      total_stars: usize,
  }
  let repos: Vec<GitHubRepo> = fetch_repos();
  let users: Vec<User> = xq::somefunction_slurp<GitHubRepo, User>(repos, r#"
      group_by(.user_name)[]
      | { name: .[0].user_name, total_stars: ([.[].stars] | add) }
  "#).collect();
  ```
  I mean, it's not something that one should really use. It's just something possible and interesting... isn't it?

## Install and run
Are you sure you want to use this??? It's not a daily-usable stage. Though if you want to try, you can install it via
```shell
$ cargo install xq
$ cat whatever.json | xq 'query goes here'
```
. If you'd rather want to download a pre-built binary, either download it manually from [the latest release](https://github.com/MiSawa/xq/releases/latest), or use [cargo-binstall](https://github.com/ryankurte/cargo-binstall). Either way, the license texts of the dependencies are in `about.html` file in the downloaded archive.

You can also clone this repository to your local and run
```shell
$ cargo install --path path-to-cloned-dir
$ cat whatever.json | xq 'query goes here'
```
.  Alternatively,
```shell
$ cat whatever.json | cargo run -- 'query goes here'
```
in the cloned directory to try out them without installing.

## Uninstall
```shell
$ cargo uninstall xq
```
if you've installed via `cargo install`. Also remove the cloned directory if you've cloned the repository.

## Publish new version
Note for myself.
```shell
$ git switch master                 # make sure you're on the master branch
$ cargo release patch               # to dry-run the release
$ cargo release patch --execute     # to actually execute the release
```
Pass `--workspace` to publish workspace members as well.

## Acknowledgements
- Although this isn't a direct translation at all, I referred to [jq](https://jqlang.github.io/jq/) built by [Stephen Dolan](https://github.com/stedolan) and [gojq](https://github.com/itchyny/gojq/) built by [itchyny](https://github.com/itchyny). Thank you for the interesting product!

## Credits
- Test cases in [tests/from_manual](./tests/from_manual) are taken from the [jq user manual](https://jqlang.github.io/jq/manual/), distributed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/), Copyright (C) 2012 Stephen Dolan. Please refer to [mod.rs](./tests/from_manual/mod.rs) there for more detail.

## Author
[Mi_Sawa](https://github.com/MiSawa)

## LICENSE
MIT. Please refer to [LICENSE](./LICENSE) file.