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

[FIX] isEqualOrSubPath function #1048

Merged
merged 7 commits into from
Aug 18, 2024
Merged

[FIX] isEqualOrSubPath function #1048

merged 7 commits into from
Aug 18, 2024

Conversation

4Source
Copy link
Contributor

@4Source 4Source commented Aug 12, 2024

Added better description discussed in #972
Stopp using the normalize function discussed in #1033

@ronzulu ronzulu self-requested a review August 13, 2024 13:35
Copy link
Collaborator

@ronzulu ronzulu left a comment

Choose a reason for hiding this comment

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

Hi @4Source LGTM, could you update the change log. Thanks!

@4Source
Copy link
Contributor Author

4Source commented Aug 14, 2024

@ronzulu what I am doing wrong? I run npm run changelog

@ronzulu
Copy link
Collaborator

ronzulu commented Aug 15, 2024

Hi @4Source.

There are actually a few different issues here:

  1. How updates to the change log should be done for a PR
  2. Incorrect updating of references within Major reworking of the documentation #1032(my fault)
  3. Auto generation of the change log

Updating the change log in a PR

I don't think we can use auto generation of the change log whilst working on a PR as it generates the change log based on what has already been merged into master (I believe).

So I've always just manually updated the change log as described in "Add your change to the [Unreleased] section of the changelog" in https://www.stephenmwangi.com/obsidian-spaced-repetition/contributing/#code.

So I think that's probably what needs to happen now with your PR.

Incorrect updating of references (my fault)

Background

With the major reworking of the documentation #1032, I created a test vault for taking screenshots for the user documentation.

I tried to create this under the existing directory structure, i.e. under /docs. But I can find a way to stop mkdocs from including those files within the generated static website.

So my solution was to create a new level in the directory structure, as:
image

I tried to change all references, but I didn't catch all, including the reference in file (root level) /changelog.md.

I have fixed this now on the documentation branch.

Auto generation of the change log

Out of curiosity I ran pnpm run changelog to update the change log automatically (something I've never needed to do).

For some reason even though docs/docs/changelog.md is specified in the command auto-changelog --template=compact --package && npx prettier --write docs/docs/changelog.md (package.json), the change log was generated at /changelog.md.

This seems to also be the case in what happened with you… /changelog.md got updated rather than docs/changelog.md.

@4Source
Copy link
Contributor Author

4Source commented Aug 16, 2024

I don't think we can use auto generation of the change log whilst working on a PR as it generates the change log based on what has already been merged into master (I believe).

I think this should be possible to auto generate the unreleased section with actions

Copy link
Collaborator

@ronzulu ronzulu left a comment

Choose a reason for hiding this comment

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

Thanks

@st3v3nmw st3v3nmw merged commit b7f2153 into st3v3nmw:master Aug 18, 2024
1 check passed
@st3v3nmw
Copy link
Owner

This seems to also be the case in what happened with you… /changelog.md got updated rather than docs/changelog.md.

changelog.md is a symbolic link to docs/changelog.md. It mostly works okay but gets all messed up on a non-unix OS.


Because of the conflicts we've been having with the changelog.md file, we can stop updating the file within the PRs and only do it during releases. I'll update the docs..

@4Source 4Source deleted the bug_1033 branch August 18, 2024 10:37
@ronzulu ronzulu linked an issue Sep 2, 2024 that may be closed by this pull request
st3v3nmw pushed a commit that referenced this pull request Sep 21, 2024
* Improve isEqualOrSubPath Description + remove use of normalize

* update changelog

* fix linting

* update changelog

* Revert "update changelog"

This reverts commit d7ba801.

* Update Changelog
st3v3nmw pushed a commit that referenced this pull request Sep 21, 2024
* Improve isEqualOrSubPath Description + remove use of normalize

* update changelog

* fix linting

* update changelog

* Revert "update changelog"

This reverts commit d7ba801.

* Update Changelog
st3v3nmw added a commit that referenced this pull request Sep 21, 2024
* Full coverage for UnitTest utils

* Change test config

* Added Unit Test for stats

* Added Unit Test for NumberCountDict

* Add function parseDateToTicks, formatDate

* Fix includes and doc

* Added Testcases

* Remove unused function

* Try fix ticksFromDate

* Fix lint

* [FIX] isEqualOrSubPath function (#1048)

* Improve isEqualOrSubPath Description + remove use of normalize

* update changelog

* fix linting

* update changelog

* Revert "update changelog"

This reverts commit d7ba801.

* Update Changelog

* feat: refactor code to support diff methods of storing the scheduling info, and diff SR algorithms (#1006)

* Perhaps half way towards implementation; doesn't build yet

* Implemented 70%; doesn't build

* Progress

* Progress

* Progress

* 11 of the 19 existing test suites pass

* 12 of the 19 existing test suites pass

* 14 of the 19 existing test suites pass

* Progress

* 15 of the 19 existing test suites pass

* All nineteen existing test suites pass

* Minor fixes

* More refactoring; doesn't build

* Progress, doesn't build

* Builds and all existing unit tests pass

* Progress

* Merge remote-tracking branch 'upstream/master'; due to conflicts fair manual work involved to complete merge with unit test cases working

* Continued fixing post #495 integration

* Added some test cases for OsrCore

* Added unit test support code

* Added more test files

* Added test case, fixed code issues

* Updated tests

* Small refactor

* !!GitHub_Desktop<feat-878-support-multiple-schedule-methods>

* Fixes post merge stash

* Added tests

* More refactoring

* Improved test coverage

* Improved unit test code coverage

* Starting testing of plugin within Obsidian

* Bug fixes

* Fixed broken test cases

* Added test case for global coverage

* A few merge fixes

* Version ready for beta testing

* Format and lint

* Updated actions/checkout@v3 to node 20

* Lets make lint happy!

* Previously the pnpm format added a blank line in a test markdown file which caused the test to fail

* Slightly reduced jest code coverage threshold to writing a number of difficult test cases

* Fixed bug where note frontmatter interval/ease set to null (app specific code, not core code)

* Fixed some note review queue bugs (previously introduced in branch #878)

* Lint & format

* Fixed bug preventing stats being shown (previously introduced in branch #878)

* Squashed commit of the following:

commit 3228e9c
Author: Ronny Zulaikha <[email protected]>
Date:   Wed Jul 24 15:10:39 2024 +1000

    Support RTL flashcards specified by frontmatter "direction" attribute (#935)

    * Nearly completed

    * Added RTL support for flashcards edit modal

    * Changes as part of the merge

    * post upstream master merge fixes

    * Minor code improvement

    * lint and format

    * Change log and documentation update

    * Minor code change

    * Fixed EditModal RTL

    * lint and format

    * Updated test cases to fix global coverage error

    * Format & lint

commit 971e4af
Author: Anna Zubenko <[email protected]>
Date:   Mon Jul 22 07:29:18 2024 +0200

    FEAT-990 Mobile landscape mode and functional size sliders (#998)

commit a89a818
Author: 4Source <[email protected]>
Date:   Mon Jul 22 07:25:45 2024 +0200

    [FIX] Cards missing when horizontal rule present in document (#970)

    * Use obsidians funtion to extractFrontmatter

    * Fix line pos shift

    * Stop using obsidian function because of UnitTest

    * Add UnitTest for Frontmatter and Horizontal line

    * Fix linting

    ---------

    Co-authored-by: Stephen Mwangi <[email protected]>

commit 77f15e1
Author: Carlos Galdino <[email protected]>
Date:   Mon Jul 22 06:02:11 2024 +0100

    Filter due notes when all are scheduled (#947)

    Ignore notes due in the future.

    Fixes #548

commit 83590be
Author: Newdea <[email protected]>
Date:   Sat Jul 20 15:10:57 2024 +0800

    fix #1000 sidebar indent (#1001)

commit e3a0146
Author: 4Source <[email protected]>
Date:   Sat Jul 20 09:02:14 2024 +0200

    [FIX] Include link parsing for Review context (#964)

    * Include link parsing

    * Fix linting

commit 3024264
Author: 4Source <[email protected]>
Date:   Sat Jul 20 09:00:46 2024 +0200

    [FIX] Not scroll back to top after review (#971)

    * Update deprecated function

    * Add scroll back to top

    * Fix linting

commit 1dfd52e
Author: 4Source <[email protected]>
Date:   Sat Jul 20 09:00:33 2024 +0200

    [FIX] Folder ignore sorts all folder starting with string (#972)

    * Implement isEqualOrSubPath

    * Implement UnitTest for isEqualOrSubPath

    * Replace separators with system seperator

    * Improved seperator replacement

commit b175d22
Author: artificialUsagi <[email protected]>
Date:   Sat Jul 20 14:59:11 2024 +0800

    add translation: zh-cn (#982)

* Format & lint

* fix: changelog formatting

* Post review fixes

* Format and lint

* Format & lint

---------

Co-authored-by: Stephen Mwangi <[email protected]>

* chore: update dependencies, linting, & tests

* update eslint

* lower coverage threshold

* minor fixes

---------

Co-authored-by: 4Source <[email protected]>
Co-authored-by: Ronny Zulaikha <[email protected]>
Newdea pushed a commit to open-spaced-repetition/obsidian-spaced-repetition-recall that referenced this pull request Sep 25, 2024
* Full coverage for UnitTest utils

* Change test config

* Added Unit Test for stats

* Added Unit Test for NumberCountDict

* Add function parseDateToTicks, formatDate

* Fix includes and doc

* Added Testcases

* Remove unused function

* Try fix ticksFromDate

* Fix lint

* [FIX] isEqualOrSubPath function (st3v3nmw#1048)

* Improve isEqualOrSubPath Description + remove use of normalize

* update changelog

* fix linting

* update changelog

* Revert "update changelog"

This reverts commit d7ba801.

* Update Changelog

* feat: refactor code to support diff methods of storing the scheduling info, and diff SR algorithms (st3v3nmw#1006)

* Perhaps half way towards implementation; doesn't build yet

* Implemented 70%; doesn't build

* Progress

* Progress

* Progress

* 11 of the 19 existing test suites pass

* 12 of the 19 existing test suites pass

* 14 of the 19 existing test suites pass

* Progress

* 15 of the 19 existing test suites pass

* All nineteen existing test suites pass

* Minor fixes

* More refactoring; doesn't build

* Progress, doesn't build

* Builds and all existing unit tests pass

* Progress

* Merge remote-tracking branch 'upstream/master'; due to conflicts fair manual work involved to complete merge with unit test cases working

* Continued fixing post st3v3nmw#495 integration

* Added some test cases for OsrCore

* Added unit test support code

* Added more test files

* Added test case, fixed code issues

* Updated tests

* Small refactor

* !!GitHub_Desktop<feat-878-support-multiple-schedule-methods>

* Fixes post merge stash

* Added tests

* More refactoring

* Improved test coverage

* Improved unit test code coverage

* Starting testing of plugin within Obsidian

* Bug fixes

* Fixed broken test cases

* Added test case for global coverage

* A few merge fixes

* Version ready for beta testing

* Format and lint

* Updated actions/checkout@v3 to node 20

* Lets make lint happy!

* Previously the pnpm format added a blank line in a test markdown file which caused the test to fail

* Slightly reduced jest code coverage threshold to writing a number of difficult test cases

* Fixed bug where note frontmatter interval/ease set to null (app specific code, not core code)

* Fixed some note review queue bugs (previously introduced in branch st3v3nmw#878)

* Lint & format

* Fixed bug preventing stats being shown (previously introduced in branch st3v3nmw#878)

* Squashed commit of the following:

commit 3228e9c
Author: Ronny Zulaikha <[email protected]>
Date:   Wed Jul 24 15:10:39 2024 +1000

    Support RTL flashcards specified by frontmatter "direction" attribute (st3v3nmw#935)

    * Nearly completed

    * Added RTL support for flashcards edit modal

    * Changes as part of the merge

    * post upstream master merge fixes

    * Minor code improvement

    * lint and format

    * Change log and documentation update

    * Minor code change

    * Fixed EditModal RTL

    * lint and format

    * Updated test cases to fix global coverage error

    * Format & lint

commit 971e4af
Author: Anna Zubenko <[email protected]>
Date:   Mon Jul 22 07:29:18 2024 +0200

    FEAT-990 Mobile landscape mode and functional size sliders (st3v3nmw#998)

commit a89a818
Author: 4Source <[email protected]>
Date:   Mon Jul 22 07:25:45 2024 +0200

    [FIX] Cards missing when horizontal rule present in document (st3v3nmw#970)

    * Use obsidians funtion to extractFrontmatter

    * Fix line pos shift

    * Stop using obsidian function because of UnitTest

    * Add UnitTest for Frontmatter and Horizontal line

    * Fix linting

    ---------

    Co-authored-by: Stephen Mwangi <[email protected]>

commit 77f15e1
Author: Carlos Galdino <[email protected]>
Date:   Mon Jul 22 06:02:11 2024 +0100

    Filter due notes when all are scheduled (st3v3nmw#947)

    Ignore notes due in the future.

    Fixes st3v3nmw#548

commit 83590be
Author: Newdea <[email protected]>
Date:   Sat Jul 20 15:10:57 2024 +0800

    fix st3v3nmw#1000 sidebar indent (st3v3nmw#1001)

commit e3a0146
Author: 4Source <[email protected]>
Date:   Sat Jul 20 09:02:14 2024 +0200

    [FIX] Include link parsing for Review context (st3v3nmw#964)

    * Include link parsing

    * Fix linting

commit 3024264
Author: 4Source <[email protected]>
Date:   Sat Jul 20 09:00:46 2024 +0200

    [FIX] Not scroll back to top after review (st3v3nmw#971)

    * Update deprecated function

    * Add scroll back to top

    * Fix linting

commit 1dfd52e
Author: 4Source <[email protected]>
Date:   Sat Jul 20 09:00:33 2024 +0200

    [FIX] Folder ignore sorts all folder starting with string (st3v3nmw#972)

    * Implement isEqualOrSubPath

    * Implement UnitTest for isEqualOrSubPath

    * Replace separators with system seperator

    * Improved seperator replacement

commit b175d22
Author: artificialUsagi <[email protected]>
Date:   Sat Jul 20 14:59:11 2024 +0800

    add translation: zh-cn (st3v3nmw#982)

* Format & lint

* fix: changelog formatting

* Post review fixes

* Format and lint

* Format & lint

---------

Co-authored-by: Stephen Mwangi <[email protected]>

* chore: update dependencies, linting, & tests

* update eslint

* lower coverage threshold

* minor fixes

---------

Co-authored-by: 4Source <[email protected]>
Co-authored-by: Ronny Zulaikha <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants