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

chore(merge): pull request for patch/v3.0.1 #76

Merged
merged 19 commits into from
Nov 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
c1a65fb
fix(docs): update some required information about plugin in README
Falcion Nov 5, 2024
68b3824
fix(locales): sync locales and implement them in stale settings tab
Falcion Nov 5, 2024
ea6f6f2
fix(locales): sync locales between languages and fix bug when setting…
Falcion Nov 5, 2024
969afd4
build(esbuild): add plugin to automatically copy files of plugin buil…
Falcion Nov 5, 2024
7301437
build(esbuild-tracking): write special .BAT script to disable worktre…
Falcion Nov 5, 2024
e56c1bb
chore(esbuild): fix mispronounces in code, add namings to plugins
Falcion Nov 5, 2024
aea3114
fix(settings): now "use default extensions" and input are synchronize…
Falcion Nov 5, 2024
4a2b3f7
docs(settings): add warning about case-insensitive mode in settings
Falcion Nov 5, 2024
1f7bd8f
chore(versions-semantics): update unsupported versions and issues wit…
Falcion Nov 5, 2024
5fa385c
chore(semantics): write a little semantics about different tags of re…
Falcion Nov 5, 2024
166b6ca
fix(locales-settings): remove misinformation about separating symbols
Falcion Nov 5, 2024
722e361
docs(settings): add warning about errors spam in extensions input
Falcion Nov 5, 2024
188eb0d
chore*(miscommit): fix of miscommit
Falcion Nov 5, 2024
8fe545d
fix(compatibility-module): fix skipping work process after getting un…
Falcion Nov 5, 2024
590f81d
feat(modals): now modals support code editor extensions integration
Falcion Nov 5, 2024
19bd4e6
fix(modals): now modals are trying to apply new extensions in plugin …
Falcion Nov 5, 2024
a8934ce
fix(rendering-extensions): sync default extensions and code extensions
Falcion Nov 5, 2024
55b459c
chore(release): 3.0.1
Falcion Nov 5, 2024
3b3c7e8
chore: add release note for 3.0.1
Falcion Nov 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,9 @@ body:
label: Version of an project's essence
description: What version of an project's essence are you running.
options:
- "2.2.1"
- "2.2.0"
- "2.1.3"
- "2.1.2"
- "2.1.1"
- "2.1.0"
- "2.0.0"
- "3.0.1"
- "3.0.0"
- "Other (specify in issue)"
default: 0
validations:
required: true
Expand All @@ -54,6 +50,7 @@ body:
- macOS
- Linux
- Mobile (specify)
- Not important
- type: checkboxes
id: terms
attributes:
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/03_feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ body:
- Windows
- macOS
- Linux
- Mobile (specify)
- Not important
- type: checkboxes
id: terms
Expand Down
13 changes: 5 additions & 8 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@
"no-inline-html": {
"allowed_elements": [
"br",
"details",
"p",
"a",
"div",
"img",
"li",
"summary",
"ul",
"unknown",
"Tabs",
"TabItem"
"h3"
]
}
}
}
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,37 @@

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [3.0.1](https://github.com/mokkapps/changelog-generator-demo/compare/v3.0.0...v3.0.1) (2024-11-05)


### Features

* **modals:** now modals support code editor extensions integration ([590f81d](https://github.com/mokkapps/changelog-generator-demo/commits/590f81dbc221adbef9d733abbe60d55733500d57))


### Build system

* **esbuild-tracking:** write special .BAT script to disable worktree for esbuild ([7301437](https://github.com/mokkapps/changelog-generator-demo/commits/73014372429512064e4a6c458ac271be681039c4))
* **esbuild:** add plugin to automatically copy files of plugin build to test folder ([969afd4](https://github.com/mokkapps/changelog-generator-demo/commits/969afd4b69646905166e019f2fd762fdcf0d3373))


### Documentation

* **settings:** add warning about case-insensitive mode in settings ([4a2b3f7](https://github.com/mokkapps/changelog-generator-demo/commits/4a2b3f71dd14a27580fbe561543be44343d59a11))
* **settings:** add warning about errors spam in extensions input ([722e361](https://github.com/mokkapps/changelog-generator-demo/commits/722e361e51cb0fddfe707816505369b001d9c3a6))


### Fixes

* **compatibility-module:** fix skipping work process after getting undefined field in compatibility module ([8fe545d](https://github.com/mokkapps/changelog-generator-demo/commits/8fe545d447f9cf8ea5dee6b0f04a3c3280f75058))
* **docs:** update some required information about plugin in README ([c1a65fb](https://github.com/mokkapps/changelog-generator-demo/commits/c1a65fbe8b95a83edd0389a99b9aaaf3ae07d51d)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
* **locales-settings:** remove misinformation about separating symbols ([166b6ca](https://github.com/mokkapps/changelog-generator-demo/commits/166b6ca2c9a38a8ec8307fc8daeb7f4f0ae10e08)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
* **locales:** sync locales and implement them in stale settings tab ([68b3824](https://github.com/mokkapps/changelog-generator-demo/commits/68b382494a37026f4a732a3cd04a34ab55e5e326))
* **locales:** sync locales between languages and fix bug when settings appear null ([ea6f6f2](https://github.com/mokkapps/changelog-generator-demo/commits/ea6f6f25df0fc372afe5062034481886db625c03)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
* **modals:** now modals are trying to apply new extensions in plugin and fix of semantics for separators ([19bd4e6](https://github.com/mokkapps/changelog-generator-demo/commits/19bd4e65107b3bb0b19c51e8e9f2e9642a3215cd))
* **rendering-extensions:** sync default extensions and code extensions ([a8934ce](https://github.com/mokkapps/changelog-generator-demo/commits/a8934ce171ee94965ca16b869f899ae17ac7a9f8))
* **settings:** now "use default extensions" and input are synchronized in settings tab ([aea3114](https://github.com/mokkapps/changelog-generator-demo/commits/aea311487557040916375da8677b39249d5e56f1)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)

## [3.0.0](https://github.com/mokkapps/changelog-generator-demo/compare/v2.4.0...v3.0.0) (2024-11-03)


Expand Down
31 changes: 13 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@
<!-- ABOUT THE PROJECT:
-->

About the project
-----------------
## About the project

Unfortunately, Obsidian™ does not, for some reason, have the ability to edit any file extensions that the user would like to edit, and the plugins that exist for this application are an inconvenient format for the end user, for example, entering a full-fledged JSON in one line.

Expand All @@ -54,8 +53,7 @@ Project is created and “written” with help of:
<!-- GETTING STARTED
-->

Getting started
---------------
## Getting started

Before asking questions, read this block because here is all the primary information on the project, which can answer your future not-yet asked questions.

Expand Down Expand Up @@ -102,22 +100,22 @@ Guidelines for installation of source code of this project:
<!-- USAGE:
-->

Usage
-----
## Usage

Usage of UNITADE plugin is very easy and comfortable for common user, by default, you can edit any plain text (.TXT) files in your vault, but if you want to add custom extensions, you can easy do it with plugin's settings, there is an instruction:

1. Go to your vault's settings and seek for "community plugins" sector, if you have restricted mode, repeat first and second steps of official installation guide[^2];
2. If you have installed plugin and app saw it, you can see element named "UNITADE": open it and seek for setting named “extensions” and type an array of extensions, separated by comma;
2. If you have installed plugin and app saw it, you can see element named "UNITADE": open it and seek for setting named “extensions” and type an array of extensions, separated by "greater-than sign" (`>`);
- This method applies only if you want to read files as .MD extensions, for more information about settings, modes and other things in the plugin, read the wikipedia of plugin:
<https://github.com/Falcion/UNITADE.md/wiki>
3. Now, you can edit extensions which you typed in settings.

<p align="right"><a href="#readme-top" title="Back to the top of README">[^]</a></p>

<!-- ROADMAP:
-->

Roadmap
-------
## Roadmap

<!--
This roadmap is general and initial,
Expand All @@ -142,8 +140,7 @@ Roadmap
<!-- CONTRIBUTING:
-->

Contributing
------------
## Contributing

Contributions are what make open source community such an interest place to be in, so any form of contribution are greatly appreciated.

Expand All @@ -154,17 +151,17 @@ If you want to contribute to this project, please, read contributioning policy a
> For one-single file contributioning, use a more quicker way without forking the repository through website.

More about it in this article:

- [“Working with forks”](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork/) about syncing one-file fork;

<p align="right"><a href="#readme-top" title="Back to the top of README">[^]</a></p>

<!-- LICENSE:
-->

License
-------
## License

Project thanks the [Electron.js](https://github.com/electron/electron/) and [Angular.js](https://github.com/angular/angular/) for their amazing repository scripts and entire infrastructure, which partially were imported to this repository.
Project thanks the [Electron.js](https://github.com/electron/electron/) and [Angular.js](https://github.com/angular/angular/) for their amazing repository scripts and entire infrastructure, which partially were imported to this repository.

> For individual licensing and credits information, seek correspondive files and/or sources.

Expand All @@ -181,8 +178,7 @@ Project itself is being distributed under the [MIT License](https://choosealicen
<!-- CONTACT:
-->

Contact
-------
## Contact

For any legal purposes, you can contact developer/maintainer through its e-mail:

Expand All @@ -198,8 +194,7 @@ If the developer/maintainer didn't answered, or you have other questions in natu
<!-- ACKNOWLEDGEMENTS:
-->

Acknowledgments
---------------
## Acknowledgments

- https://shields.io/
- https://simpleicons.org/
Expand Down
34 changes: 29 additions & 5 deletions UNSUPPORTED_VERSIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,50 @@ Before publishing issue, PRs to any version of plugin check, is this version sup
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.1.0">2.1.0</a></td>
<td style="text-align: center" align="center"></td>
<td style="text-align: center" align="center"></td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.1.1">2.1.1</a></td>
<td style="text-align: center" align="center"></td>
<td style="text-align: center" align="center"></td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.1.2">2.1.2</a></td>
<td style="text-align: center" align="center"></td>
<td style="text-align: center" align="center"></td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.1.3">2.1.3</a></td>
<td style="text-align: center" align="center"></td>
<td style="text-align: center" align="center"></td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.2.0">2.2.0</a></td>
<td style="text-align: center" align="center"></td>
<td style="text-align: center" align="center"></td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.2.1">2.2.1</a></td>
<td style="text-align: center" align="center">❎</td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.2.1">2.2.1</a></td>
<td style="text-align: center" align="center">❎</td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.3.0">2.3.0</a></td>
<td style="text-align: center" align="center">❎</td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.3.1">2.3.1</a></td>
<td style="text-align: center" align="center">❎</td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/2.4.0">2.4.0</a></td>
<td style="text-align: center" align="center">❎</td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/3.0.0">3.0.0</a></td>
<td style="text-align: center" align="center">❎</td>
</tr>
<tr>
<td style="text-align: center"><a href="https://github.com/Falcion/UNITADE.md/tree/3.0.1">3.0.1</a></td>
<td style="text-align: center" align="center">✅</td>
</tr>
</table>
Expand Down
25 changes: 25 additions & 0 deletions build-tracking.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
SET "CLONESH=esbuild.config.mjs"

FOR /F "tokens=*" %%i IN ('git ls-files -v %CLONESH%') DO SET "CURRENT_STATUS=%%i"

IF "%CURRENT_STATUS:~0,1%"=="S" (
ECHO Currently, the file %CLONESH% is skipped.
ECHO Turning file tracking back ON...
git update-index --no-skip-worktree "%CLONESH%"
IF ERRORLEVEL 0 (
ECHO File tracking turned on successfully.
) ELSE (
ECHO Error: Could not turn file tracking on.
)
) ELSE (
ECHO Currently, the file %CLONESH% is being tracked.
ECHO Turning file tracking OFF...
git update-index --skip-worktree "%CLONESH%"
IF ERRORLEVEL 0 (
ECHO File tracking turned off successfully.
) ELSE (
ECHO Error: Could not turn file tracking off.
)
)

EXIT /B 0
4 changes: 4 additions & 0 deletions data/release/semantics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
The semantics of UNITADE are defined by two release formats:

1. **Releases following the "v\*." pattern**: These releases are created specifically for Semantic Versioning purposes, are independent of Obsidian’s release system, and do not include release notes.
2. **Releases following the "\*." pattern**: These are special releases intended for Obsidian’s plugin update system and include release notes.
53 changes: 53 additions & 0 deletions data/release/v3.0.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
### UNITADE.md Plugin for Obsidian v3.0.1 - Release Patch Notes

This v3.0.1 patch release focuses on minor enhancements, optimizations, and additional guidance for key features, improving overall functionality and user experience.

---

**Improvements and Fixes:**

- **README and Settings Tab Updates:** Adjusted the README and settings tab to reflect new extension "splitting" semantics, enhancing clarity on configuration and usage.
- **Asynchronous Language Loading (Locales):** Improved asynchronous loading for localization files, ensuring smoother, more reliable multi-language support across the plugin.
- **Error-Spamming Commentary:** Added a comment within the settings block about error-spamming behavior, with a note on how "error silencing" can mitigate unnecessary log entries in specific cases.
- **Code Editor Display Mode Update:** Resolved an issue with asynchronous extension loading in the code editor display mode, improving compatibility and display accuracy.
- **"Use Default Extensions" Note:** Added an in-app comment explaining the basic functionality of the "use default extensions" option, with references to the wiki for advanced details.
- **Case-Insensitive Mode Warning:** Introduced a prominent warning for case-insensitive mode. Due to potential risks, users are cautioned that enabling this mode may cause their vault to crash if applied recklessly. This mode can be safely disabled through the plugin’s JSON config if issues arise.
- **Supported Versions and Issues Templates Update:** Updated supported version files and issue templates to ensure compatibility documentation aligns with the latest plugin functionality.
- **Release Semantics File:** Added a dedicated semantics file in the releases folder, summarizing key changes for reference.
- **"Add to Code Editor Settings" Option:** Introduced an option to add configurations to code editor settings, with a note that this and the core settings are not mutually exclusive but may conflict if both are active simultaneously.
- **Separator Symbol Update:** Adjusted the extension separator symbol from `;` to `>`, aligning with updated parsing rules and improving consistency across plugin versions.
- **Compatibility Module Fix:** Enhanced the compatibility module to eliminate "skipping" behavior following an error in replacement functions, improving reliability.
- **Default Extensions Rendering in Code Editor:** Updated the code editor to render default extensions first as code, followed by markdown formatting, for a clearer, more functional display.

This patch builds upon the v3.0.0 foundation, delivering critical updates to compatibility, user guidance, and interface consistency.

### [3.0.1](https://github.com/mokkapps/changelog-generator-demo/compare/v3.0.0...v3.0.1) (2024-11-05)


### Features

* **modals:** now modals support code editor extensions integration ([590f81d](https://github.com/mokkapps/changelog-generator-demo/commits/590f81dbc221adbef9d733abbe60d55733500d57))


### Build system

* **esbuild-tracking:** write special .BAT script to disable worktree for esbuild ([7301437](https://github.com/mokkapps/changelog-generator-demo/commits/73014372429512064e4a6c458ac271be681039c4))
* **esbuild:** add plugin to automatically copy files of plugin build to test folder ([969afd4](https://github.com/mokkapps/changelog-generator-demo/commits/969afd4b69646905166e019f2fd762fdcf0d3373))


### Documentation

* **settings:** add warning about case-insensitive mode in settings ([4a2b3f7](https://github.com/mokkapps/changelog-generator-demo/commits/4a2b3f71dd14a27580fbe561543be44343d59a11))
* **settings:** add warning about errors spam in extensions input ([722e361](https://github.com/mokkapps/changelog-generator-demo/commits/722e361e51cb0fddfe707816505369b001d9c3a6))


### Fixes

* **compatibility-module:** fix skipping work process after getting undefined field in compatibility module ([8fe545d](https://github.com/mokkapps/changelog-generator-demo/commits/8fe545d447f9cf8ea5dee6b0f04a3c3280f75058))
* **docs:** update some required information about plugin in README ([c1a65fb](https://github.com/mokkapps/changelog-generator-demo/commits/c1a65fbe8b95a83edd0389a99b9aaaf3ae07d51d)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
* **locales-settings:** remove misinformation about separating symbols ([166b6ca](https://github.com/mokkapps/changelog-generator-demo/commits/166b6ca2c9a38a8ec8307fc8daeb7f4f0ae10e08)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
* **locales:** sync locales and implement them in stale settings tab ([68b3824](https://github.com/mokkapps/changelog-generator-demo/commits/68b382494a37026f4a732a3cd04a34ab55e5e326))
* **locales:** sync locales between languages and fix bug when settings appear null ([ea6f6f2](https://github.com/mokkapps/changelog-generator-demo/commits/ea6f6f25df0fc372afe5062034481886db625c03)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
* **modals:** now modals are trying to apply new extensions in plugin and fix of semantics for separators ([19bd4e6](https://github.com/mokkapps/changelog-generator-demo/commits/19bd4e65107b3bb0b19c51e8e9f2e9642a3215cd))
* **rendering-extensions:** sync default extensions and code extensions ([a8934ce](https://github.com/mokkapps/changelog-generator-demo/commits/a8934ce171ee94965ca16b869f899ae17ac7a9f8))
* **settings:** now "use default extensions" and input are synchronized in settings tab ([aea3114](https://github.com/mokkapps/changelog-generator-demo/commits/aea311487557040916375da8677b39249d5e56f1)), closes [#73](https://github.com/Falcion/UNITADE.md/issues/73)
23 changes: 20 additions & 3 deletions esbuild.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ if you want to view the source, please visit the github repository of this plugi
`;

let assigner = {
name: 'main',
name: 'assigner',
setup(build) {
build.onEnd(() => {
const main = fs.readFileSync('main.css', 'utf8');
Expand All @@ -27,14 +27,30 @@ let assigner = {
}

let manifest = {
name: 'main',
name: 'manifest',
setup(build) {
build.onEnd(() => {
fs.writeFileSync('out/manifest.json', fs.readFileSync('manifest.json'), 'utf8');
});
}
}

let autotest = {
name: 'autotest',
setup(build) {
build.onEnd(() => {
const PUT_YOUR_PATH_HERE_IF_ENABLED = '';
const ENABLED = false;

if (ENABLED) {
fs.copyFileSync('out/manifest.json', PUT_YOUR_PATH_HERE_IF_ENABLED);
fs.copyFileSync('out/main.js', PUT_YOUR_PATH_HERE_IF_ENABLED);
fs.copyFileSync('out/styles.css', PUT_YOUR_PATH_HERE_IF_ENABLED);
}
});
}
}

const prod = (process.argv[2] === "production");

const context = await esbuild.context({
Expand Down Expand Up @@ -63,7 +79,8 @@ const context = await esbuild.context({
},
},
assigner,
manifest
manifest,
autotest
],
bundle: true,
external: [
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "unitade",
"name": "UNITADE.md",
"version": "3.0.0",
"version": "3.0.1",
"minAppVersion": "1.0.0",
"description": "Effortlessly treat any file extension as note, organize diverse file formats in your vault and take advancements in control of extension system even with custom modals.",
"author": "Falcion",
Expand Down
Loading