Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reimplement the CLI in TypeScript #172

Merged
merged 86 commits into from
Nov 28, 2024
Merged

Reimplement the CLI in TypeScript #172

merged 86 commits into from
Nov 28, 2024

Conversation

bmesuere
Copy link
Member

@bmesuere bmesuere commented Jun 17, 2024

The ruby cli client became hard to maintain. The script for publishing new versions breaks every release and there were some problems getting this to work on windows. In addition, the use of native code required a compilation step during installation which often caused issues. The goal is to develop a drop-in replacement.

  • port the uniprot command
  • set up testing and linting
  • port peptfilter + benchmark
  • port prot2pept + benchmark
  • add fasta support
  • implement all formatters
    • xml
    • csv
    • json
  • implement the unipept commands
  • add error log support
  • catch error when piping to head -n1
  • publish as CLI on npm

Breaking changes

  • no more config file support

These are not really breaking changes since they are also broken in the current ruby tool.

  • The taxa2tree command wasn't added because this uses the broken blocks website.
  • The --meganize flag of the pept2prot command wasn't ported since this relied on fields no longer present in the database.

@bmesuere bmesuere marked this pull request as draft June 17, 2024 12:38
@bmesuere bmesuere marked this pull request as ready for review November 27, 2024 14:15
@bmesuere bmesuere requested a review from Copilot November 28, 2024 09:37

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 122 out of 137 changed files in this pull request and generated no suggestions.

Files not reviewed (15)
  • .devcontainer/devcontainer.json: Language not supported
  • .document: Language not supported
  • .nvmrc: Language not supported
  • .rakeTasks: Language not supported
  • .rubocop.yml: Language not supported
  • .ruby-version: Language not supported
  • .vscode/tasks.json: Language not supported
  • Gemfile: Language not supported
  • Rakefile: Language not supported
  • VERSION: Language not supported
  • lib/batch_iterator.rb: Evaluated as low risk
  • lib/batch_order.rb: Evaluated as low risk
  • lib/commands.rb: Evaluated as low risk
  • lib/commands/peptfilter.rb: Evaluated as low risk
  • .github/workflows/ci.yml: Evaluated as low risk
@bmesuere bmesuere requested a review from pverscha November 28, 2024 10:39
@bmesuere bmesuere merged commit c7b0a12 into main Nov 28, 2024
2 checks passed
@bmesuere bmesuere deleted the next branch November 28, 2024 10:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants