Skip to content

Commit

Permalink
chore: bump version to v1.12.8 (#1092)
Browse files Browse the repository at this point in the history
  • Loading branch information
st3v3nmw authored Sep 25, 2024
1 parent d28ae44 commit 5e354cd
Show file tree
Hide file tree
Showing 20 changed files with 64 additions and 63 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Fight the forgetting curve & note aging by reviewing flashcards & notes using sp
- Possible use case: [Incremental writing](https://www.stephenmwangi.com/obsidian-spaced-repetition/notes/#incremental-writing)
- [Statistics](https://www.stephenmwangi.com/obsidian-spaced-repetition/flashcards/#statistics)

## Coming Soon
### Coming Soon

1. FSRS

Expand Down
18 changes: 15 additions & 3 deletions docs/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,24 @@ All notable changes to this project will be documented in this file. Dates are d

Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### Unreleased

Extended card title functionality partly as described in issue [`#851`](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/851)
#### [1.12.8](https://github.com/st3v3nmw/obsidian-spaced-repetition/compare/1.12.7...1.12.8)

- feat: added delay option for the review buttons [`#1049`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1049)
- fix: ignore \*_/_.excalidraw.md files by default [`#1090`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1090)
- fix: Only consider filtered notes for next note [`#1089`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1089)
- fix: Review only due notes [`#1088`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1088)
- feat: extended card title [`#1027`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1027)
- chore: structure docs & utils directories [`#1087`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1087)
- fix: ignore with glob patterns [`#1086`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1086)
- ci: lint PR title [`#1085`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1085)
- fix: Review only due notes (#1088) [`#328`](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/328)
- feat: extended card title (#1027) [`#548`](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/548) [`#1000`](https://github.com/st3v3nmw/obsidian-spaced-repetition/issues/1000)

#### [1.12.7](https://github.com/st3v3nmw/obsidian-spaced-repetition/compare/1.12.6...1.12.7)

> 22 September 2024
- Bump version to v1.12.7 [`#1084`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1084)
- fix: parsing code blocks & custom separators [`#1081`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1081)
- chore: remove e2e testing [`#1083`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1083)
- update french translation [`#1082`](https://github.com/st3v3nmw/obsidian-spaced-repetition/pull/1082)
Expand Down
18 changes: 4 additions & 14 deletions docs/docs/en/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Please note that:
## Code

1. Make your changes.
2. Run `pnpm dev` to test the changes inside Obsidian.
2. Run `pnpm dev` to watch for changes & rebuild the plugin automatically.
3. You could create symbolic links between the build files and the Obsidian vault, example:

```bash
Expand All @@ -96,19 +96,9 @@ Please note that:
5. If your "business logic" is properly decoupled from Obsidian APIs, write some unit tests.
- This project uses [jest](https://jestjs.io/), tests are stored in `tests/`.
- `pnpm test`
6. Add your change to the `[Unreleased]` section of the changelog (`docs/docs/changelog.md`).
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), TL;DR:
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
- You can also append a link to your GitHub profile, example:
- `Make flashcard text selectable [@st3v3nmw](https://github.com/st3v3nmw)`
7. Before pushing your changes, run the linter: `pnpm lint`
6. Before pushing your changes, run the linter: `pnpm lint`
- Format the code in case any warnings are raised: `pnpm format`
8. Open the pull request.
7. Open the pull request.

---

Expand Down Expand Up @@ -167,7 +157,7 @@ Example using `v1.9.2`:
```bash
git add .
git commit -m "Bump version to v1.9.2"
git commit -m "chore: bump version to v1.9.2"
git push --set-upstream origin release-v1.9.2
```
Expand Down
43 changes: 28 additions & 15 deletions docs/docs/zh/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,23 @@ First off, thanks for wanting to contribute to the Spaced Repetition plugin!

## Translating

The plugin has been translated into the following languages by the Obsidian community 😄.

- Arabic / العربية
- Chinese (Simplified) / 简体中文
- Chinese (Traditional) / 繁體中文
- Czech / čeština
- French / français
- German / Deutsch
- Italian / Italiano
- Korean / 한국어
- Japanese / 日本語
- Polish / Polski
- Portuguese (Brazil) / Português do Brasil
- Spanish / Español
- Russian / русский
- Turkish / Türkçe

### Steps

To help translate the plugin to your language:
Expand Down Expand Up @@ -56,10 +73,12 @@ Please note that:
1. Only the strings(templates) on the right of the key should be translated.
2. Text inside `${}` isn't translated. This is used to replace variables in code. For instance, if interval = 4, it becomes `4 days` in English & `Siku 4` in Swahili. Quite nifty if you ask me.

---

## Code

1. Make your changes.
2. Run `pnpm dev` to test the changes inside Obsidian.
2. Run `pnpm dev` to watch for changes & rebuild the plugin automatically.
3. You could create symbolic links between the build files and the Obsidian vault, example:

```bash
Expand All @@ -77,19 +96,11 @@ Please note that:
5. If your "business logic" is properly decoupled from Obsidian APIs, write some unit tests.
- This project uses [jest](https://jestjs.io/), tests are stored in `tests/`.
- `pnpm test`
6. Add your change to the `[Unreleased]` section of the changelog (`docs/docs/changelog.md`).
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), TL;DR:
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
- You can also append a link to your GitHub profile, example:
- `Make flashcard text selectable [@st3v3nmw](https://github.com/st3v3nmw)`
7. Before pushing your changes, run the linter: `pnpm lint`
6. Before pushing your changes, run the linter: `pnpm lint`
- Format the code in case any warnings are raised: `pnpm format`
8. Open the pull request.
7. Open the pull request.

---

## Documentation

Expand Down Expand Up @@ -126,6 +137,8 @@ For larger diffs, it's important that you check how your docs look like as expla
3. Copy the files from the English (`en`) folder into the new folder.
4. Translate then open a pull request.
---
## Maintenance
### Releases
Expand All @@ -144,11 +157,11 @@ Example using `v1.9.2`:
```bash
git add .
git commit -m "Bump version to v1.9.2"
git commit -m "chore: bump version to v1.9.2"
git push --set-upstream origin release-v1.9.2
```
5. Open and merge the PR into `master`.
6. Locally, switch back to `master` and pull the changes: `git switch master && git pull`
7. Create a git tag with the version: `git tag 1.9.2`
7. Create a git tag with the version: `git tag -a 1.9.2 -m "1.9.2"`
8. Push the tag: `git push --tags`. <br> You're all set! [This GitHub action](https://github.com/st3v3nmw/obsidian-spaced-repetition/blob/master/.github/workflows/release.yml) should pick it up, create a release, publish it, and update the live documentation.
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "obsidian-spaced-repetition",
"name": "Spaced Repetition",
"version": "1.12.7",
"version": "1.12.8",
"minAppVersion": "1.2.8",
"description": "Fight the forgetting curve by reviewing flashcards & entire notes.",
"author": "Stephen Mwangi",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "obsidian-spaced-repetition",
"version": "1.12.7",
"version": "1.12.8",
"description": "Fight the forgetting curve by reviewing flashcards & entire notes.",
"main": "main.js",
"scripts": {
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/ar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: '"تخصيص التسمية للزر "جيد',
FLASHCARD_HARD_DESC: '"تخصيص التسمية للزر "صعب',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "وُسوم البطاقات",
FLASHCARD_TAGS_DESC: "#2أدخل الوُسوم مفصولة بمسافات أو أسطر جديدة ، أي بطاقات# رزمة3# رزمة",
CONVERT_FOLDERS_TO_DECKS: "تحويل المجلدات إلى ملفات أصلية و ملفات الفرعية؟",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/cz.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Tag pro kartičky",
FLASHCARD_TAGS_DESC:
"Zadete tagy oodělené mezerou nebo odřádkováním například. #kartičky #balíčke2 #balíček3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Flashcard tags",
FLASHCARD_TAGS_DESC:
"Enter tags separated by spaces or newlines i.e. #flashcards #deck2 #deck3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/es.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: "Personalize la etiqueta para el botón: Bien",
FLASHCARD_HARD_DESC: "Personalize la etiqueta para el botón: Difícil",
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Etiquetas de las Tarjetas de Memorización",
FLASHCARD_TAGS_DESC:
"Escriba las etiquetas separadas por espacios o saltos de línea, por ejemplo, #memorizar #mazo2 #mazo3",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/fr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,7 @@ export default {
FLASHCARD_GOOD_DESC: "Changez le texte du bouton Correct",
FLASHCARD_HARD_DESC: "Changez le texte du bouton Difficile",
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Tags des flashcards",
FLASHCARD_TAGS_DESC:
"Entrez les tags séparés par un espace ou une ligne i.e. #flashcards #paquet2 #paquet3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/it.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Personalizza il testo per il pulsante "Buono"',
FLASHCARD_HARD_DESC: 'Personalizza il testo per il pulsante "Difficile"',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Etichette delle schede",
FLASHCARD_TAGS_DESC:
"Inserire etichette separate da spazi o a capi, per esempio #flashcards #deck2 #deck3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/ja.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "フラッシュカードに使用するタグ",
FLASHCARD_TAGS_DESC:
'タグをスペースまたは改行で区切って入力してください。例: "#flashcards #deck2 #deck3"',
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/ko.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Customize the label for the "Good" Button',
FLASHCARD_HARD_DESC: 'Customize the label for the "Hard" Button',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "플래시카드 태그",
FLASHCARD_TAGS_DESC:
"태그를 공백 또는 빈 줄로 구분해서 입력해주세요. 예) '#flashcards #deck2 #deck3'",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/pl.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Dostosuj etykietę dla przycisku "Średnio trudne"',
FLASHCARD_HARD_DESC: 'Dostosuj etykietę dla przycisku "Trudne"',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Tagi fiszek",
FLASHCARD_TAGS_DESC:
"Wprowadź tagi oddzielone spacją lub nowymi liniami, np. #fiszki #talia2 #talia3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/pt-br.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Customize o rótulo para o botão de "OK"',
FLASHCARD_HARD_DESC: 'Customize o rótulo para o botão de "Difícil"',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Etiquetas dos Flashcards",
FLASHCARD_TAGS_DESC:
"Insira etiquetas separadas por espaços ou quebras de linha ex: #flashcards #baralho2 #baralho3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/ru.ts
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@ export default {
FLASHCARD_GOOD_DESC: 'Настроить ярлык для кнопки "Нормально"',
FLASHCARD_HARD_DESC: 'Настроить ярлык для кнопки "Сложно"',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Теги карточек",
FLASHCARD_TAGS_DESC:
"Укажите теги разделенные Enter-ом или пробелом, например: #flashcards #deck2 #deck3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/tr.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: '"Orta" butonunun metnini özelleştirin',
FLASHCARD_HARD_DESC: '"Zor" butonunun metnini özelleştirin',
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "Flash Kart Etiketleri",
FLASHCARD_TAGS_DESC:
"Etiketleri boşluklar veya yeni satırlarla ayırarak girin, örneğin: #flashcards #deck2 #deck3.",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/zh-cn.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: "自定义“记得”按钮的标签",
FLASHCARD_HARD_DESC: "自定义“较难”按钮的标签",
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "卡片标签",
FLASHCARD_TAGS_DESC: "输入标签,用空格或新建行分隔,例如:#flashcards #deck2 #deck3.",
CONVERT_FOLDERS_TO_DECKS: "是否将文件夹内容转换为卡片组和子卡片组?",
Expand Down
3 changes: 1 addition & 2 deletions src/lang/locale/zh-tw.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,7 @@ export default {
FLASHCARD_GOOD_DESC: "自訂「記得」按鈕的標籤",
FLASHCARD_HARD_DESC: "自訂「較難」按鈕的標籤",
REVIEW_BUTTON_DELAY: "Button press delay (ms)",
REVIEW_BUTTON_DELAY_DESC:
"Add a delay to the review buttons('Easy', 'Good', 'Hard', 'Show answer') before they could be pressed again.",
REVIEW_BUTTON_DELAY_DESC: "Add a delay to the review buttons before they can be pressed again.",
FLASHCARD_TAGS: "卡片標籤",
FLASHCARD_TAGS_DESC: "輸入標籤(用空白或換行字元分隔),例如:#flashcards #deck2 #deck3.",
CONVERT_FOLDERS_TO_DECKS: "是否將資料夾內容轉換為牌組和子牌組?",
Expand Down

0 comments on commit 5e354cd

Please sign in to comment.