From baf585160a064eb64901d52a868a1e97ca802c18 Mon Sep 17 00:00:00 2001 From: tellmeY18 Date: Sat, 5 Aug 2023 23:06:17 +0530 Subject: [PATCH 01/25] Added the Much needed H for Github. --- src/cli.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/cli.rs b/src/cli.rs index 1437677..e1dcdac 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -6,7 +6,7 @@ pub fn build<'a>(selectors: &'a [&str]) -> App<'a> { .about("please use --help for more detailed information") .long_about("trivia on the command line.") .version("0.2.0") - .help_template("{bin}\n{about}\n\n{usage-heading}\n {usage}\n\n{all-args}\n\nversion {version} by {author}\nplease report any bugs to https://gitub.com/PureArtistry/oi/issues") + .help_template("{bin}\n{about}\n\n{usage-heading}\n {usage}\n\n{all-args}\n\nversion {version} by {author}\nplease report any bugs to https://github.com/PureArtistry/oi/issues") .arg(Arg::new("all") .short('a') From 72d0c6a70ddc108fe608251844e1cb6c7cabbd0d Mon Sep 17 00:00:00 2001 From: tellmeY18 Date: Tue, 8 Aug 2023 01:49:06 +0530 Subject: [PATCH 02/25] workflow mebbe ? --- .github/workflows/release.yml | 34 ++++++++++++++++++++++++++++++++++ etc/completions/oi.bash | 0 2 files changed, 34 insertions(+) create mode 100644 .github/workflows/release.yml mode change 100644 => 100755 etc/completions/oi.bash diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..5fb4536 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,34 @@ +name: Release + +on: + push: + tags: + - '*' + +jobs: + publish: + name: Release for ${{ matrix.os }} + runs-on: ${{ matrix.os }} + strategy: + matrix: + include: + - os: ubuntu-latest + artifact_name: rudo + target: x86_64-unknown-linux-gnu + asset_name: rudo-$tag-x86_64-unknown-linux-gnu + - os: macos-latest + artifact_name: rudo + target: x86_64-apple-darwin + asset_name: rudo-$tag-x86_64-apple-darwin + + steps: + - uses: actions/checkout@v2 + - name: Build + run: cargo build --release --locked --target=${{ matrix.target }} && cd target/${{ matrix.target }}/release && tar -czvf ${{ matrix.artifact_name }}.tar.gz rudo + - name: Upload binaries to release + uses: svenstaro/upload-release-action@v2 + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: target/${{ matrix.target }}/release/${{ matrix.artifact_name }}.tar.gz + asset_name: ${{ matrix.asset_name }}.tar.gz + tag: ${{ github.ref }} diff --git a/etc/completions/oi.bash b/etc/completions/oi.bash old mode 100644 new mode 100755 From 69649675048762e4a8a80e62b09bf25e370ebf89 Mon Sep 17 00:00:00 2001 From: tellmeY18 Date: Tue, 8 Aug 2023 01:53:19 +0530 Subject: [PATCH 03/25] Added oi --- .github/workflows/release.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5fb4536..b3ba1e3 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -13,18 +13,18 @@ jobs: matrix: include: - os: ubuntu-latest - artifact_name: rudo + artifact_name: oi target: x86_64-unknown-linux-gnu - asset_name: rudo-$tag-x86_64-unknown-linux-gnu + asset_name: oi-$tag-x86_64-unknown-linux-gnu - os: macos-latest - artifact_name: rudo + artifact_name: oi target: x86_64-apple-darwin - asset_name: rudo-$tag-x86_64-apple-darwin + asset_name: oi-$tag-x86_64-apple-darwin steps: - uses: actions/checkout@v2 - name: Build - run: cargo build --release --locked --target=${{ matrix.target }} && cd target/${{ matrix.target }}/release && tar -czvf ${{ matrix.artifact_name }}.tar.gz rudo + run: cargo build --release --locked --target=${{ matrix.target }} && cd target/${{ matrix.target }}/release && tar -czvf ${{ matrix.artifact_name }}.tar.gz oi - name: Upload binaries to release uses: svenstaro/upload-release-action@v2 with: From 669680dc36c31103b4eee8f21ec218d0f3dfd515 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Tue, 8 Aug 2023 02:09:20 +0530 Subject: [PATCH 04/25] Create rust.yml --- .github/workflows/rust.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/rust.yml diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..31000a2 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,22 @@ +name: Rust + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose From 058b5b1ca3dd5bc50e086b22a4df8fe42319797d Mon Sep 17 00:00:00 2001 From: tellmeY18 Date: Tue, 8 Aug 2023 02:12:02 +0530 Subject: [PATCH 05/25] added workwloww --- .github/workflows/release.yml | 49 +++++++++++++++-------------------- 1 file changed, 21 insertions(+), 28 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b3ba1e3..2e10e7c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,34 +1,27 @@ -name: Release +# .github/workflows/build.yml +name: Build on: push: - tags: - - '*' + branches: [main] jobs: - publish: - name: Release for ${{ matrix.os }} - runs-on: ${{ matrix.os }} - strategy: - matrix: - include: - - os: ubuntu-latest - artifact_name: oi - target: x86_64-unknown-linux-gnu - asset_name: oi-$tag-x86_64-unknown-linux-gnu - - os: macos-latest - artifact_name: oi - target: x86_64-apple-darwin - asset_name: oi-$tag-x86_64-apple-darwin - + build: + name: Build + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Build - run: cargo build --release --locked --target=${{ matrix.target }} && cd target/${{ matrix.target }}/release && tar -czvf ${{ matrix.artifact_name }}.tar.gz oi - - name: Upload binaries to release - uses: svenstaro/upload-release-action@v2 - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: target/${{ matrix.target }}/release/${{ matrix.artifact_name }}.tar.gz - asset_name: ${{ matrix.asset_name }}.tar.gz - tag: ${{ github.ref }} + - uses: actions/checkout@master + - name: Compile + id: compile + uses: rust-build/rust-build.action@v1.4.3 + with: + RUSTTARGET: x86_64-unknown-linux-musl + UPLOAD_MODE: none + - name: Upload artifact + uses: actions/upload-artifact@v3 + with: + name: Binary + path: | + ${{ steps.compile.outputs.BUILT_ARCHIVE }} + ${{ steps.compile.outputs.BUILT_CHECKSUM }} + From 451469fd9f80279627f0e1b1393de661fb0ff4c0 Mon Sep 17 00:00:00 2001 From: tellmeY18 Date: Tue, 8 Aug 2023 02:30:17 +0530 Subject: [PATCH 06/25] thanks to Helix --- .github/workflows/build.yml | 95 ++++++++++++++ .github/workflows/release.yml | 237 +++++++++++++++++++++++++++++++--- Cargo.toml | 5 + 3 files changed, 317 insertions(+), 20 deletions(-) create mode 100644 .github/workflows/build.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..c28a3c3 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,95 @@ +name: Build +on: + pull_request: + push: + branches: + - master + schedule: + - cron: '00 01 * * *' + +jobs: + check: + name: Check + runs-on: ubuntu-latest + steps: + - name: Checkout sources + uses: actions/checkout@v2 + + - name: Install stable toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + + - uses: Swatinem/rust-cache@v1 + + - name: Run cargo check + uses: actions-rs/cargo@v1 + with: + command: check + + test: + name: Test Suite + strategy: + matrix: + os: [ubuntu-latest, macos-latest, windows-latest] + rust: [stable] + runs-on: ${{ matrix.os }} + steps: + - name: Checkout sources + uses: actions/checkout@v2 + + - name: Install stable toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: ${{ matrix.rust }} + override: true + + - uses: Swatinem/rust-cache@v1 + + - name: Run cargo test + uses: actions-rs/cargo@v1 + with: + command: test + + + lints: + name: Lints + runs-on: ubuntu-latest + steps: + - name: Checkout sources + uses: actions/checkout@v2 + with: + submodules: true + + - name: Install stable toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: stable + override: true + components: rustfmt, clippy + + - uses: Swatinem/rust-cache@v1 + + - name: Run cargo fmt + uses: actions-rs/cargo@v1 + with: + command: fmt + args: --all -- --check + + - name: Run cargo clippy + uses: actions-rs/cargo@v1 + with: + command: clippy + args: -- -D warnings + + - name: Run rustdoc lints + uses: actions-rs/cargo@v1 + env: + RUSTDOCFLAGS: "-D missing_docs -D rustdoc::missing_doc_code_examples" + with: + command: doc + args: --workspace --all-features --no-deps --document-private-items diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 2e10e7c..ecf9dd7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,27 +1,224 @@ -# .github/workflows/build.yml -name: Build - +name: Release on: + # schedule: + # - cron: '0 0 * * *' # midnight UTC + push: - branches: [main] + tags: + - 'v[0-9]+.[0-9]+.[0-9]+' + ## - release + +env: + BIN_NAME: bfoot + PROJECT_NAME: bumblefoot + REPO_NAME: spectralops/rust-ci-release-template + BREW_TAP: jondot/homebrew-tap jobs: - build: - name: Build + dist: + name: Dist + runs-on: ${{ matrix.os }} + strategy: + fail-fast: false # don't fail other jobs if one fails + matrix: + build: [x86_64-linux, aarch64-linux, x86_64-macos, x86_64-windows] #, x86_64-win-gnu, win32-msvc + include: + - build: x86_64-linux + os: ubuntu-20.04 + rust: stable + target: x86_64-unknown-linux-gnu + cross: false + - build: aarch64-linux + os: ubuntu-20.04 + rust: stable + target: aarch64-unknown-linux-gnu + cross: true + - build: x86_64-macos + os: macos-latest + rust: stable + target: x86_64-apple-darwin + cross: false + - build: x86_64-windows + os: windows-2019 + rust: stable + target: x86_64-pc-windows-msvc + cross: false + # - build: aarch64-macos + # os: macos-latest + # rust: stable + # target: aarch64-apple-darwin + # - build: x86_64-win-gnu + # os: windows-2019 + # rust: stable-x86_64-gnu + # target: x86_64-pc-windows-gnu + # - build: win32-msvc + # os: windows-2019 + # rust: stable + # target: i686-pc-windows-msvc + + steps: + - name: Checkout sources + uses: actions/checkout@v2 + with: + submodules: true + + - name: Install ${{ matrix.rust }} toolchain + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: ${{ matrix.rust }} + target: ${{ matrix.target }} + override: true + + - name: Run cargo test + uses: actions-rs/cargo@v1 + with: + use-cross: ${{ matrix.cross }} + command: test + args: --release --locked --target ${{ matrix.target }} + + - name: Build release binary + uses: actions-rs/cargo@v1 + with: + use-cross: ${{ matrix.cross }} + command: build + args: --release --locked --target ${{ matrix.target }} + + - name: Strip release binary (linux and macos) + if: matrix.build == 'x86_64-linux' || matrix.build == 'x86_64-macos' + run: strip "target/${{ matrix.target }}/release/$BIN_NAME" + + - name: Strip release binary (arm) + if: matrix.build == 'aarch64-linux' + run: | + docker run --rm -v \ + "$PWD/target:/target:Z" \ + rustembedded/cross:${{ matrix.target }} \ + aarch64-linux-gnu-strip \ + /target/${{ matrix.target }}/release/$BIN_NAME + + - name: Build archive + shell: bash + run: | + mkdir dist + if [ "${{ matrix.os }}" = "windows-2019" ]; then + cp "target/${{ matrix.target }}/release/$BIN_NAME.exe" "dist/" + else + cp "target/${{ matrix.target }}/release/$BIN_NAME" "dist/" + fi + + - uses: actions/upload-artifact@v2.2.4 + with: + name: bins-${{ matrix.build }} + path: dist + + publish: + name: Publish + needs: [dist] runs-on: ubuntu-latest steps: - - uses: actions/checkout@master - - name: Compile - id: compile - uses: rust-build/rust-build.action@v1.4.3 - with: - RUSTTARGET: x86_64-unknown-linux-musl - UPLOAD_MODE: none - - name: Upload artifact - uses: actions/upload-artifact@v3 - with: - name: Binary - path: | - ${{ steps.compile.outputs.BUILT_ARCHIVE }} - ${{ steps.compile.outputs.BUILT_CHECKSUM }} + - name: Checkout sources + uses: actions/checkout@v2 + with: + submodules: false + + - uses: actions/download-artifact@v2 + # with: + # path: dist + # - run: ls -al ./dist + - run: ls -al bins-* + + - name: Calculate tag name + run: | + name=dev + if [[ $GITHUB_REF == refs/tags/v* ]]; then + name=${GITHUB_REF:10} + fi + echo ::set-output name=val::$name + echo TAG=$name >> $GITHUB_ENV + id: tagname + + - name: Build archive + shell: bash + run: | + set -ex + + rm -rf tmp + mkdir tmp + mkdir dist + + for dir in bins-* ; do + platform=${dir#"bins-"} + unset exe + if [[ $platform =~ "windows" ]]; then + exe=".exe" + fi + pkgname=$PROJECT_NAME-$TAG-$platform + mkdir tmp/$pkgname + # cp LICENSE README.md tmp/$pkgname + mv bins-$platform/$BIN_NAME$exe tmp/$pkgname + chmod +x tmp/$pkgname/$BIN_NAME$exe + + if [ "$exe" = "" ]; then + tar cJf dist/$pkgname.tar.xz -C tmp $pkgname + else + (cd tmp && 7z a -r ../dist/$pkgname.zip $pkgname) + fi + done + + - name: Upload binaries to release + uses: svenstaro/upload-release-action@v2 + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: dist/* + file_glob: true + tag: ${{ steps.tagname.outputs.val }} + overwrite: true + + - name: Extract version + id: extract-version + run: | + printf "::set-output name=%s::%s\n" tag-name "${GITHUB_REF#refs/tags/}" + + - uses: mislav/bump-homebrew-formula-action@v1 + with: + formula-path: ${{env.PROJECT_NAME}}.rb + homebrew-tap: ${{ env.BREW_TAP }} + download-url: "https://github.com/${{ env.REPO_NAME }}/releases/download/${{ steps.extract-version.outputs.tag-name }}/${{env.PROJECT_NAME}}-${{ steps.extract-version.outputs.tag-name }}-x86_64-macos.tar.xz" + commit-message: updating formula for ${{ env.PROJECT_NAME }} + env: + COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }} + # + # you can use this initial file in your homebrew-tap if you don't have an initial formula: + # .rb + # + # class < Formula + # desc "A test formula" + # homepage "http://www.example.com" + # url "-----" + # version "-----" + # sha256 "-----" + + # def install + # bin.install "" + # end + # end + + + # Uncomment this section if you want to release your package to crates.io + # Before publishing, make sure you have filled out the following fields: + # license or license-file, description, homepage, documentation, repository, readme. + # Read more: https://doc.rust-lang.org/cargo/reference/publishing.html + + # - name: Install ${{ matrix.rust }} toolchain + # uses: actions-rs/toolchain@v1 + # with: + # profile: minimal + # toolchain: ${{ matrix.rust }} + # target: ${{ matrix.target }} + # - run: cargo publish --token ${CRATES_TOKEN} + # env: + # CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }} + + diff --git a/Cargo.toml b/Cargo.toml index e78ef1c..369b82f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,6 +6,11 @@ edition = "2021" description = "trivia on the command line." # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +[[bin]] +name = "oi" +path = "src/main.rs" + + [dependencies] anyhow = "~1.0" chrono = "~0.4" From 421c1a396b8b387990aab63350d8ec05318b23e0 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Fri, 6 Oct 2023 22:23:35 +0530 Subject: [PATCH 07/25] Delete .github/workflows directory --- .github/workflows/build.yml | 95 -------------- .github/workflows/release.yml | 224 ---------------------------------- .github/workflows/rust.yml | 22 ---- 3 files changed, 341 deletions(-) delete mode 100644 .github/workflows/build.yml delete mode 100644 .github/workflows/release.yml delete mode 100644 .github/workflows/rust.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index c28a3c3..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,95 +0,0 @@ -name: Build -on: - pull_request: - push: - branches: - - master - schedule: - - cron: '00 01 * * *' - -jobs: - check: - name: Check - runs-on: ubuntu-latest - steps: - - name: Checkout sources - uses: actions/checkout@v2 - - - name: Install stable toolchain - uses: actions-rs/toolchain@v1 - with: - profile: minimal - toolchain: stable - override: true - - - uses: Swatinem/rust-cache@v1 - - - name: Run cargo check - uses: actions-rs/cargo@v1 - with: - command: check - - test: - name: Test Suite - strategy: - matrix: - os: [ubuntu-latest, macos-latest, windows-latest] - rust: [stable] - runs-on: ${{ matrix.os }} - steps: - - name: Checkout sources - uses: actions/checkout@v2 - - - name: Install stable toolchain - uses: actions-rs/toolchain@v1 - with: - profile: minimal - toolchain: ${{ matrix.rust }} - override: true - - - uses: Swatinem/rust-cache@v1 - - - name: Run cargo test - uses: actions-rs/cargo@v1 - with: - command: test - - - lints: - name: Lints - runs-on: ubuntu-latest - steps: - - name: Checkout sources - uses: actions/checkout@v2 - with: - submodules: true - - - name: Install stable toolchain - uses: actions-rs/toolchain@v1 - with: - profile: minimal - toolchain: stable - override: true - components: rustfmt, clippy - - - uses: Swatinem/rust-cache@v1 - - - name: Run cargo fmt - uses: actions-rs/cargo@v1 - with: - command: fmt - args: --all -- --check - - - name: Run cargo clippy - uses: actions-rs/cargo@v1 - with: - command: clippy - args: -- -D warnings - - - name: Run rustdoc lints - uses: actions-rs/cargo@v1 - env: - RUSTDOCFLAGS: "-D missing_docs -D rustdoc::missing_doc_code_examples" - with: - command: doc - args: --workspace --all-features --no-deps --document-private-items diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index ecf9dd7..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,224 +0,0 @@ -name: Release -on: - # schedule: - # - cron: '0 0 * * *' # midnight UTC - - push: - tags: - - 'v[0-9]+.[0-9]+.[0-9]+' - ## - release - -env: - BIN_NAME: bfoot - PROJECT_NAME: bumblefoot - REPO_NAME: spectralops/rust-ci-release-template - BREW_TAP: jondot/homebrew-tap - -jobs: - dist: - name: Dist - runs-on: ${{ matrix.os }} - strategy: - fail-fast: false # don't fail other jobs if one fails - matrix: - build: [x86_64-linux, aarch64-linux, x86_64-macos, x86_64-windows] #, x86_64-win-gnu, win32-msvc - include: - - build: x86_64-linux - os: ubuntu-20.04 - rust: stable - target: x86_64-unknown-linux-gnu - cross: false - - build: aarch64-linux - os: ubuntu-20.04 - rust: stable - target: aarch64-unknown-linux-gnu - cross: true - - build: x86_64-macos - os: macos-latest - rust: stable - target: x86_64-apple-darwin - cross: false - - build: x86_64-windows - os: windows-2019 - rust: stable - target: x86_64-pc-windows-msvc - cross: false - # - build: aarch64-macos - # os: macos-latest - # rust: stable - # target: aarch64-apple-darwin - # - build: x86_64-win-gnu - # os: windows-2019 - # rust: stable-x86_64-gnu - # target: x86_64-pc-windows-gnu - # - build: win32-msvc - # os: windows-2019 - # rust: stable - # target: i686-pc-windows-msvc - - steps: - - name: Checkout sources - uses: actions/checkout@v2 - with: - submodules: true - - - name: Install ${{ matrix.rust }} toolchain - uses: actions-rs/toolchain@v1 - with: - profile: minimal - toolchain: ${{ matrix.rust }} - target: ${{ matrix.target }} - override: true - - - name: Run cargo test - uses: actions-rs/cargo@v1 - with: - use-cross: ${{ matrix.cross }} - command: test - args: --release --locked --target ${{ matrix.target }} - - - name: Build release binary - uses: actions-rs/cargo@v1 - with: - use-cross: ${{ matrix.cross }} - command: build - args: --release --locked --target ${{ matrix.target }} - - - name: Strip release binary (linux and macos) - if: matrix.build == 'x86_64-linux' || matrix.build == 'x86_64-macos' - run: strip "target/${{ matrix.target }}/release/$BIN_NAME" - - - name: Strip release binary (arm) - if: matrix.build == 'aarch64-linux' - run: | - docker run --rm -v \ - "$PWD/target:/target:Z" \ - rustembedded/cross:${{ matrix.target }} \ - aarch64-linux-gnu-strip \ - /target/${{ matrix.target }}/release/$BIN_NAME - - - name: Build archive - shell: bash - run: | - mkdir dist - if [ "${{ matrix.os }}" = "windows-2019" ]; then - cp "target/${{ matrix.target }}/release/$BIN_NAME.exe" "dist/" - else - cp "target/${{ matrix.target }}/release/$BIN_NAME" "dist/" - fi - - - uses: actions/upload-artifact@v2.2.4 - with: - name: bins-${{ matrix.build }} - path: dist - - publish: - name: Publish - needs: [dist] - runs-on: ubuntu-latest - steps: - - name: Checkout sources - uses: actions/checkout@v2 - with: - submodules: false - - - uses: actions/download-artifact@v2 - # with: - # path: dist - # - run: ls -al ./dist - - run: ls -al bins-* - - - name: Calculate tag name - run: | - name=dev - if [[ $GITHUB_REF == refs/tags/v* ]]; then - name=${GITHUB_REF:10} - fi - echo ::set-output name=val::$name - echo TAG=$name >> $GITHUB_ENV - id: tagname - - - name: Build archive - shell: bash - run: | - set -ex - - rm -rf tmp - mkdir tmp - mkdir dist - - for dir in bins-* ; do - platform=${dir#"bins-"} - unset exe - if [[ $platform =~ "windows" ]]; then - exe=".exe" - fi - pkgname=$PROJECT_NAME-$TAG-$platform - mkdir tmp/$pkgname - # cp LICENSE README.md tmp/$pkgname - mv bins-$platform/$BIN_NAME$exe tmp/$pkgname - chmod +x tmp/$pkgname/$BIN_NAME$exe - - if [ "$exe" = "" ]; then - tar cJf dist/$pkgname.tar.xz -C tmp $pkgname - else - (cd tmp && 7z a -r ../dist/$pkgname.zip $pkgname) - fi - done - - - name: Upload binaries to release - uses: svenstaro/upload-release-action@v2 - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file: dist/* - file_glob: true - tag: ${{ steps.tagname.outputs.val }} - overwrite: true - - - name: Extract version - id: extract-version - run: | - printf "::set-output name=%s::%s\n" tag-name "${GITHUB_REF#refs/tags/}" - - - uses: mislav/bump-homebrew-formula-action@v1 - with: - formula-path: ${{env.PROJECT_NAME}}.rb - homebrew-tap: ${{ env.BREW_TAP }} - download-url: "https://github.com/${{ env.REPO_NAME }}/releases/download/${{ steps.extract-version.outputs.tag-name }}/${{env.PROJECT_NAME}}-${{ steps.extract-version.outputs.tag-name }}-x86_64-macos.tar.xz" - commit-message: updating formula for ${{ env.PROJECT_NAME }} - env: - COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }} - # - # you can use this initial file in your homebrew-tap if you don't have an initial formula: - # .rb - # - # class < Formula - # desc "A test formula" - # homepage "http://www.example.com" - # url "-----" - # version "-----" - # sha256 "-----" - - # def install - # bin.install "" - # end - # end - - - # Uncomment this section if you want to release your package to crates.io - # Before publishing, make sure you have filled out the following fields: - # license or license-file, description, homepage, documentation, repository, readme. - # Read more: https://doc.rust-lang.org/cargo/reference/publishing.html - - # - name: Install ${{ matrix.rust }} toolchain - # uses: actions-rs/toolchain@v1 - # with: - # profile: minimal - # toolchain: ${{ matrix.rust }} - # target: ${{ matrix.target }} - # - run: cargo publish --token ${CRATES_TOKEN} - # env: - # CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }} - - - diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml deleted file mode 100644 index 31000a2..0000000 --- a/.github/workflows/rust.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: Rust - -on: - push: - branches: [ "main" ] - pull_request: - branches: [ "main" ] - -env: - CARGO_TERM_COLOR: always - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - name: Build - run: cargo build --verbose - - name: Run tests - run: cargo test --verbose From 807bb73b6b39aec55dd76472a5feff2f135cc47f Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Fri, 6 Oct 2023 22:24:39 +0530 Subject: [PATCH 08/25] Create CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..494868e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,7 @@ + + shell completion scripts + add a proper release with binaries + license? + improve docs + user customisable colours (using an environment variable) + general code improvements (and probable bug fixes) From 002bc71fd094c38f04aaeea555b5b303e2cc2495 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Fri, 6 Oct 2023 22:35:13 +0530 Subject: [PATCH 09/25] Update README.md --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cb43bf9..3a9f947 100644 --- a/README.md +++ b/README.md @@ -47,8 +47,12 @@ following [this](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your- a PowerShell completion script is located at the following path ```.\etc\completions\_oi.ps1``` but I currently have no idea where to put it (sorry!) -##### I'll be providing pre compiled binaries for Linux, Windows & macOS in the releases section soon +##### I'll be providing pre-compiled binaries for Linux, Windows & macOS in the releases section soon +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ >> sadly he couldn't. The repo is currently inactive and is not accepting any pull requests. But I really love this project and would like to maintain it fo myself and the wonderful people who like their scoop right on their terminal. +If you're interested in participating and helping me resurrect Oi, please help me tidy up the documentation. I'll try to set up the binary builds as soon as I can. feel free to update that if you feel comfortable anyway. + +Let's start with these todos maybe? And I'll keep adding things to do. ### TODO: - [x] shell completion scripts From 29ff0bdffb3f8f47839769d9ff883b9a54ab5cdf Mon Sep 17 00:00:00 2001 From: Vysakh Premkumar Date: Sat, 7 Oct 2023 14:43:02 +0530 Subject: [PATCH 10/25] autofixes suggested by cargo --- src/io_functions.rs | 2 +- src/main.rs | 2 +- src/selectors/lyrics.rs | 2 +- src/selectors/mod.rs | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/io_functions.rs b/src/io_functions.rs index 12e015e..e4ffc05 100644 --- a/src/io_functions.rs +++ b/src/io_functions.rs @@ -22,7 +22,7 @@ pub fn fetch(query: String, lang: String) -> Result { pub fn cached_html() -> Result { let os_type = platform(); let files = get_file_list(os_type)?; - let html = fs::read_to_string(&files[(files.len() - 1)])?; + let html = fs::read_to_string(&files[files.len() - 1])?; Ok(html) } diff --git a/src/main.rs b/src/main.rs index 23af406..2bf1b25 100644 --- a/src/main.rs +++ b/src/main.rs @@ -160,7 +160,7 @@ fn main() { } let mut corrected = false; - if answers[(total - 1)] == "corrections" { + if answers[total - 1] == "corrections" { corrected = true; if !quiet { corrections(&data) diff --git a/src/selectors/lyrics.rs b/src/selectors/lyrics.rs index 9389f8a..f2ad734 100644 --- a/src/selectors/lyrics.rs +++ b/src/selectors/lyrics.rs @@ -9,7 +9,7 @@ pub fn main(data: &scraper::Html, tty: &bool, w: usize) { let dups_len = duplicate_lines.len(); let mut lyrics_index = lyrics .iter() - .position(|&r| r == duplicate_lines[(dups_len - 1)]) + .position(|&r| r == duplicate_lines[dups_len - 1]) .unwrap(); for _ in 0..dups_len { lyrics.remove(lyrics_index); diff --git a/src/selectors/mod.rs b/src/selectors/mod.rs index 2f09936..cea9ac2 100644 --- a/src/selectors/mod.rs +++ b/src/selectors/mod.rs @@ -255,7 +255,7 @@ pub fn filter(mut answers: Vec<&str>, mut query: String) -> Vec<&str> { "holidays" => { if qv[0] == "holidays" || qv[0] == "public" && qv[1] == "holidays" - || qv[(n - 1)] == "public" && qv[n] == "holidays" + || qv[n - 1] == "public" && qv[n] == "holidays" || qv[n] == "holidays" { answers = vec!["holidays"]; From f5eb05c8c2f4c6c8b5a4717b09d5278a979711b1 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 14:44:35 +0530 Subject: [PATCH 11/25] Create rust.yml --- .github/workflows/rust.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/rust.yml diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml new file mode 100644 index 0000000..31000a2 --- /dev/null +++ b/.github/workflows/rust.yml @@ -0,0 +1,22 @@ +name: Rust + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Build + run: cargo build --verbose + - name: Run tests + run: cargo test --verbose From 61f310cc64165fcebe75c2ee19d9261ad8772515 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:02:59 +0530 Subject: [PATCH 12/25] Update rust.yml --- .github/workflows/rust.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 31000a2..9cfdf6f 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -20,3 +20,25 @@ jobs: run: cargo build --verbose - name: Run tests run: cargo test --verbose + + rust_release_binary: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Rust Release binary + uses: rust-build/rust-build.action@v1.4.3 + with: + RUSTTARGET: x86_64-unknown-linux-gnu # Set your target platform + EXTRA_FILES: '' # List any extra files to include (optional) + SRC_DIR: '' # Path to directory containing Cargo.toml (optional, defaults to project root) + ARCHIVE_TYPES: 'zip' # List of archive types to publish the binaries with (optional) + ARCHIVE_NAME: 'oi' # Full name of archive to upload (optional, specify file extension) + PRE_BUILD: '' # Relative path of script to run before building (optional) + POST_BUILD: '' # Relative path of script to run after building (optional) + MINIFY: 'false' # If set to "true", the resulting binary will be stripped and compressed by UPX + TOOLCHAIN_VERSION: 'stable' # The Rust toolchain version to use (optional) + UPLOAD_MODE: 'release' # What method to use to upload compiled binaries (release or none) + From cdd10f14a0990c64bdf6ddbfbfce1a818855ba72 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:06:10 +0530 Subject: [PATCH 13/25] Update rust.yml --- .github/workflows/rust.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 9cfdf6f..3bb29c1 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -31,7 +31,7 @@ jobs: - name: Rust Release binary uses: rust-build/rust-build.action@v1.4.3 with: - RUSTTARGET: x86_64-unknown-linux-gnu # Set your target platform + RUSTTARGET: x86_64-unknown-linux-musl # Use x86_64-unknown-linux-musl for statically linked binaries EXTRA_FILES: '' # List any extra files to include (optional) SRC_DIR: '' # Path to directory containing Cargo.toml (optional, defaults to project root) ARCHIVE_TYPES: 'zip' # List of archive types to publish the binaries with (optional) From 25c6b01a01fa121463123a703bb4ca00e7825d83 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:12:09 +0530 Subject: [PATCH 14/25] Update rust.yml --- .github/workflows/rust.yml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 3bb29c1..dcfdf55 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -32,13 +32,13 @@ jobs: uses: rust-build/rust-build.action@v1.4.3 with: RUSTTARGET: x86_64-unknown-linux-musl # Use x86_64-unknown-linux-musl for statically linked binaries - EXTRA_FILES: '' # List any extra files to include (optional) - SRC_DIR: '' # Path to directory containing Cargo.toml (optional, defaults to project root) ARCHIVE_TYPES: 'zip' # List of archive types to publish the binaries with (optional) ARCHIVE_NAME: 'oi' # Full name of archive to upload (optional, specify file extension) - PRE_BUILD: '' # Relative path of script to run before building (optional) - POST_BUILD: '' # Relative path of script to run after building (optional) - MINIFY: 'false' # If set to "true", the resulting binary will be stripped and compressed by UPX - TOOLCHAIN_VERSION: 'stable' # The Rust toolchain version to use (optional) - UPLOAD_MODE: 'release' # What method to use to upload compiled binaries (release or none) + UPLOAD_MODE: 'release' # Specify 'release' to upload the release binary + + - name: Upload Release Binary + run: | + curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ + --data-binary "@oi.zip" \ + -X POST "https://uploads.github.com/repos/tellmeY18/oi/releases/$(curl -H 'Authorization: token ${{ secrets.GITHUB_TOKEN }}' -H 'Accept: application/vnd.github.v3+json' https://api.github.com/repos/tellmeY18/oi/releases/tags/${{ github.ref }} | jq -r .id )/assets?name=oi.zip" From ef101fc4e50a3987aa70ee734582fa6e98bc9d12 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:18:07 +0530 Subject: [PATCH 15/25] Update rust.yml --- .github/workflows/rust.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index dcfdf55..804749b 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -38,7 +38,7 @@ jobs: - name: Upload Release Binary run: | - curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ + curl -H "Authorization: token ${{ secrets.MY_GITHUB_TOKEN }}" \ --data-binary "@oi.zip" \ - -X POST "https://uploads.github.com/repos/tellmeY18/oi/releases/$(curl -H 'Authorization: token ${{ secrets.GITHUB_TOKEN }}' -H 'Accept: application/vnd.github.v3+json' https://api.github.com/repos/tellmeY18/oi/releases/tags/${{ github.ref }} | jq -r .id )/assets?name=oi.zip" + -X POST "https://uploads.github.com/repos/tellmeY18/oi/releases/$(curl -H 'Authorization: token ${{ secrets.MY_GITHUB_TOKEN }}' -H 'Accept: application/vnd.github.v3+json' https://api.github.com/repos/tellmeY18/oi/releases/tags/${{ github.ref }} | jq -r .id )/assets?name=oi.zip" From 601382d136107ff863b22d006c655aba8e825e46 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:44:28 +0530 Subject: [PATCH 16/25] Delete .github/workflows/rust.yml --- .github/workflows/rust.yml | 44 -------------------------------------- 1 file changed, 44 deletions(-) delete mode 100644 .github/workflows/rust.yml diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml deleted file mode 100644 index 804749b..0000000 --- a/.github/workflows/rust.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: Rust - -on: - push: - branches: [ "main" ] - pull_request: - branches: [ "main" ] - -env: - CARGO_TERM_COLOR: always - -jobs: - build: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - name: Build - run: cargo build --verbose - - name: Run tests - run: cargo test --verbose - - rust_release_binary: - - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - - name: Rust Release binary - uses: rust-build/rust-build.action@v1.4.3 - with: - RUSTTARGET: x86_64-unknown-linux-musl # Use x86_64-unknown-linux-musl for statically linked binaries - ARCHIVE_TYPES: 'zip' # List of archive types to publish the binaries with (optional) - ARCHIVE_NAME: 'oi' # Full name of archive to upload (optional, specify file extension) - UPLOAD_MODE: 'release' # Specify 'release' to upload the release binary - - - name: Upload Release Binary - run: | - curl -H "Authorization: token ${{ secrets.MY_GITHUB_TOKEN }}" \ - --data-binary "@oi.zip" \ - -X POST "https://uploads.github.com/repos/tellmeY18/oi/releases/$(curl -H 'Authorization: token ${{ secrets.MY_GITHUB_TOKEN }}' -H 'Accept: application/vnd.github.v3+json' https://api.github.com/repos/tellmeY18/oi/releases/tags/${{ github.ref }} | jq -r .id )/assets?name=oi.zip" - From 290aaeecd45a0514081f497de001a617410a2ff6 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:46:01 +0530 Subject: [PATCH 17/25] Create release.yml --- .github/workflows/release.yml | 54 +++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..8548542 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,54 @@ +name: release + +on: + push: + tags: + - "[0-9]+.[0-9]+.[0-9]+" + +jobs: + create-release: + name: Create Release + runs-on: ubuntu-latest + outputs: + release_version: ${{ steps.set_version.outputs.version }} + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + + - name: Set Release Version + id: set_version + run: echo "::set-output name=version::${GITHUB_REF_NAME}" + + - name: Create GitHub Release + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh release create ${{ steps.set_version.outputs.version }} + + build-release: + name: Build and Release Binary + needs: ['create-release'] + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v2 + + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + toolchain: stable + override: true + + - name: Build Release Binary + run: cargo build --release + + - name: Create Release Archive + run: | + cp target/release/oi oi + tar czf oi.tar.gz oi + working-directory: ${{ github.workspace }} + + - name: Upload Release Archive + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: gh release upload ${{ needs.create-release.outputs.release_version }} oi.tar.gz --clobber + From 007b1cb8a1718af5e1cd805a39ab98a4b587e810 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:46:56 +0530 Subject: [PATCH 18/25] Update release.yml --- .github/workflows/release.yml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8548542..1afb6d7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,8 +2,8 @@ name: release on: push: - tags: - - "[0-9]+.[0-9]+.[0-9]+" + branches: + - main # Adjust the branch name if needed jobs: create-release: @@ -17,7 +17,7 @@ jobs: - name: Set Release Version id: set_version - run: echo "::set-output name=version::${GITHUB_REF_NAME}" + run: echo "::set-output name=version::$(date +'%Y.%m.%d.%H%M%S')" - name: Create GitHub Release env: @@ -51,4 +51,3 @@ jobs: env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: gh release upload ${{ needs.create-release.outputs.release_version }} oi.tar.gz --clobber - From 04287b1742133547d55ab34a4d931cd9091a992c Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sun, 8 Oct 2023 03:47:13 +0530 Subject: [PATCH 19/25] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From c564a1f444f45ebddb24b23508dbb6111b7c2b2d Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sun, 8 Oct 2023 03:49:27 +0530 Subject: [PATCH 20/25] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3a9f947..6e6c260 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,8 @@ Let's start with these todos maybe? And I'll keep adding things to do. ### TODO: - [x] shell completion scripts -- [ ] add a proper release with binaries -- [ ] license? +- [x] add a proper release with binaries +- [x] license? - [ ] improve docs - [ ] user customisable colours (using an environment variable) - [ ] general code improvements (and probable bug fixes) From bf758b4ab373cbdb0dc844f2ef4546ad2c9e7ead Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Sun, 8 Oct 2023 03:51:06 +0530 Subject: [PATCH 21/25] Update release.yml --- .github/workflows/release.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1afb6d7..2ab1fd9 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,8 +2,8 @@ name: release on: push: - branches: - - main # Adjust the branch name if needed + tags: + - "[0-9]+.[0-9]+.[0-9]+" jobs: create-release: From 2d66db204de7f34dcab7fa80b83d5ec011af5386 Mon Sep 17 00:00:00 2001 From: tellmeY18 <84713473+tellmeY18@users.noreply.github.com> Date: Mon, 9 Oct 2023 03:06:30 +0530 Subject: [PATCH 22/25] edit readme --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6e6c260..9d43cb2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ ▐█▌.▐▌▐█▌.▀ ▀█▄▀▪▀▀▀ ▀ - trivia on the command line ``` -#### Documentation is my... ![define_ah](https://user-images.githubusercontent.com/53883649/146692265-ec042204-7cbd-4918-89fa-10d47d1bf621.jpg) @@ -47,12 +46,8 @@ following [this](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your- a PowerShell completion script is located at the following path ```.\etc\completions\_oi.ps1``` but I currently have no idea where to put it (sorry!) -##### I'll be providing pre-compiled binaries for Linux, Windows & macOS in the releases section soon -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ >> sadly he couldn't. The repo is currently inactive and is not accepting any pull requests. But I really love this project and would like to maintain it fo myself and the wonderful people who like their scoop right on their terminal. +### Pre-Compiled version for Linux is available in the Release section. You may download that and run it using ./oi or move it to your $PATH -If you're interested in participating and helping me resurrect Oi, please help me tidy up the documentation. I'll try to set up the binary builds as soon as I can. feel free to update that if you feel comfortable anyway. - -Let's start with these todos maybe? And I'll keep adding things to do. ### TODO: - [x] shell completion scripts @@ -61,3 +56,9 @@ Let's start with these todos maybe? And I'll keep adding things to do. - [ ] improve docs - [ ] user customisable colours (using an environment variable) - [ ] general code improvements (and probable bug fixes) + +### TO-DO List @tellmeY18 +- [ ] package it for cargo +- [ ] package for debian +- [ ] add to AUR +- [ ] package for Arch mebbe ? \ No newline at end of file From 64d095dd7165bee554d79e0eef0d9fc3a4e32c49 Mon Sep 17 00:00:00 2001 From: Vysakh Premkumar Date: Wed, 8 Nov 2023 17:51:26 +0530 Subject: [PATCH 23/25] fixed thread main panicked --- Cargo.lock | 2 +- Cargo.toml | 5 ++-- src/cli.rs | 4 +-- src/main.rs | 71 +++++++++++++++++++++-------------------------------- 4 files changed, 34 insertions(+), 48 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index e6de537..57959bb 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -510,7 +510,7 @@ dependencies = [ [[package]] name = "oi" -version = "0.2.0" +version = "0.2.1" dependencies = [ "anyhow", "chrono", diff --git a/Cargo.toml b/Cargo.toml index 369b82f..5aebbe3 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "oi" -version = "0.2.0" -authors = ["David Sherriff "] +version = "0.2.1" +authors = ["Vysakh Premkumar "] edition = "2021" description = "trivia on the command line." # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html @@ -21,3 +21,4 @@ glob = "~0.3" scraper = "~0.12" ureq = { version = "~2.4", features = ["charset"] } whoami = "~1.2" + diff --git a/src/cli.rs b/src/cli.rs index e1dcdac..9be5995 100644 --- a/src/cli.rs +++ b/src/cli.rs @@ -5,8 +5,8 @@ pub fn build<'a>(selectors: &'a [&str]) -> App<'a> { .author("David Sherriff ") .about("please use --help for more detailed information") .long_about("trivia on the command line.") - .version("0.2.0") - .help_template("{bin}\n{about}\n\n{usage-heading}\n {usage}\n\n{all-args}\n\nversion {version} by {author}\nplease report any bugs to https://github.com/PureArtistry/oi/issues") + .version("0.2.1") + .help_template("{bin}\n{about}\n\n{usage-heading}\n {usage}\n\n{all-args}\n\nversion {version} by {author}\nplease report any bugs to https://github.com/tellmeY18/oi/issues") .arg(Arg::new("all") .short('a') diff --git a/src/main.rs b/src/main.rs index 2bf1b25..39d5f8e 100644 --- a/src/main.rs +++ b/src/main.rs @@ -249,54 +249,39 @@ fn corrections(data: &scraper::Html) { } fn print_urls(w: usize, data: scraper::Html) { - match data - .select(&Selector::parse(selectors::name_to_id("url_block")).unwrap()) - .next() - .is_some() - { - true => { - for x in data.select(&Selector::parse(selectors::name_to_id("url_block")).unwrap()) { - let title = x - .select(&Selector::parse(selectors::name_to_id("title")).unwrap()) - .next() - .unwrap() - .text() - .collect::>(); + let selector = Selector::parse(selectors::name_to_id("url_block")).unwrap(); + let mut url_blocks = data.select(&selector); - let url = x - .select(&Selector::parse(selectors::name_to_id("url")).unwrap()) - .next() - .unwrap() - .first_child() - .unwrap() - .value() - .as_element() - .unwrap() - .attr("href") - .unwrap(); + if url_blocks.next().is_some() { + for x in url_blocks { + let title_selector = Selector::parse(selectors::name_to_id("title")).unwrap(); + let title = x.select(&title_selector).next().unwrap().text().collect::>(); - let desc_check = x - .select(&Selector::parse(selectors::name_to_id("desc")).unwrap()) - .next(); - let description: String = match desc_check.is_some() { - true => { - let y = desc_check.unwrap().text().collect::>(); - y.join("") - } - false => "No description available, sorry!".to_string() - }; + let url_selector = Selector::parse(selectors::name_to_id("url")).unwrap(); + let url_element = x.select(&url_selector).next().unwrap(); + let href = url_element + .first_child() + .and_then(|element| element.value().as_element()) + .and_then(|element| element.attr("href")) + .unwrap_or("No URL available"); - println!( - "\n{}\n{}\n{}", - title.join("").bold().blue(), - url, - format_desc(w, description).dark_grey() - ) - } + let desc_selector = Selector::parse(selectors::name_to_id("desc")).unwrap(); + let desc_check = x.select(&desc_selector).next(); + let description = match desc_check { + Some(y) => y.text().collect::>().join(""), + None => "No description available, sorry!".to_string(), + }; + + println!( + "\n{}\n{}\n{}", + title.join("").bold().blue(), + href, + format_desc(w, description).dark_grey() + ); } - false => println!("{}", "jk, there are no links!".dark_grey()) + } else { + println!("{}", "jk, there are no links!".dark_grey()); } - exit(0) } fn format_desc(length_max: usize, desc: String) -> String { From a31fe18e1f57754ea23dc3a4bb2e6e4ab61e3382 Mon Sep 17 00:00:00 2001 From: Vysakh Premkumar Date: Wed, 8 Nov 2023 18:00:25 +0530 Subject: [PATCH 24/25] specified GPL-3.0 in cargo.toml --- Cargo.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/Cargo.toml b/Cargo.toml index 5aebbe3..4137a33 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,6 +4,7 @@ version = "0.2.1" authors = ["Vysakh Premkumar "] edition = "2021" description = "trivia on the command line." +license = "GPL-3.0" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [[bin]] From c57a000f51274492ae6971339a96c39916e33f51 Mon Sep 17 00:00:00 2001 From: Vysakh Premkumar Date: Wed, 8 Nov 2023 22:53:53 +0530 Subject: [PATCH 25/25] added to AUR --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d43cb2..8b93e75 100644 --- a/README.md +++ b/README.md @@ -60,5 +60,5 @@ a PowerShell completion script is located at the following path ```.\etc\complet ### TO-DO List @tellmeY18 - [ ] package it for cargo - [ ] package for debian -- [ ] add to AUR -- [ ] package for Arch mebbe ? \ No newline at end of file +- [x] add to AUR +- [ ] package for Arch mebbe ?