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

Version 2.2 #200

Merged
merged 14 commits into from
Aug 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Changelog

## [Unreleased](https://github.com/unfoldingWord/uw-content-validation/tree/HEAD)
## [2.1.7](https://github.com/unfoldingWord/uw-content-validation/tree/2.1.7) (2021-07-28)

[Full Changelog](https://github.com/unfoldingWord/uw-content-validation/compare/2.1.6...HEAD)
[Full Changelog](https://github.com/unfoldingWord/uw-content-validation/compare/2.1.6...2.1.7)

**Implemented enhancements:**

- Check alignment data against original [\#194](https://github.com/unfoldingWord/uw-content-validation/issues/194)
- Improve WARNINGS SUPPRESSED in demos [\#178](https://github.com/unfoldingWord/uw-content-validation/issues/178)

**Fixed bugs:**
Expand All @@ -16,6 +17,10 @@

- Content Validation - July updates \(DO NOT INCORPORATE YET in tc-create\) [\#197](https://github.com/unfoldingWord/uw-content-validation/issues/197)

**Merged pull requests:**

- v2.1.7 checking consistency of alignment details copied into ULT/UST from UHB/UGNT [\#198](https://github.com/unfoldingWord/uw-content-validation/pull/198) ([RobH123](https://github.com/RobH123))

## [2.1.6](https://github.com/unfoldingWord/uw-content-validation/tree/2.1.6) (2021-07-20)

[Full Changelog](https://github.com/unfoldingWord/uw-content-validation/compare/2.1.5...2.1.6)
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ The top-level checking demonstrations return:
1. A list of things that were checked (successList)
1. Typically a list of (higher-priority) errors and a list of (lower-priority) warnings, but other formats for display of messages are also demonstrated.

Note that it's quite possible for the package to give multiple different notices for a single mistake. For example, a punctuation abnormality in a quoted text might advise about the bad punctuation as well as advising about not being able to match the quote. The package errs on the side that having additional warnings is better than missing a warning (and then later being confused about why a data file won't load). These consequential warnings mean that, if possible, it's good to rerun the checks from time to time on your latest files as you're fixing multiple errors.
Note that its quite possible for the package to give multiple different notices for a single mistake. For example, a punctuation abnormality in a quoted text might advise about the bad punctuation as well as advising about not being able to match the quote. The package errs on the side that having additional warnings is better than missing a warning (and then later being confused about why a data file wont load). These consequential warnings mean that, if possible, its good to rerun the checks from time to time on your latest files as you're fixing multiple errors.

### Notice Objects (in noticeList)

Expand All @@ -59,11 +59,11 @@ However, the lower-level checking functions provide only the list of success mes
There are two compulsory fields in all of these notice objects:

1. `priority`: A notice priority number in the range 1-1,000. Each different type of warning/error has a unique number (but not each instance of those warnings/errors). By default, notice priority numbers 700 and over are considered `errors` and 0-699 are considered `warnings`, but in truth, that’s rather arbitrary.
1. `message`: The actual general descriptive text of the notice
1. `message`: The actual general descriptive text of the notice (starts with a capital letter)

All of the following fields may be missing or undefined, i.e., they’re all optional:

1. `details`: More helpful details about the notice (if applicable)
1. `details`: More helpful details about the notice (if applicable; doesn’t start with a capital letter)
1. `repoCode`: brief repository code (if available), e.g., 'UHB', 'LT', 'ST', 'TN', 'TQ', 'TN2', 'TQ2', etc.
1. `repoName`: Door43 repository name (if available), e.g., 'en_ta', 'hi_tw'
1. `filename`: filename string (if available)
Expand Down
571 changes: 298 additions & 273 deletions noticeList.txt

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "uw-content-validation",
"description": "Functions for Checking Door43.org Scriptural Content/Resources.",
"version": "2.1.7",
"version": "2.2.0",
"private": false,
"homepage": "https://unfoldingword.github.io/uw-content-validation/",
"repository": {
Expand Down Expand Up @@ -41,7 +41,7 @@
"localforage": "^1.9.0",
"lodash": "^4.17.20",
"prop-types": "^15.7.2",
"usfm-grammar": "^2.0.0",
"usfm-grammar": "^2.1.0",
"usfm-js": "^2.1.0",
"yaml": "^1.10.0"
},
Expand Down
Loading