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

Added spellchecker. #341

Merged
merged 1 commit into from
Jun 19, 2024
Merged

Conversation

dblock
Copy link
Member

@dblock dblock commented Jun 17, 2024

Description

Added spell-checker for code and YAML.

Needs a cspell release with streetsidesoftware/cspell#5740.

Issues Resolved

Closes #337

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@dblock dblock changed the title WIP: Added spellchecker. Added spellchecker. Jun 19, 2024
@dblock dblock marked this pull request as ready for review June 19, 2024 12:48
@dblock
Copy link
Member Author

dblock commented Jun 19, 2024

@nhtruong @Xtansia This is ready to review. Fixes a couple of actual misspelled fields in the spec, too!

Copy link

codecov bot commented Jun 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.80%. Comparing base (39afe0d) to head (76d3a2a).

Current head 76d3a2a differs from pull request most recent head 1055475

Please upload reports for the commit 1055475 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #341      +/-   ##
==========================================
- Coverage   80.42%   79.80%   -0.62%     
==========================================
  Files          46       45       -1     
  Lines        1400     1367      -33     
  Branches      321      317       -4     
==========================================
- Hits         1126     1091      -35     
+ Misses        274      255      -19     
- Partials        0       21      +21     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

github-actions bot commented Jun 19, 2024

Changes Analysis

Commit SHA: 4c29a03
Comparing To SHA: 39afe0d

API Changes

Summary


├─┬Paths
│ ├─┬/_opendistro/_security/tenantinfo
│ │ ├─┬GET
│ │ │ └──[🔀] description (11427:20)
│ │ └─┬POST
│ │   └──[🔀] description (11445:20)
│ └─┬/_plugins/_security/tenantinfo
│   ├─┬GET
│   │ └──[🔀] description (5460:20)
│   └─┬POST
│     └──[🔀] description (5476:20)
└─┬Components
  ├──[➖] schemas (36942:7)❌ 
  ├──[➖] schemas (42085:7)❌ 
  ├──[➖] schemas (42074:7)❌ 
  ├──[➖] schemas (41408:7)❌ 
  ├──[➕] schemas (41408:7)
  ├──[➕] schemas (42074:7)
  ├──[➕] schemas (36942:7)
  ├──[➕] schemas (42085:7)
  ├─┬indices._common:IndexingSlowlogSettings
  │ └─┬threshold
  │   └──[🔀] $ref (41408:13)❌ 
  ├─┬_core.rank_eval:RankEvalMetricMeanReciprocalRank
  │ └─┬ALLOF
  │   └──[🔀] $ref (36943:9)❌ 
  ├─┬_core.rank_eval:RankEvalMetricPrecision
  │ ├─┬ALLOF
  │ │ └──[🔀] $ref (36936:11)❌ 
  │ └─┬ALLOF
  │   └──[🔀] $ref (36943:9)❌ 
  ├─┬cat.shards:ShardsRecord
  │ ├─┬merges.total_docs
  │ │ └──[🔀] description (39513:24)
  │ └─┬refresh.external_total
  │   └──[🔀] description (39528:24)
  ├─┬_core.rank_eval:RankEvalMetricRecall
  │ └─┬ALLOF
  │   └──[🔀] $ref (36943:9)❌ 
  ├─┬indices._common:SlowlogSettings
  │ └─┬threshold
  │   └──[🔀] $ref (42085:13)❌ 
  ├─┬notifications._common:SmtpAccount
  │ ├──[➕] required (46200:11)❌ 
  │ ├──[➖] required (46200:11)❌ 
  │ ├──[➕] properties (46197:9)
  │ └──[➖] properties (46197:9)❌ 
  ├─┬nodes._common:FileSystemTotal
  │ ├─┬available
  │ │ └──[🔀] description (44544:24)
  │ └─┬available_in_bytes
  │   └──[🔀] description (44550:24)
  ├─┬rollups._common:Stats
  │ ├──[➕] properties (46421:9)
  │ └──[➖] properties (46421:9)❌ 
  └─┬notifications._common:SesAccount
    ├──[➕] required (46172:11)❌ 
    ├──[➖] required (46172:11)❌ 
    ├──[➕] properties (46169:9)
    └──[➖] properties (46169:9)❌ 

Document Element Total Changes Breaking Changes
paths 4 0
components 28 21
  • BREAKING Changes: 21 out of 32
  • Modifications: 14
  • Removals: 9
  • Additions: 9
  • Breaking Removals: 9
  • Breaking Modifications: 6
  • Breaking Additions: 2

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/9585770512/artifacts/1617914405

API Coverage

Before After Δ
Covered (%) 483 (47.31 %) 483 (47.31 %) 0 (0 %)
Uncovered (%) 538 (52.69 %) 538 (52.69 %) 0 (0 %)
Unknown 24 24 0

nhtruong
nhtruong previously approved these changes Jun 19, 2024
Fixed SlowlogThresholds, from_address, and pages_processed.

Signed-off-by: dblock <dblock@amazon.com>
@nhtruong nhtruong merged commit 2134bcf into opensearch-project:main Jun 19, 2024
9 checks passed
@dblock dblock deleted the spell-checker branch June 19, 2024 19:05
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.

[FEATURE] Add a spelling linter.
2 participants