[full-ci] Improvements to text/md editor #6667

diocas · 2022-03-25T10:00:30Z

I'm trying to push upstream some improvements that we have in our own text-editor so that we can drop it. This PR is to discuss the direction and to have some pointers on how to implement things (sorry, I'm not well versed in Vue, and even less in composition api).

What this PR adds:

Prevents the browser from unloading the page if there's still unsaved changes
Allows ctrl/cmd+s for saving
Displays proper error messages when saving
Asks the user if he wants to save changes when exiting (either by clicking X or go back/forward in history, which might be by mistake)

Still in early stages, I'm also trying to make the app configurable, because we might want to remove the preview pane, since we also want to disable the markdown support (check #6661 )

update-docs · 2022-03-25T10:00:33Z

Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would create a changelog item based on your changes.

dschmidt

Nice start, I have some hints for improvements, but I like where this is going :)

packages/web-app-markdown-editor/src/App.vue

diocas · 2022-03-31T14:57:10Z

@dschmidt thanks for your feedback, it helped me implementing what was missing as well.
I've done what you suggested and finalized what was pending:

Support for read-only files (the user cannot edit the file, only see). I've opened this bug as well: owncloud-design-system#2053
Design polish
Configurable preview pane (it's enabled for md files and disabled for others by default)
No auth in route, for compatibility with public links
More file extensions (it would be great if we could open no extension files..)

I've also renamed it from markdow-editor to simple-editor. I have the impression this naming is clearer for normal users, but if you prefer I can revert that commit.

What is missing is an option to disable md creation, since we would prefer to do it with codimd.
We could also group extensions in the new menu.. But ok, that's a new ticket on its own.

I might need another iteration with the tests.

dschmidt

Much better! I like!

dschmidt · 2022-04-01T18:58:12Z

packages/web-app-simple-editor/src/index.js

+    ...fileExtensionConfig
+  })
+}
+


Not a fan of this, maybe we can register editors for mimetypes in the long run?

As we probably don't have a mechanism for that currently, it's totally out of scope for this PR. Maybe you can open a ticket?

Actually, I built registering apps on mime types in #6514 but that one got stale...

👍 for that! I would like to be able to open files with no extension.

I hope you don't get too overexited with this. Turns out that mime type guessing from the backend isn't always what you'd expect. E.g. ogg video files still get announced with audio/ogg as mime type. But I continued the PR and it's close to being merged.

kulmann · 2022-04-01T19:02:30Z

packages/web-app-simple-editor/src/index.js

@@ -17,8 +19,8 @@ const fileExtensionConfig = {
 }

 const appInfo = {
-  name: 'MarkdownEditor',
-  id: 'markdown-editor',
+  name: 'SimpleEditor',


totally fine with the rename, it's scoped way better than markdown-editor. 👍

ownclouders · 2022-04-06T09:34:56Z

Results for oC10Files2 https://drone.owncloud.com/owncloud/web/24564/18/1

💥 The acceptance tests failed on retry. Please find the screenshots inside ...

webUIFilesActionMenu-fileFolderActionMenu_feature-L14.png

pascalwengerter · 2022-04-06T10:33:27Z

.drone.star

@@ -78,7 +78,7 @@ config = {
                "oC10Files1": [
                    "webUIFilesCopy",
                    "webUIFavorites",
-                    "webUIMarkdownEditor",
+                    "webUISimpleEditor",


@diocas that would need a rename of https://github.com/owncloud/web/tree/master/tests/acceptance/features/webUIMarkdownEditor in order to work :) since it's mapping feature files/folders

kulmann · 2022-04-06T15:19:49Z

@diocas could you search&replace various combinations of the word markdown editor? I found at least one more markdowneditor in an acceptance test feature file. That should probably be simpleeditor now in that case. But maybe there's more.
Also I added [full-ci] to the PR title so that upon your next push the CI won't stop on the first failed acceptance test pipeline but will push through with all pipelines. That should give us a clear picture of what's missing for merge.

Support for read-only files Disable preview for non md files (configurable) Data integrity checks (prevent exiting with unsaved changes) Better error information to the user Keyboard shortcut to save

Enable text editor for other extensions

diocas · 2022-04-07T09:37:45Z

I actually did find&replace, but it took me some time to realize that I filter some folders when I'm in dev mode... Should be fine now, but let's see how the tests go.

diocas · 2022-04-07T09:41:34Z

Btw, what about the disabling of md file creation?

pascalwengerter · 2022-04-07T11:02:29Z

Btw, what about the disabling of md file creation?

What do you mean?

kulmann · 2022-04-07T11:04:53Z

Btw, what about the disabling of md file creation?

Can you open an issue please?

kulmann

Found a typo. Fixing that should finally turn the test suite green 🥳

tests/acceptance/features/webUIFilesActionMenu/fileFolderActionMenu.feature

…nMenu.feature Co-authored-by: Benedikt Kulmann <benedikt@kulmann.biz>

diocas · 2022-04-07T13:03:43Z

@kulmann I had already created #6661, let me know if I need to rephrase it.

sonarcloud · 2022-04-07T13:11:31Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
1 Security Hotspot
2 Code Smells

0.0% Coverage
0.0% Duplication

diocas requested review from pascalwengerter and fschade as code owners March 25, 2022 10:00

diocas marked this pull request as draft March 25, 2022 10:00

diocas added the Early-Adopter:CERN label Mar 25, 2022

diocas requested a review from kulmann March 25, 2022 10:01

dschmidt requested changes Mar 29, 2022

View reviewed changes

packages/web-app-markdown-editor/src/App.vue Outdated Show resolved Hide resolved

packages/web-app-markdown-editor/src/App.vue Outdated Show resolved Hide resolved

packages/web-app-markdown-editor/src/App.vue Outdated Show resolved Hide resolved

diocas force-pushed the md_editor branch from a235327 to b774335 Compare March 31, 2022 14:50

diocas marked this pull request as ready for review March 31, 2022 14:58

diocas changed the title ~~WIP Improvements to text/md editor~~ Improvements to text/md editor Mar 31, 2022

dschmidt approved these changes Apr 1, 2022

View reviewed changes

kulmann reviewed Apr 1, 2022

View reviewed changes

diocas force-pushed the md_editor branch from b774335 to 64a92a9 Compare April 6, 2022 09:16

pascalwengerter reviewed Apr 6, 2022

View reviewed changes

kulmann changed the title ~~Improvements to text/md editor~~ [full-ci] Improvements to text/md editor Apr 6, 2022

diocas added 6 commits April 7, 2022 11:24

Improvements to markdown editor

162aa65

Support for read-only files Disable preview for non md files (configurable) Data integrity checks (prevent exiting with unsaved changes) Better error information to the user Keyboard shortcut to save

Rename Markdown Editor to Simple Editor

fcc9256

Fix text editor for public links

617d3b6

Enable text editor for other extensions

changelog

7c16cba

sonarr cleanup

c4ccfb5

Update acceptance tests

7a46ce6

diocas force-pushed the md_editor branch from ddb7169 to d196d19 Compare April 7, 2022 09:36

Rename Markdown Editor on all tests

46a5bdc

diocas force-pushed the md_editor branch from d196d19 to 46a5bdc Compare April 7, 2022 09:40

kulmann requested changes Apr 7, 2022

View reviewed changes

tests/acceptance/features/webUIFilesActionMenu/fileFolderActionMenu.feature Outdated Show resolved Hide resolved

Update tests/acceptance/features/webUIFilesActionMenu/fileFolderActio…

0cec94a

…nMenu.feature Co-authored-by: Benedikt Kulmann <benedikt@kulmann.biz>

kulmann approved these changes Apr 7, 2022

View reviewed changes

kulmann merged commit 7568691 into owncloud:master Apr 7, 2022

diocas deleted the md_editor branch April 7, 2022 13:55

This was referenced Apr 7, 2022

Add markdown-editor to simple-editor alias for config compatibility #6754

Merged

Public link access for file editor apps #1996

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[full-ci] Improvements to text/md editor #6667

[full-ci] Improvements to text/md editor #6667

diocas commented Mar 25, 2022

update-docs bot commented Mar 25, 2022

dschmidt left a comment

diocas commented Mar 31, 2022 •

edited

dschmidt left a comment

dschmidt Apr 1, 2022

kulmann Apr 1, 2022

diocas Apr 2, 2022

kulmann Apr 6, 2022

kulmann Apr 1, 2022

ownclouders commented Apr 6, 2022 •

edited

webUIFilesActionMenu-fileFolderActionMenu_feature-L14.png

pascalwengerter Apr 6, 2022

diocas Apr 6, 2022

kulmann commented Apr 6, 2022

diocas commented Apr 7, 2022

diocas commented Apr 7, 2022

pascalwengerter commented Apr 7, 2022

kulmann commented Apr 7, 2022

kulmann left a comment

diocas commented Apr 7, 2022

sonarcloud bot commented Apr 7, 2022

[full-ci] Improvements to text/md editor #6667

[full-ci] Improvements to text/md editor #6667

Conversation

diocas commented Mar 25, 2022

update-docs bot commented Mar 25, 2022

dschmidt left a comment

Choose a reason for hiding this comment

diocas commented Mar 31, 2022 • edited

dschmidt left a comment

Choose a reason for hiding this comment

dschmidt Apr 1, 2022

Choose a reason for hiding this comment

kulmann Apr 1, 2022

Choose a reason for hiding this comment

diocas Apr 2, 2022

Choose a reason for hiding this comment

kulmann Apr 6, 2022

Choose a reason for hiding this comment

kulmann Apr 1, 2022

Choose a reason for hiding this comment

ownclouders commented Apr 6, 2022 • edited

webUIFilesActionMenu-fileFolderActionMenu_feature-L14.png

pascalwengerter Apr 6, 2022

Choose a reason for hiding this comment

diocas Apr 6, 2022

Choose a reason for hiding this comment

kulmann commented Apr 6, 2022

diocas commented Apr 7, 2022

diocas commented Apr 7, 2022

pascalwengerter commented Apr 7, 2022

kulmann commented Apr 7, 2022

kulmann left a comment

Choose a reason for hiding this comment

diocas commented Apr 7, 2022

sonarcloud bot commented Apr 7, 2022

diocas commented Mar 31, 2022 •

edited

ownclouders commented Apr 6, 2022 •

edited