From f525ac0af657812bde77642e1cf84a64b5e5faf0 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Mon, 8 Jan 2024 13:03:05 -0800 Subject: [PATCH] Chore: add pre-commit hook for codespell (#5324) --- .github/workflows/ci.yml | 6 ++--- .pre-commit-config.yaml | 9 ++++++++ docs/changelog.md | 22 +++++++++---------- docs/setup.md | 2 +- docs/usage.md | 2 +- .../admin/settings/settings.component.ts | 2 +- .../app-frame/app-frame.component.spec.ts | 2 +- .../edit-dialog/edit-dialog.component.ts | 2 +- .../input/number/number.component.spec.ts | 2 +- .../input/password/password.component.spec.ts | 2 +- .../common/input/text/text.component.spec.ts | 2 +- .../common/input/url/url.component.spec.ts | 2 +- .../document-detail.component.spec.ts | 2 +- .../document-detail.component.ts | 4 ++-- .../document-card-large.component.ts | 2 +- .../filter-editor.component.spec.ts | 12 +++++----- .../save-view-config-dialog.component.ts | 2 +- .../correspondent-list.component.spec.ts | 2 +- .../document-type-list.component.spec.ts | 2 +- .../storage-path-list.component.spec.ts | 2 +- .../tag-list/tag-list.component.spec.ts | 2 +- .../manage/workflows/workflows.component.ts | 2 +- .../app/services/consumer-status.service.ts | 2 +- .../services/document-list-view.service.ts | 2 +- .../app/services/open-documents.service.ts | 2 +- src-ui/src/app/services/rest/group.service.ts | 2 +- src-ui/src/app/services/rest/user.service.ts | 2 +- .../app/utils/ngb-date-parser-formatter.ts | 2 +- src/documents/classifier.py | 4 ++-- src/documents/parsers.py | 4 +--- src/documents/tests/test_classifier.py | 2 +- src/documents/tests/test_consumer.py | 2 +- src/paperless_mail/tests/test_mail.py | 2 +- 33 files changed, 60 insertions(+), 53 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 21cf982d6..0735c7a6e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -169,7 +169,7 @@ jobs: docker compose --file ${{ github.workspace }}/docker/compose/docker-compose.ci-test.yml down install-frontend-depedendencies: - name: "Install Frontend Dependendencies" + name: "Install Frontend Dependencies" runs-on: ubuntu-22.04 needs: - pre-commit @@ -182,7 +182,7 @@ jobs: node-version: 20.x cache: 'npm' cache-dependency-path: 'src-ui/package-lock.json' - - name: Cache frontend depdendencies + - name: Cache frontend dependencies id: cache-frontend-deps uses: actions/cache@v3 with: @@ -219,7 +219,7 @@ jobs: node-version: 20.x cache: 'npm' cache-dependency-path: 'src-ui/package-lock.json' - - name: Cache frontend depdendencies + - name: Cache frontend dependencies id: cache-frontend-deps uses: actions/cache@v3 with: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 16d0b32ea..8f263026e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -28,6 +28,15 @@ repos: - svg - id: check-case-conflict - id: detect-private-key + - repo: https://github.com/codespell-project/codespell + rev: v2.2.4 + hooks: + - id: codespell + args: ["--write-changes", "--ignore-words-list", "criterias,afterall,valeu,ure"] + exclude: "^src-ui/src/locale/|^src-ui/e2e/|^src/paperless_mail/tests/samples/" + exclude_types: + - pofile + - json - repo: https://github.com/pre-commit/mirrors-prettier rev: 'v3.1.0' hooks: diff --git a/docs/changelog.md b/docs/changelog.md index 465db72bf..063dc80c4 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -405,7 +405,7 @@ Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumpti - Enhancement: support default permissions for object creation via frontend [@shamoon](https://github.com/shamoon) ([#4233](https://github.com/paperless-ngx/paperless-ngx/pull/4233)) - Fix: Set permissions before declaring volumes for rootless [@stumpylog](https://github.com/stumpylog) ([#4225](https://github.com/paperless-ngx/paperless-ngx/pull/4225)) - Enhancement: bulk edit object permissions [@shamoon](https://github.com/shamoon) ([#4176](https://github.com/paperless-ngx/paperless-ngx/pull/4176)) -- Enhancement: Allow the user the specifiy the export zip file name [@stumpylog](https://github.com/stumpylog) ([#4189](https://github.com/paperless-ngx/paperless-ngx/pull/4189)) +- Enhancement: Allow the user the specify the export zip file name [@stumpylog](https://github.com/stumpylog) ([#4189](https://github.com/paperless-ngx/paperless-ngx/pull/4189)) - Feature: Share links [@shamoon](https://github.com/shamoon) ([#3996](https://github.com/paperless-ngx/paperless-ngx/pull/3996)) - Chore: update docker image and ci to node 20 [@shamoon](https://github.com/shamoon) ([#4184](https://github.com/paperless-ngx/paperless-ngx/pull/4184)) - Fix: Trim unneeded libraries from Docker image [@stumpylog](https://github.com/stumpylog) ([#4183](https://github.com/paperless-ngx/paperless-ngx/pull/4183)) @@ -615,7 +615,7 @@ Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumpti - Enhancement: bulk edit object permissions [@shamoon](https://github.com/shamoon) ([#4176](https://github.com/paperless-ngx/paperless-ngx/pull/4176)) - Fix: completely hide upload widget if user does not have permissions [@nawramm](https://github.com/nawramm) ([#4198](https://github.com/paperless-ngx/paperless-ngx/pull/4198)) - Fix: application of theme color vars at root [@shamoon](https://github.com/shamoon) ([#4193](https://github.com/paperless-ngx/paperless-ngx/pull/4193)) -- Enhancement: Allow the user the specifiy the export zip file name [@stumpylog](https://github.com/stumpylog) ([#4189](https://github.com/paperless-ngx/paperless-ngx/pull/4189)) +- Enhancement: Allow the user the specify the export zip file name [@stumpylog](https://github.com/stumpylog) ([#4189](https://github.com/paperless-ngx/paperless-ngx/pull/4189)) - Feature: Share links [@shamoon](https://github.com/shamoon) ([#3996](https://github.com/paperless-ngx/paperless-ngx/pull/3996)) - Chore: change dark mode to use Bootstrap's color modes [@lkster](https://github.com/lkster) ([#4174](https://github.com/paperless-ngx/paperless-ngx/pull/4174)) - Fix: support storage path placeholder via API [@shamoon](https://github.com/shamoon) ([#4179](https://github.com/paperless-ngx/paperless-ngx/pull/4179)) @@ -647,11 +647,11 @@ Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumpti ### Bug Fixes -- Fix: ghostscript rendering error doesnt trigger frontend failure message [@shamoon](https://github.com/shamoon) ([#4092](https://github.com/paperless-ngx/paperless-ngx/pull/4092)) +- Fix: ghostscript rendering error doesn't trigger frontend failure message [@shamoon](https://github.com/shamoon) ([#4092](https://github.com/paperless-ngx/paperless-ngx/pull/4092)) ### All App Changes -- Fix: ghostscript rendering error doesnt trigger frontend failure message [@shamoon](https://github.com/shamoon) ([#4092](https://github.com/paperless-ngx/paperless-ngx/pull/4092)) +- Fix: ghostscript rendering error doesn't trigger frontend failure message [@shamoon](https://github.com/shamoon) ([#4092](https://github.com/paperless-ngx/paperless-ngx/pull/4092)) ## paperless-ngx 1.17.3 @@ -1318,7 +1318,7 @@ Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumpti ### Documentation -- Whitespace changes, making sure the example is correcly aligned [@denilsonsa](https://github.com/denilsonsa) ([#3089](https://github.com/paperless-ngx/paperless-ngx/pull/3089)) +- Whitespace changes, making sure the example is correctly aligned [@denilsonsa](https://github.com/denilsonsa) ([#3089](https://github.com/paperless-ngx/paperless-ngx/pull/3089)) - Docs: Include additional information about barcodes [@stumpylog](https://github.com/stumpylog) ([#2889](https://github.com/paperless-ngx/paperless-ngx/pull/2889)) - Fix formatting in Setup documentation page [@igrybkov](https://github.com/igrybkov) ([#2880](https://github.com/paperless-ngx/paperless-ngx/pull/2880)) - [Documentation] Update docker-compose steps to support podman [@white-gecko](https://github.com/white-gecko) ([#2855](https://github.com/paperless-ngx/paperless-ngx/pull/2855)) @@ -1373,7 +1373,7 @@ Exports generated in Paperless-ngx v2.0.0–2.0.1 will **not** contain consumpti - Fix: update PaperlessTask on hard failures [@shamoon](https://github.com/shamoon) ([#3062](https://github.com/paperless-ngx/paperless-ngx/pull/3062)) - Bump typescript from 4.8.4 to 4.9.5 in /src-ui [@dependabot](https://github.com/dependabot) ([#3071](https://github.com/paperless-ngx/paperless-ngx/pull/3071)) - Bulk Bump npm packages 04.23 [@dependabot](https://github.com/dependabot) ([#3068](https://github.com/paperless-ngx/paperless-ngx/pull/3068)) -- Fix: Hide UI tour steps if user doesnt have permissions [@shamoon](https://github.com/shamoon) ([#3060](https://github.com/paperless-ngx/paperless-ngx/pull/3060)) +- Fix: Hide UI tour steps if user doesn't have permissions [@shamoon](https://github.com/shamoon) ([#3060](https://github.com/paperless-ngx/paperless-ngx/pull/3060)) - Fix: Hide Permissions tab if user cannot view users [@shamoon](https://github.com/shamoon) ([#3061](https://github.com/paperless-ngx/paperless-ngx/pull/3061)) - v1.14.0 delete document fixes [@shamoon](https://github.com/shamoon) ([#3020](https://github.com/paperless-ngx/paperless-ngx/pull/3020)) - Bump wait-on from 6.0.1 to 7.0.1 in /src-ui [@dependabot](https://github.com/dependabot) ([#2990](https://github.com/paperless-ngx/paperless-ngx/pull/2990)) @@ -1578,7 +1578,7 @@ older comments. The Docker image will automatically perform this reindex, bare m - [Docs] Add Paperless Mobile app to docs [@astubenbord](https://github.com/astubenbord) ([#2378](https://github.com/paperless-ngx/paperless-ngx/pull/2378)) - Tiny spelling change [@veverkap](https://github.com/veverkap) ([#2369](https://github.com/paperless-ngx/paperless-ngx/pull/2369)) - Documentation: update build instructions to remove deprecated [@shamoon](https://github.com/shamoon) ([#2334](https://github.com/paperless-ngx/paperless-ngx/pull/2334)) -- [Documentation] Add note that PAPERLESS_URL cant contain a path [@shamoon](https://github.com/shamoon) ([#2319](https://github.com/paperless-ngx/paperless-ngx/pull/2319)) +- [Documentation] Add note that PAPERLESS_URL can't contain a path [@shamoon](https://github.com/shamoon) ([#2319](https://github.com/paperless-ngx/paperless-ngx/pull/2319)) - [Documentation] Add v1.11.3 changelog [@github-actions](https://github.com/github-actions) ([#2311](https://github.com/paperless-ngx/paperless-ngx/pull/2311)) ### Maintenance @@ -1909,7 +1909,7 @@ Versions 1.11.1 and 1.11.2 contain bug fixes from v1.11.0 that prevented use of ### All App Changes -- Add info that re-do OCR doesnt automatically refresh content [@shamoon](https://github.com/shamoon) ([#2025](https://github.com/paperless-ngx/paperless-ngx/pull/2025)) +- Add info that re-do OCR doesn't automatically refresh content [@shamoon](https://github.com/shamoon) ([#2025](https://github.com/paperless-ngx/paperless-ngx/pull/2025)) - Bugfix: Fix created_date being a string [@stumpylog](https://github.com/stumpylog) ([#2023](https://github.com/paperless-ngx/paperless-ngx/pull/2023)) - Bugfix: Fixes an issue with mixed text and images when redoing OCR [@stumpylog](https://github.com/stumpylog) ([#2017](https://github.com/paperless-ngx/paperless-ngx/pull/2017)) - Bugfix: Don't allow exceptions during date parsing to fail consume [@stumpylog](https://github.com/stumpylog) ([#1998](https://github.com/paperless-ngx/paperless-ngx/pull/1998)) @@ -2320,7 +2320,7 @@ Versions 1.11.1 and 1.11.2 contain bug fixes from v1.11.0 that prevented use of - Fix local Docker image building [\@stumpylog](https://github.com/stumpylog) ([\#849](https://github.com/paperless-ngx/paperless-ngx/pull/849)) - Fix: show errors on invalid date input [\@shamoon](https://github.com/shamoon) ([\#862](https://github.com/paperless-ngx/paperless-ngx/pull/862)) - Fix: Older dates do not display on frontend [\@shamoon](https://github.com/shamoon) ([\#852](https://github.com/paperless-ngx/paperless-ngx/pull/852)) -- Fixes IMAP UTF8 Authenication [\@stumpylog](https://github.com/stumpylog) ([\#725](https://github.com/paperless-ngx/paperless-ngx/pull/725)) +- Fixes IMAP UTF8 Authentication [\@stumpylog](https://github.com/stumpylog) ([\#725](https://github.com/paperless-ngx/paperless-ngx/pull/725)) - Fix password field remains visible [\@shamoon](https://github.com/shamoon) ([\#840](https://github.com/paperless-ngx/paperless-ngx/pull/840)) - Fixes Pillow build for armv7 [\@stumpylog](https://github.com/stumpylog) ([\#815](https://github.com/paperless-ngx/paperless-ngx/pull/815)) - Update frontend localization source file [\@shamoon](https://github.com/shamoon) ([\#814](https://github.com/paperless-ngx/paperless-ngx/pull/814)) @@ -2441,7 +2441,7 @@ Versions 1.11.1 and 1.11.2 contain bug fixes from v1.11.0 that prevented use of [\@shamoon](https://github.com/shamoon) ([\#313](https://github.com/paperless-ngx/paperless-ngx/pull/313)) - Fix imap tools bug [\@stumpylog](https://github.com/stumpylog) ([\#393](https://github.com/paperless-ngx/paperless-ngx/pull/393)) -- Fix filterable dropdown buttons arent translated +- Fix filterable dropdown buttons aren't translated [\@shamoon](https://github.com/shamoon) ([\#366](https://github.com/paperless-ngx/paperless-ngx/pull/366)) - Fix 224: "Auto-detected date is day before receipt date" [\@a17t](https://github.com/a17t) ([\#246](https://github.com/paperless-ngx/paperless-ngx/pull/246)) @@ -3328,7 +3328,7 @@ primarily. crash. - Mail handling no longer exits entirely when encountering errors. It will skip the account/rule/message on which the error - occured. + occurred. - Assigning correspondents from mail sender names failed for very long names. Paperless no longer assigns correspondents in these cases. diff --git a/docs/setup.md b/docs/setup.md index 4ca0085b7..888892564 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -96,7 +96,7 @@ steps described in [Docker setup](#docker_hub) automatically. - /home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume ``` - Don't change the part after the colon or paperless wont find your + Don't change the part after the colon or paperless won't find your documents. You may also need to change the default port that the webserver will diff --git a/docs/usage.md b/docs/usage.md index 513cc952d..28d6265ef 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -149,7 +149,7 @@ different means. These are as follows: - **Flag:** Sets the 'important' flag on mails with consumed documents. Paperless will not consume flagged mails. - **Move to folder:** Moves consumed mails out of the way so that - paperless wont consume them again. + paperless won't consume them again. - **Add custom Tag:** Adds a custom tag to mails with consumed documents (the IMAP standard calls these "keywords"). Paperless will not consume mails already tagged. Not all mail servers support diff --git a/src-ui/src/app/components/admin/settings/settings.component.ts b/src-ui/src/app/components/admin/settings/settings.component.ts index da1f2ac60..2bfe5d1c8 100644 --- a/src-ui/src/app/components/admin/settings/settings.component.ts +++ b/src-ui/src/app/components/admin/settings/settings.component.ts @@ -363,7 +363,7 @@ export class SettingsComponent } ngOnDestroy() { - if (this.isDirty) this.settings.updateAppearanceSettings() // in case user changed appearance but didnt save + if (this.isDirty) this.settings.updateAppearanceSettings() // in case user changed appearance but didn't save this.storeSub && this.storeSub.unsubscribe() this.settings.organizingSidebarSavedViews = false } diff --git a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts index 0bee89a14..d8d79cb0f 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts @@ -248,7 +248,7 @@ describe('AppFrameComponent', () => { expect(toastSpy).toHaveBeenCalled() }) - it('should support collapsable menu', () => { + it('should support collapsible menu', () => { const button: HTMLButtonElement = ( fixture.nativeElement as HTMLDivElement ).querySelector('button[data-toggle=collapse]') diff --git a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts index 64b3bedad..fe4d0bf01 100644 --- a/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts +++ b/src-ui/src/app/components/common/edit-dialog/edit-dialog.component.ts @@ -97,7 +97,7 @@ export abstract class EditDialogComponent< }) } - // wait to enable close button so it doesnt steal focus from input since its the first clickable element in the DOM + // wait to enable close button so it doesn't steal focus from input since its the first clickable element in the DOM setTimeout(() => { this.closeEnabled = true }) diff --git a/src-ui/src/app/components/common/input/number/number.component.spec.ts b/src-ui/src/app/components/common/input/number/number.component.spec.ts index b6a281e6f..889aa2198 100644 --- a/src-ui/src/app/components/common/input/number/number.component.spec.ts +++ b/src-ui/src/app/components/common/input/number/number.component.spec.ts @@ -56,7 +56,7 @@ describe('NumberComponent', () => { component.step = 0.1 component.writeValue(12.3456) expect(component.value).toEqual(12.3456) - // float (step = .1) doesnt force 2 decimals + // float (step = .1) doesn't force 2 decimals component.writeValue(11.1) expect(component.value).toEqual(11.1) }) diff --git a/src-ui/src/app/components/common/input/password/password.component.spec.ts b/src-ui/src/app/components/common/input/password/password.component.spec.ts index 1788104a6..34999e618 100644 --- a/src-ui/src/app/components/common/input/password/password.component.spec.ts +++ b/src-ui/src/app/components/common/input/password/password.component.spec.ts @@ -28,7 +28,7 @@ describe('PasswordComponent', () => { it('should support use of input field', () => { expect(component.value).toBeUndefined() - // TODO: why doesnt this work? + // TODO: why doesn't this work? // input.value = 'foo' // input.dispatchEvent(new Event('change')) // fixture.detectChanges() diff --git a/src-ui/src/app/components/common/input/text/text.component.spec.ts b/src-ui/src/app/components/common/input/text/text.component.spec.ts index 4b0a13bc3..3b8e76e53 100644 --- a/src-ui/src/app/components/common/input/text/text.component.spec.ts +++ b/src-ui/src/app/components/common/input/text/text.component.spec.ts @@ -27,7 +27,7 @@ describe('TextComponent', () => { it('should support use of input field', () => { expect(component.value).toBeUndefined() - // TODO: why doesnt this work? + // TODO: why doesn't this work? // input.value = 'foo' // input.dispatchEvent(new Event('change')) // fixture.detectChanges() diff --git a/src-ui/src/app/components/common/input/url/url.component.spec.ts b/src-ui/src/app/components/common/input/url/url.component.spec.ts index 33eb96ec5..a0205d7eb 100644 --- a/src-ui/src/app/components/common/input/url/url.component.spec.ts +++ b/src-ui/src/app/components/common/input/url/url.component.spec.ts @@ -27,7 +27,7 @@ describe('TextComponent', () => { it('should support use of input field', () => { expect(component.value).toBeUndefined() - // TODO: why doesnt this work? + // TODO: why doesn't this work? // input.value = 'foo' // input.dispatchEvent(new Event('change')) // fixture.detectChanges() diff --git a/src-ui/src/app/components/document-detail/document-detail.component.spec.ts b/src-ui/src/app/components/document-detail/document-detail.component.spec.ts index 388baf70a..d37fa852a 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.spec.ts +++ b/src-ui/src/app/components/document-detail/document-detail.component.spec.ts @@ -303,7 +303,7 @@ describe('DocumentDetailComponent', () => { discardPeriodicTasks() })) - it('should update title before doc change if wasnt updated via debounce', fakeAsync(() => { + it('should update title before doc change if was not updated via debounce', fakeAsync(() => { initNormally() component.titleInput.value = 'Foo Bar' component.titleInput.inputField.nativeElement.dispatchEvent( diff --git a/src-ui/src/app/components/document-detail/document-detail.component.ts b/src-ui/src/app/components/document-detail/document-detail.component.ts index 1e7865f84..edc19ec70 100644 --- a/src-ui/src/app/components/document-detail/document-detail.component.ts +++ b/src-ui/src/app/components/document-detail/document-detail.component.ts @@ -157,7 +157,7 @@ export class DocumentDetailComponent @ViewChild('nav') nav: NgbNav @ViewChild('pdfPreview') set pdfPreview(element) { - // this gets called when compontent added or removed from DOM + // this gets called when component added or removed from DOM if ( element && element.nativeElement.offsetParent !== null && @@ -316,7 +316,7 @@ export class DocumentDetailComponent .subscribe({ next: (titleValue) => { // In the rare case when the field changed just after debounced event was fired. - // We dont want to overwrite whats actually in the text field, so just return + // We dont want to overwrite what's actually in the text field, so just return if (titleValue !== this.titleInput.value) return this.title = titleValue diff --git a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.ts b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.ts index 1aeccd182..442114767 100644 --- a/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.ts +++ b/src-ui/src/app/components/document-list/document-card-large/document-card-large.component.ts @@ -82,7 +82,7 @@ export class DocumentCardLargeComponent extends ComponentWithPermissions { // only show notes with a match highlights = (this.document['__search_hit__'].note_highlights as string) .split(',') - .filter((higlight) => higlight.includes(' highlight.includes(' { expect(component.textFilterTarget).toEqual('fulltext-morelike') // TEXT_FILTER_TARGET_FULLTEXT_MORELIKE expect(moreLikeSpy).toHaveBeenCalledWith(1) expect(component.textFilter).toEqual('Foo Bar') - // we have to do this here because it cant be done by user input + // we have to do this here because it can't be done by user input expect(component.filterRules).toEqual([ { rule_type: FILTER_FULLTEXT_MORELIKE, @@ -1264,7 +1264,7 @@ describe('FilterEditorComponent', () => { dateCreatedAfter.nativeElement.value = '05/14/2023' // dateCreatedAfter.triggerEventHandler('change') - // TODO: why isnt ngModel triggering this on change? + // TODO: why isn't ngModel triggering this on change? component.dateCreatedAfter = '2023-05-14' fixture.detectChanges() tick(400) @@ -1284,7 +1284,7 @@ describe('FilterEditorComponent', () => { dateCreatedBefore.nativeElement.value = '05/14/2023' // dateCreatedBefore.triggerEventHandler('change') - // TODO: why isnt ngModel triggering this on change? + // TODO: why isn't ngModel triggering this on change? component.dateCreatedBefore = '2023-05-14' fixture.detectChanges() tick(400) @@ -1341,7 +1341,7 @@ describe('FilterEditorComponent', () => { dateAddedAfter.nativeElement.value = '05/14/2023' // dateAddedAfter.triggerEventHandler('change') - // TODO: why isnt ngModel triggering this on change? + // TODO: why isn't ngModel triggering this on change? component.dateAddedAfter = '2023-05-14' fixture.detectChanges() tick(400) @@ -1361,7 +1361,7 @@ describe('FilterEditorComponent', () => { dateAddedBefore.nativeElement.value = '05/14/2023' // dateAddedBefore.triggerEventHandler('change') - // TODO: why isnt ngModel triggering this on change? + // TODO: why isn't ngModel triggering this on change? component.dateAddedBefore = '2023-05-14' fixture.detectChanges() tick(400) @@ -1524,7 +1524,7 @@ describe('FilterEditorComponent', () => { ) ownerToggle.nativeElement.checked = true // ownerToggle.triggerEventHandler('change') - // TODO: ngModel isnt doing this here + // TODO: ngModel isn't doing this here component.permissionsSelectionModel.hideUnowned = true fixture.detectChanges() expect(component.filterRules).toEqual([ diff --git a/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts b/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts index b079e2a1e..b7d9a4711 100644 --- a/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts +++ b/src-ui/src/app/components/document-list/save-view-config-dialog/save-view-config-dialog.component.ts @@ -40,7 +40,7 @@ export class SaveViewConfigDialogComponent implements OnInit { }) ngOnInit(): void { - // wait to enable close button so it doesnt steal focus from input since its the first clickable element in the DOM + // wait to enable close button so it doesn't steal focus from input since its the first clickable element in the DOM setTimeout(() => { this.closeEnabled = true }) diff --git a/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.spec.ts b/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.spec.ts index d2168d8bd..59f9160cb 100644 --- a/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.spec.ts +++ b/src-ui/src/app/components/manage/correspondent-list/correspondent-list.component.spec.ts @@ -34,7 +34,7 @@ describe('CorrespondentListComponent', () => { correspondentsService = TestBed.inject(CorrespondentService) }) - // Tests are included in management-list.compontent.spec.ts + // Tests are included in management-list.component.spec.ts it('should use correct delete message', () => { jest.spyOn(correspondentsService, 'listFiltered').mockReturnValue( diff --git a/src-ui/src/app/components/manage/document-type-list/document-type-list.component.spec.ts b/src-ui/src/app/components/manage/document-type-list/document-type-list.component.spec.ts index 1642d89b9..ef19e4313 100644 --- a/src-ui/src/app/components/manage/document-type-list/document-type-list.component.spec.ts +++ b/src-ui/src/app/components/manage/document-type-list/document-type-list.component.spec.ts @@ -58,7 +58,7 @@ describe('DocumentTypeListComponent', () => { fixture.detectChanges() }) - // Tests are included in management-list.compontent.spec.ts + // Tests are included in management-list.component.spec.ts it('should use correct delete message', () => { expect( diff --git a/src-ui/src/app/components/manage/storage-path-list/storage-path-list.component.spec.ts b/src-ui/src/app/components/manage/storage-path-list/storage-path-list.component.spec.ts index 5571c443d..6ad085409 100644 --- a/src-ui/src/app/components/manage/storage-path-list/storage-path-list.component.spec.ts +++ b/src-ui/src/app/components/manage/storage-path-list/storage-path-list.component.spec.ts @@ -58,7 +58,7 @@ describe('StoragePathListComponent', () => { fixture.detectChanges() }) - // Tests are included in management-list.compontent.spec.ts + // Tests are included in management-list.component.spec.ts it('should use correct delete message', () => { expect(component.getDeleteMessage({ id: 1, name: 'StoragePath1' })).toEqual( diff --git a/src-ui/src/app/components/manage/tag-list/tag-list.component.spec.ts b/src-ui/src/app/components/manage/tag-list/tag-list.component.spec.ts index e7be9035e..5302eb80e 100644 --- a/src-ui/src/app/components/manage/tag-list/tag-list.component.spec.ts +++ b/src-ui/src/app/components/manage/tag-list/tag-list.component.spec.ts @@ -60,7 +60,7 @@ describe('TagListComponent', () => { fixture.detectChanges() }) - // Tests are included in management-list.compontent.spec.ts + // Tests are included in management-list.component.spec.ts it('should use correct delete message', () => { expect(component.getDeleteMessage({ id: 1, name: 'Tag1' })).toEqual( diff --git a/src-ui/src/app/components/manage/workflows/workflows.component.ts b/src-ui/src/app/components/manage/workflows/workflows.component.ts index 293473888..a80f03577 100644 --- a/src-ui/src/app/components/manage/workflows/workflows.component.ts +++ b/src-ui/src/app/components/manage/workflows/workflows.component.ts @@ -66,7 +66,7 @@ export class WorkflowsComponent ? EditDialogMode.EDIT : EditDialogMode.CREATE if (workflow) { - // quick "deep" clone so original doesnt get modified + // quick "deep" clone so original doesn't get modified const clone = Object.assign({}, workflow) clone.actions = [...workflow.actions] clone.triggers = [...workflow.triggers] diff --git a/src-ui/src/app/services/consumer-status.service.ts b/src-ui/src/app/services/consumer-status.service.ts index 82b081e93..246ddad69 100644 --- a/src-ui/src/app/services/consumer-status.service.ts +++ b/src-ui/src/app/services/consumer-status.service.ts @@ -146,7 +146,7 @@ export class ConsumerStatusService { this.statusWebSocket.onmessage = (ev) => { let statusMessage: WebsocketConsumerStatusMessage = JSON.parse(ev['data']) - // fallback if backend didnt restrict message + // fallback if backend didn't restrict message if ( statusMessage.owner_id && statusMessage.owner_id !== this.settingsService.currentUser?.id && diff --git a/src-ui/src/app/services/document-list-view.service.ts b/src-ui/src/app/services/document-list-view.service.ts index eece10994..e1881c2f2 100644 --- a/src-ui/src/app/services/document-list-view.service.ts +++ b/src-ui/src/app/services/document-list-view.service.ts @@ -208,7 +208,7 @@ export class DocumentListViewService { this.activeListViewState.sortField = newState.sortField this.activeListViewState.sortReverse = newState.sortReverse this.activeListViewState.currentPage = newState.currentPage - this.reload(null, paramsEmpty) // update the params if there arent any + this.reload(null, paramsEmpty) // update the params if there aren't any } } diff --git a/src-ui/src/app/services/open-documents.service.ts b/src-ui/src/app/services/open-documents.service.ts index 9c7d5bf7d..71b1586fd 100644 --- a/src-ui/src/app/services/open-documents.service.ts +++ b/src-ui/src/app/services/open-documents.service.ts @@ -59,7 +59,7 @@ export class OpenDocumentsService { openDocument(doc: Document): Observable { if (this.openDocuments.find((d) => d.id == doc.id) == null) { if (this.openDocuments.length == this.MAX_OPEN_DOCUMENTS) { - // at max, ensure changes arent lost + // at max, ensure changes aren't lost const docToRemove = this.openDocuments[this.MAX_OPEN_DOCUMENTS - 1] const closeObservable = this.closeDocument(docToRemove) closeObservable.pipe(first()).subscribe((closed) => { diff --git a/src-ui/src/app/services/rest/group.service.ts b/src-ui/src/app/services/rest/group.service.ts index 31cc6311d..d12c6e938 100644 --- a/src-ui/src/app/services/rest/group.service.ts +++ b/src-ui/src/app/services/rest/group.service.ts @@ -23,7 +23,7 @@ export class GroupService extends AbstractNameFilterService { const { typeKey, actionKey } = this.permissionService.getPermissionKeys(perm) if (!typeKey || !actionKey) { - // dont lose permissions the UI doesnt use + // dont lose permissions the UI doesn't use o.permissions.push(perm) } }) diff --git a/src-ui/src/app/services/rest/user.service.ts b/src-ui/src/app/services/rest/user.service.ts index a908a50e5..4fb02b1f7 100644 --- a/src-ui/src/app/services/rest/user.service.ts +++ b/src-ui/src/app/services/rest/user.service.ts @@ -23,7 +23,7 @@ export class UserService extends AbstractNameFilterService { const { typeKey, actionKey } = this.permissionService.getPermissionKeys(perm) if (!typeKey || !actionKey) { - // dont lose permissions the UI doesnt use + // dont lose permissions the UI doesn't use o.user_permissions.push(perm) } }) diff --git a/src-ui/src/app/utils/ngb-date-parser-formatter.ts b/src-ui/src/app/utils/ngb-date-parser-formatter.ts index 5d95b21a6..eb909baef 100644 --- a/src-ui/src/app/utils/ngb-date-parser-formatter.ts +++ b/src-ui/src/app/utils/ngb-date-parser-formatter.ts @@ -53,7 +53,7 @@ export class LocalizedDateParserFormatter extends NgbDateParserFormatter { if (this.separatorRegExp.test(value)) { let segments = value.split(this.separatorRegExp) - // always accept strict yyyy*mm*dd format even if thats not the input format since we can be certain its not yyyy*dd*mm + // always accept strict yyyy*mm*dd format even if that's not the input format since we can be certain its not yyyy*dd*mm if ( value.length == 10 && segments.length == 3 && diff --git a/src/documents/classifier.py b/src/documents/classifier.py index d11b5f9cf..cc8af5868 100644 --- a/src/documents/classifier.py +++ b/src/documents/classifier.py @@ -204,10 +204,10 @@ class DocumentClassifier: ) and self.last_auto_type_hash == hasher.digest(): return False - # substract 1 since -1 (null) is also part of the classes. + # subtract 1 since -1 (null) is also part of the classes. # union with {-1} accounts for cases where all documents have - # correspondents and types assigned, so -1 isnt part of labels_x, which + # correspondents and types assigned, so -1 isn't part of labels_x, which # it usually is. num_correspondents = len(set(labels_correspondent) | {-1}) - 1 num_document_types = len(set(labels_document_type) | {-1}) - 1 diff --git a/src/documents/parsers.py b/src/documents/parsers.py index b823ae9ce..db4b42792 100644 --- a/src/documents/parsers.py +++ b/src/documents/parsers.py @@ -33,7 +33,7 @@ from documents.utils import copy_file_with_basic_stats # - XX MON ZZZZ with XX being 1 or 2 and ZZZZ being 4 digits. MONTH is 3 letters # - XXPP MONTH ZZZZ with XX being 1 or 2 and PP being 2 letters and ZZZZ being 4 digits -# TODO: isnt there a date parsing library for this? +# TODO: isn't there a date parsing library for this? DATE_REGEX = re.compile( r"(\b|(?!=([_-])))([0-9]{1,2})[\.\/-]([0-9]{1,2})[\.\/-]([0-9]{4}|[0-9]{2})(\b|(?=([_-])))|" @@ -113,8 +113,6 @@ def get_parser_class_for_mime_type(mime_type: str) -> Optional[type["DocumentPar options = [] - # Sein letzter Befehl war: KOMMT! Und sie kamen. Alle. Sogar die Parser. - for response in document_consumer_declaration.send(None): parser_declaration = response[1] supported_mime_types = parser_declaration["mime_types"] diff --git a/src/documents/tests/test_classifier.py b/src/documents/tests/test_classifier.py index 4e361aa8e..0b91e223f 100644 --- a/src/documents/tests/test_classifier.py +++ b/src/documents/tests/test_classifier.py @@ -414,7 +414,7 @@ class TestClassifier(DirectoriesMixin, TestCase): ) doc2 = Document.objects.create( title="doc2", - content="this is a document from noone", + content="this is a document from no one", checksum="B", ) diff --git a/src/documents/tests/test_consumer.py b/src/documents/tests/test_consumer.py index 24f7ff338..748e49e10 100644 --- a/src/documents/tests/test_consumer.py +++ b/src/documents/tests/test_consumer.py @@ -665,7 +665,7 @@ class TestConsumer(DirectoriesMixin, FileSystemAssertsMixin, TestCase): @override_settings(FILENAME_FORMAT="{correspondent}/{title}") @mock.patch("documents.signals.handlers.generate_unique_filename") def testFilenameHandlingUnstableFormat(self, m): - filenames = ["this", "that", "now this", "i cant decide"] + filenames = ["this", "that", "now this", "i cannot decide"] def get_filename(): f = filenames.pop() diff --git a/src/paperless_mail/tests/test_mail.py b/src/paperless_mail/tests/test_mail.py index 577db36fd..26130b643 100644 --- a/src/paperless_mail/tests/test_mail.py +++ b/src/paperless_mail/tests/test_mail.py @@ -223,7 +223,7 @@ class TestMail( attachments: Union[int, list[_AttachmentDef]] = 1, body: str = "", subject: str = "the subject", - from_: str = "noone@mail.com", + from_: str = "no_one@mail.com", to: Optional[list[str]] = None, seen: bool = False, flagged: bool = False,