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

Use GETOPT for the command line scripts #326

Closed
10 tasks done
pkiraly opened this issue Oct 16, 2023 · 0 comments
Closed
10 tasks done

Use GETOPT for the command line scripts #326

pkiraly opened this issue Oct 16, 2023 · 0 comments
Assignees
Milestone

Comments

@pkiraly
Copy link
Owner

pkiraly commented Oct 16, 2023

Follow how the index script works

  • validator
  • completeness
  • Subject analysis (classifications)
  • Authority name analysis (authorities)
  • Serials analysis (serials)
  • Thompson—Traill completeness (tt-completeness)
  • Shelf-Ready completeness (shelf-ready-completeness)
  • Functional analysis (functions)
  • Shacl4Bib (shacl4bib)
  • index

It is a good chance to rethink the short notations of the options. The principle of redesign: the CommonParameters should have small case letters and numbers, while the specialized ...Parameters classes should have upper case letters. In general I think the usage of short options should be discouraged, as it is harder to understand. Some letters may be a candidate for several different options, but we can use only one of them, and at the end we should assign letters to options that do not contain them, so it is not easy to memorize them.

Changes:

  • CommonParameters:
    • --fixAlma from -X to -a
    • --fixKbr from -R to -b
    • --alephseqLineType from -A to -1
    • --picaIdField from -B to -2
    • --picaSubfieldSeparator from -D to -u
    • --picaSchemaFile from -E to -j
    • --schemaType from -F to -w
    • --picaRecordType from -G to -k
    • --allowableRecords from -I to -c
    • --groupBy from -J to -e
    • --groupListFile from -K to -3
  • CompletenessParameters:
    • --format from -r to -R
    • --advanced from -v to -V
    • --onlyPackages from -p to -P
  • ValidatorParameters:
    • --summaryFileName from -g to -G
    • --summary from -s to -S
    • --details from -h to -H
    • --detailsFileName from -f to -F
    • --format from -r to -R
    • --emptyLargeCollectors from -w to -W
    • --collectAllErrors from -t to -T
    • --ignorableIssueTypes from -i to -I
  • SerialScoreParameters:
    • --fileName from -f to -F
  • ThompsonTraillCompletenessParameters:
    • --fileName from -f to -F
  • ShelfReadyCompletenessParameters:
    • --fileName from -f to -F
  • MarcToSolrParameters:
    • --solrUrl from -s to -S
    • --doCommit from -c to -A
    • --solrFieldType from -t to -T
@pkiraly pkiraly self-assigned this Oct 16, 2023
@pkiraly pkiraly added this to the PICA: 1.3 milestone Oct 16, 2023
@pkiraly pkiraly closed this as completed Oct 19, 2023
@pkiraly pkiraly reopened this Nov 1, 2023
@pkiraly pkiraly closed this as completed Nov 1, 2023
@pkiraly pkiraly reopened this Nov 3, 2023
@pkiraly pkiraly closed this as completed Nov 3, 2023
pkiraly added a commit that referenced this issue Nov 6, 2023
pkiraly added a commit that referenced this issue Nov 10, 2023
…fault Solr field type - previously the index script set it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

1 participant