Skip to content

🔧 add some basic unicorn rules to linter - #493

Merged
ianardee merged 4 commits into
mainfrom
unicorn
Sep 18, 2026
Merged

🔧 add some basic unicorn rules to linter#493
ianardee merged 4 commits into
mainfrom
unicorn

Conversation

@ianardee

@ianardee ianardee commented Sep 18, 2026

Copy link
Copy Markdown
Collaborator

Description

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Requires a change to the official Guide documentation.

@ianardee
ianardee requested a lite review from Copilot September 18, 2026 16:31
Copilot AI reviewed Sep 18, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

Dependency license checks are unresolved, and the selected Unicorn version does not support the package’s Node 20 floor.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Adds basic eslint-plugin-unicorn rules and reformats JSDoc comments across the SDK without intended runtime behavior changes.

Changes:

  • Adds and configures Unicorn ESLint rules.
  • Updates dependency lockfiles.
  • Reformats JSDoc and corrects minor documentation wording.
File summaries
File Summary
src/v2/search/ragDocuments/ragDocumentSearchParameters.ts Reformats JSDoc.
src/v2/search/ragDocuments/ragDocumentSearch.ts Reformats JSDoc.
src/v2/search/models/modelSearchParameters.ts Reformats JSDoc.
src/v2/search/models/modelSearch.ts Reformats JSDoc.
src/v2/search/baseSearch.ts Reformats JSDoc.
src/v2/product/split/splitResult.ts Reformats JSDoc.
src/v2/product/split/splitResponse.ts Reformats JSDoc.
src/v2/product/split/splitRange.ts Reformats JSDoc.
src/v2/product/split/splitInference.ts Reformats JSDoc.
src/v2/product/split/split.ts Reformats JSDoc.
src/v2/product/ocr/ocrWord.ts Reformats JSDoc.
src/v2/product/ocr/ocrResult.ts Reformats JSDoc.
src/v2/product/ocr/ocrResponse.ts Reformats JSDoc.
src/v2/product/ocr/ocrPage.ts Reformats JSDoc.
src/v2/product/ocr/ocrInference.ts Reformats JSDoc.
src/v2/product/ocr/ocr.ts Reformats JSDoc.
src/v2/product/extraction/ragDocuments/annotatedListField.ts Reformats JSDoc.
src/v2/product/extraction/params/dataSchemaReplace.ts Reformats JSDoc.
src/v2/product/extraction/params/dataSchemaField.ts Reformats JSDoc.
src/v2/product/extraction/params/dataSchema.ts Reformats JSDoc.
src/v2/product/extraction/extractionResult.ts Reformats JSDoc.
src/v2/product/extraction/extractionResponse.ts Reformats JSDoc.
src/v2/product/extraction/extractionInference.ts Reformats JSDoc.
src/v2/product/extraction/extractionActiveOptions.ts Reformats JSDoc.
src/v2/product/extraction/extraction.ts Reformats JSDoc.
src/v2/product/extraction/dataSchemaActiveOption.ts Reformats JSDoc.
src/v2/product/crop/cropResult.ts Reformats JSDoc.
src/v2/product/crop/cropResponse.ts Reformats JSDoc.
src/v2/product/crop/cropItem.ts Reformats JSDoc.
src/v2/product/crop/cropInference.ts Reformats JSDoc.
src/v2/product/crop/crop.ts Reformats JSDoc.
src/v2/product/classification/classificationResult.ts Reformats JSDoc.
src/v2/product/classification/classificationResponse.ts Reformats JSDoc.
src/v2/product/classification/classificationInference.ts Reformats JSDoc.
src/v2/product/classification/classificationClassifier.ts Reformats JSDoc.
src/v2/product/classification/classification.ts Reformats JSDoc.
src/v2/parsing/inference/inferenceModel.ts Reformats JSDoc.
src/v2/parsing/inference/inferenceFile.ts Reformats JSDoc.
src/v2/parsing/inference/field/simpleField.ts Reformats JSDoc.
src/v2/parsing/inference/field/rawText.ts Reformats JSDoc.
src/v2/parsing/inference/field/ragMetadata.ts Reformats JSDoc.
src/v2/parsing/inference/field/objectField.ts Reformats JSDoc.
src/v2/parsing/inference/field/listField.ts Reformats JSDoc.
src/v2/parsing/inference/field/inferenceFields.ts Reformats JSDoc.
src/v2/parsing/inference/field/fieldLocation.ts Reformats JSDoc.
src/v2/parsing/inference/field/fieldConfidence.ts Reformats JSDoc.
src/v2/parsing/inference/field/baseField.ts Reformats JSDoc.
src/v2/parsing/inference/baseInference.ts Reformats JSDoc.
src/v2/parsing/error/errorDetails.ts Reformats JSDoc.
src/v2/clientOptions/pollingOptions.ts Reformats JSDoc.
src/v2/client.ts Reformats JSDoc.
src/v1/product/us/bankCheck/bankCheckV1Page.ts Reformats JSDoc.
src/v1/product/us/bankCheck/bankCheckV1Document.ts Reformats JSDoc.
src/v1/product/us/bankCheck/bankCheckV1.ts Reformats JSDoc.
src/v1/product/resume/resumeV1SocialNetworksUrl.ts Reformats JSDoc.
src/v1/product/resume/resumeV1ProfessionalExperience.ts Reformats JSDoc.
src/v1/product/resume/resumeV1Language.ts Reformats JSDoc.
src/v1/product/resume/resumeV1Education.ts Reformats JSDoc.
src/v1/product/resume/resumeV1Document.ts Reformats JSDoc.
src/v1/product/resume/resumeV1Certificate.ts Reformats JSDoc.
src/v1/product/resume/resumeV1.ts Reformats JSDoc.
src/v1/product/receipt/receiptV5LineItem.ts Reformats JSDoc.
src/v1/product/receipt/receiptV5Document.ts Reformats JSDoc.
src/v1/product/receipt/receiptV5.ts Reformats JSDoc.
src/v1/product/passport/passportV1Document.ts Reformats JSDoc.
src/v1/product/passport/passportV1.ts Reformats JSDoc.
src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1Document.ts Reformats JSDoc.
src/v1/product/multiReceiptsDetector/multiReceiptsDetectorV1.ts Reformats JSDoc.
src/v1/product/invoiceSplitter/invoiceSplitterV1InvoicePageGroup.ts Reformats JSDoc.
src/v1/product/invoiceSplitter/invoiceSplitterV1Document.ts Reformats JSDoc.
src/v1/product/invoiceSplitter/invoiceSplitterV1.ts Reformats JSDoc.
src/v1/product/invoice/invoiceV4LineItem.ts Reformats JSDoc.
src/v1/product/invoice/invoiceV4Document.ts Reformats JSDoc.
src/v1/product/invoice/invoiceV4.ts Reformats JSDoc.
src/v1/product/internationalId/internationalIdV2Document.ts Reformats JSDoc.
src/v1/product/internationalId/internationalIdV2.ts Reformats JSDoc.
src/v1/product/generated/generatedV1Prediction.ts Reformats JSDoc.
src/v1/product/generated/generatedV1.ts Reformats JSDoc.
src/v1/product/fr/idCard/idCardV2Page.ts Reformats JSDoc.
src/v1/product/fr/idCard/idCardV2Document.ts Reformats JSDoc.
src/v1/product/fr/idCard/idCardV2.ts Reformats JSDoc.
src/v1/product/fr/carteGrise/carteGriseV1Document.ts Reformats JSDoc.
src/v1/product/fr/carteGrise/carteGriseV1.ts Reformats JSDoc.
src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2Document.ts Reformats JSDoc.
src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2Bban.ts Reformats JSDoc.
src/v1/product/fr/bankAccountDetails/bankAccountDetailsV2.ts Reformats JSDoc.
src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1Document.ts Reformats JSDoc.
src/v1/product/fr/bankAccountDetails/bankAccountDetailsV1.ts Reformats JSDoc.
src/v1/product/financialDocument/financialDocumentV1LineItem.ts Reformats JSDoc.
src/v1/product/financialDocument/financialDocumentV1Document.ts Reformats JSDoc.
src/v1/product/financialDocument/financialDocumentV1.ts Reformats JSDoc.
src/v1/product/driverLicense/driverLicenseV1Document.ts Reformats JSDoc.
src/v1/product/driverLicense/driverLicenseV1.ts Reformats JSDoc.
src/v1/product/cropper/cropperV1Page.ts Reformats JSDoc.
src/v1/product/cropper/cropperV1.ts Reformats JSDoc.
src/v1/product/barcodeReader/barcodeReaderV1Document.ts Reformats JSDoc.
src/v1/product/barcodeReader/barcodeReaderV1.ts Reformats JSDoc.
src/v1/parsing/standard/word.ts Reformats JSDoc.
src/v1/parsing/standard/text.ts Reformats JSDoc.
src/v1/parsing/standard/tax.ts Reformats JSDoc.
src/v1/parsing/standard/position.ts Reformats JSDoc.
src/v1/parsing/standard/paymentDetails.ts Reformats JSDoc.
src/v1/parsing/standard/locale.ts Reformats JSDoc.
src/v1/parsing/standard/field.ts Reformats JSDoc.
src/v1/parsing/standard/date.ts Reformats JSDoc.
src/v1/parsing/standard/companyRegistration.ts Reformats JSDoc.
src/v1/parsing/standard/classification.ts Reformats JSDoc.
src/v1/parsing/standard/boolean.ts Reformats JSDoc.
src/v1/parsing/standard/base.ts Reformats JSDoc.
src/v1/parsing/standard/amount.ts Reformats JSDoc.
src/v1/parsing/standard/addressField.ts Reformats JSDoc.
src/v1/parsing/localResponse.ts Reformats JSDoc.
src/v1/parsing/generated/generatedObject.ts Reformats JSDoc.
src/v1/parsing/generated/generatedList.ts Reformats JSDoc.
src/v1/parsing/common/predictResponse.ts Reformats JSDoc.
src/v1/parsing/common/prediction.ts Reformats JSDoc.
src/v1/parsing/common/page.ts Reformats JSDoc.
src/v1/parsing/common/orientation.ts Reformats JSDoc.
src/v1/parsing/common/ocrPage.ts Reformats JSDoc.
src/v1/parsing/common/ocr.ts Reformats JSDoc.
src/v1/parsing/common/mvisionV1.ts Reformats JSDoc.
src/v1/parsing/common/inference.ts Reformats JSDoc.
src/v1/parsing/common/feedback/feedbackResponse.ts Reformats JSDoc.
src/v1/parsing/common/extras/ragExtra.ts Reformats JSDoc.
src/v1/parsing/common/extras/fullTextOcrExtra.ts Reformats JSDoc.
src/v1/parsing/common/extras/extras.ts Reformats JSDoc.
src/v1/parsing/common/extras/cropperExtra.ts Reformats JSDoc.
src/v1/parsing/common/executionPriority.ts Reformats JSDoc.
src/v1/parsing/common/executionFile.ts Reformats JSDoc.
src/v1/parsing/common/execution.ts Reformats JSDoc.
src/v1/parsing/common/document.ts Reformats JSDoc.
src/v1/parsing/common/asyncPredictResponse.ts Reformats JSDoc.
src/v1/parsing/common/apiResponse.ts Reformats JSDoc.
src/v1/parsing/common/apiRequest.ts Reformats JSDoc.
src/v1/http/httpParams.ts Reformats JSDoc.
src/v1/http/errors.ts Reformats JSDoc.
src/v1/http/endpoint.ts Reformats JSDoc.
src/v1/http/baseEndpoint.ts Reformats JSDoc.
src/v1/http/apiSettingsV1.ts Reformats JSDoc.
src/v1/extraction/multiReceiptsExtractor/extractedMultiReceiptImage.ts Reformats JSDoc.
src/v1/extraction/invoiceSplitterExtractor/extractedInvoiceSplitterImage.ts Reformats JSDoc.
src/v1/client.ts Reformats JSDoc.
src/pdf/pdfOperation.ts Reformats JSDoc.
src/pdf/extractedPdfs.ts Reformats JSDoc.
src/pdf/extractedPdf.ts Reformats JSDoc.
src/parsing/stringDict.ts Reformats JSDoc.
src/parsing/baseLocalResponse.ts Reformats JSDoc.
src/input/urlInput.ts Reformats JSDoc.
src/input/streamInput.ts Reformats JSDoc.
src/input/pathInput.ts Reformats JSDoc.
src/input/pageOptions.ts Reformats JSDoc.
src/input/localInputSource.ts Reformats JSDoc.
src/input/inputSource.ts Reformats JSDoc.
src/input/bufferInput.ts Reformats JSDoc.
src/input/base64Input.ts Reformats JSDoc.
src/image/extractedImages.ts Reformats JSDoc.
src/image/extractedImage.ts Reformats JSDoc.
src/http/dispatcher.ts Reformats JSDoc.
src/http/baseSettings.ts Reformats JSDoc.
src/geometry/polygon.ts Reformats JSDoc.
src/geometry/point.ts Reformats JSDoc.
src/geometry/minMax.ts Reformats JSDoc.
src/geometry/boundingBox.ts Reformats JSDoc.
src/geometry/bbox.ts Reformats JSDoc.
package.json Adds the Unicorn dependency.
package-lock.json Locks the Unicorn dependency tree.
eslint.config.mjs Enables Unicorn rules and adjusts lint configuration.
Review details

Suppressed comments (2)

package.json:87

  • eslint-plugin-unicorn@75.0.0 declares engines.node >=22 (package-lock.json:3451-3453), while this package still advertises Node >=20.1 and the test matrices install dependencies on Node 20. This makes the lint toolchain unsupported for a currently supported runtime; use a unicorn release compatible with Node 20 or raise the package and CI support floor together.
    "eslint-plugin-unicorn": "^75.0.0",

src/v1/product/financialDocument/financialDocumentV1Document.ts:101

  • The reformatted comment contains the spelling shooping; please use shopping.
  • Files reviewed: 162/167 changed files
  • Comments generated: 4
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread package.json
Comment thread src/v1/parsing/common/executionFile.ts Outdated
Comment thread src/v1/product/financialDocument/financialDocumentV1Document.ts Outdated
Comment thread src/v1/product/invoice/invoiceV4Document.ts Outdated
ianardee and others added 3 commits September 18, 2026 18:38
@ianardee
Fix typo in alias documentation comment
e41f59f 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ianardee
Fix typo in paymentDate documentation
f35ef40 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ianardee
Fix typo in paymentDate documentation
d8a29f4 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@ianardee
ianardee requested a lite review from Copilot September 18, 2026 16:39
Copilot AI reviewed Sep 18, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

Critical lint compatibility and Node 20 support issues remain, along with a documentation typo.

Get a fresh assessment by requesting another Copilot review.

Review details

Suppressed comments (1)

src/v1/product/financialDocument/financialDocumentV1Document.ts:101

  • The reformatted documentation still contains the typo shooping. Please correct it to shopping so the generated API documentation does not preserve the spelling error.
  • Files reviewed: 162/167 changed files
  • Comments generated: 2
  • Review effort level: Lite

Comment thread eslint.config.mjs
Comment thread package.json
@ianardee
ianardee merged commit 115a09e into main Sep 18, 2026
35 of 36 checks passed
@ianardee
ianardee deleted the unicorn branch September 18, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ianardee