New extension WordHighlighter - for highlighting words. #238

lukasMega · 2024-05-21T21:25:55Z

init commit for new extension WordHighlighter - for highlighting words.

discussion, how it started: FreshRSS/FreshRSS#6475

lukasMega · 2024-05-21T21:34:48Z

xExtension-WordHighlighter/extension.php

+		} elseif (Minz_Request::isPost()) {
+			$config = html_entity_decode(Minz_Request::paramString('word-highlighter-conf'));
+			file_put_contents($configFileWithWords, $config);
+			file_put_contents(join_path($staticPath, ('config-words.' . $current_user . '.js')), $this->toJSArray($config));


I'm generating 2 files for configuration.

.txt which represents words to highlight - saved by user (as plaintext, one string per line)

.js is based of .txt which is loaded to page as javascript

Example:

.txt content (config-words.admin.txt):

raspberry pi FreshRSS

and generated .js (config-words.admin.js):

window.WordHighlighterConf = [ 'raspberry pi', 'FreshRSS', ]; console.log({ wordsLoaded: window.WHConfig })

(log will be removed later)

lukasMega · 2024-05-21T21:39:14Z

xExtension-WordHighlighter/static/word-highlighter.js

+HIGHLIGHT_OPTIONS.enableLogs && console.log('WordHighlighter: script load...', { words: window.WordHighlighterConf });
+
+/* eslint-disable */
+//#region <mark.js v9.0.0>


//#region <mark.js v9.0.0> ... //#endregion
used in order to collapse included minified mark.js lib:
it's supported in IntelliJ IDE (Idea, WebStorm, PhpStorm, …) or VSCode:

lukasMega · 2024-05-21T21:49:15Z

currently in this very first version (0.0.1) only one highlighting type (primary) is implemented:

math-GH · 2024-05-22T17:59:31Z

Let me know how I can assist you.

lukasMega · 2024-05-22T19:33:46Z

Let me know how I can assist you.

@math-GH I would appreciate if you go through PHP code because I'm not familiar with PHP ecosystem (I have used PHP probably 10 years ago). Thank you.

Note that I was heavily inspired by extension Custom JS.

After update, config section now looks like:

…(enable_in_article, enable_logs, case_sensitive, separate_word_search) and refactored & simplified code

lukasMega · 2024-05-22T20:50:57Z

also I need help with fixing errors from PHPStan. And I don't know how to trigger automated checks via Github Actions / workflows.

math-GH · 2024-05-22T20:54:27Z

I don't know how to trigger automated checks via Github Actions / workflows.

First-time contributors needs a manual start from an repository admin. I do it for you

xExtension-WordHighlighter/extension.php

… mixed. And add missing types.

Alkarex · 2024-05-22T21:18:01Z

You can run make test-all locally (this assumes that you have your ./Extensions/ and ./FreshRSS/ folders as siblings (i.e. next to each other in the same directory).
See also https://github.com/FreshRSS/Extensions/blob/master/README.md#commands-for-developers

math-GH · 2024-05-22T21:51:51Z

The TR and FR translations does not to be supported if the translation is not done.
English/EN is fine for a start.

lukasMega · 2024-05-23T07:39:59Z

You can run make test-all locally (this assumes that you have your ./Extensions/ and ./FreshRSS/ folders as siblings (i.e. next to each other in the same directory). See also https://github.com/FreshRSS/Extensions/blob/master/README.md#commands-for-developers

unfortunately I don't have proper DEV environment yet. I just edited files on my live running server (RPi5 via SSH)

The TR and FR translations does not to be supported if the translation is not done.
English/EN is fine for a start.

What is the process with translations? Should I delete non English translations? Or should I somehow (with help of Google Translate / DeepL) translate it to other supported languages?

Thank you @math-GH for your help and patience.

Alkarex · 2024-05-23T09:19:53Z

xExtension-WordHighlighter/extension.php

+				$confJson = json_decode(file_get_contents($configFileJson) ?: '', true, 8, JSON_THROW_ON_ERROR);
+				if (json_last_error() !== JSON_ERROR_NONE || !is_array($confJson)) {


I do not believe json_last_error() !== JSON_ERROR_NONE will ever be relevant when you also use JSON_THROW_ON_ERROR. I believe the idea is to use one or the other, not both.

Could you please propose a code change for it as I'm not a PHP dev. I just added that check in order to fix some PHPStan error regarding parsing json.

I have used ChatGPT to help with those errors

those errors: https://github.com/FreshRSS/Extensions/pull/238/checks?check_run_id=25301320234

xExtension-WordHighlighter/extension.php

math-GH · 2024-05-23T19:14:59Z

The TR and FR translations does not to be supported if the translation is not done.
English/EN is fine for a start.

What is the process with translations? Should I delete non English translations? Or should I somehow (with help of Google Translate / DeepL) translate it to other supported languages?

There is no process at all.

Minimum requirement is to have the EN (English) translation that is the fallback for all other languages.

If you like you could add SK (Slovakian) - as I can see in your profile it could be your native language.

If you would like to have German, French and Dutch as translation then ping @Alkarex , @Frenzie and me.

I would suggest not to use an automatic translation to keep the quality and context.

If someone wants to have his/her language in this extension then the source is open to send a PR ;)

Frenzie · 2024-05-23T19:29:55Z

In theory machine translation could be a decent starting point (marked as dirty of course), but in practice it'd probably be unnecessarily annoying to have to double check it against the original.

Alkarex · 2024-08-01T18:42:37Z

Sorry for the delay - I had forgotten about this PR...

init commit for new extension WordHighlighter - for highlighting words.

da84ca2

lukasMega commented May 21, 2024

View reviewed changes

Lukáš Melega added 3 commits May 22, 2024 21:49

use json for storing configuration, add more configuration options …

c84aae8

…(enable_in_article, enable_logs, case_sensitive, separate_word_search) and refactored & simplified code

fix: try to fix test errors

268cb83

fix: try to fix tests

c05725e

math-GH reviewed May 22, 2024

View reviewed changes

xExtension-WordHighlighter/extension.php Outdated Show resolved Hide resolved

Lukáš Melega added 2 commits May 22, 2024 22:59

fix unnecessary casting to string

e76ab5f

fix: try to fix PHPStan errors, mostly: Cannot access offset '...' on…

09c0d24

… mixed. And add missing types.

Lukáš Melega added 2 commits May 22, 2024 23:23

fix: try to fix "Cannot access offset '...' on mixed."

1f40909

fix typo in comment

6f9fd5c

Alkarex reviewed May 23, 2024

View reviewed changes

lukasMega commented May 23, 2024

View reviewed changes

xExtension-WordHighlighter/extension.php Outdated Show resolved Hide resolved

refactor: remove $lineSeparator and replace explode with preg_split

a928549

Alkarex added 2 commits August 1, 2024 20:36

Merge branch 'master' into pr/lukasMega/238

998c664

i18n: fr

838bd7b

Alkarex merged commit 31bbdb5 into FreshRSS:master Aug 1, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New extension WordHighlighter - for highlighting words. #238

New extension WordHighlighter - for highlighting words. #238

lukasMega commented May 21, 2024

lukasMega May 21, 2024

lukasMega May 21, 2024

lukasMega commented May 21, 2024

math-GH commented May 22, 2024

lukasMega commented May 22, 2024 •

edited

Loading

lukasMega commented May 22, 2024

math-GH commented May 22, 2024

Alkarex commented May 22, 2024 •

edited

Loading

math-GH commented May 22, 2024

lukasMega commented May 23, 2024 •

edited

Loading

Alkarex May 23, 2024

lukasMega May 23, 2024

math-GH commented May 23, 2024

Frenzie commented May 23, 2024

Alkarex commented Aug 1, 2024

		$confJson = json_decode(file_get_contents($configFileJson) ?: '', true, 8, JSON_THROW_ON_ERROR);
		if (json_last_error() !== JSON_ERROR_NONE \|\| !is_array($confJson)) {

New extension WordHighlighter - for highlighting words. #238

New extension WordHighlighter - for highlighting words. #238

Conversation

lukasMega commented May 21, 2024

lukasMega May 21, 2024

Choose a reason for hiding this comment

Example:

lukasMega May 21, 2024

Choose a reason for hiding this comment

lukasMega commented May 21, 2024

math-GH commented May 22, 2024

lukasMega commented May 22, 2024 • edited Loading

lukasMega commented May 22, 2024

math-GH commented May 22, 2024

Alkarex commented May 22, 2024 • edited Loading

math-GH commented May 22, 2024

lukasMega commented May 23, 2024 • edited Loading

Alkarex May 23, 2024

Choose a reason for hiding this comment

lukasMega May 23, 2024

Choose a reason for hiding this comment

math-GH commented May 23, 2024

Frenzie commented May 23, 2024

Alkarex commented Aug 1, 2024

lukasMega commented May 22, 2024 •

edited

Loading

Alkarex commented May 22, 2024 •

edited

Loading

lukasMega commented May 23, 2024 •

edited

Loading