search

imazen / imageflow

High-performance image manipulation for web servers. Includes imageflow_server, imageflow_tool, and libimageflow
https://docs.imageflow.io/
GNU Affero General Public License v3.0
4.14k stars 140 forks source link

Readme presentation tweaks #595

Closed petecooper closed 2 years ago

petecooper commented 2 years ago

No code changes.

github-actions[bot] commented 2 years ago

@check-spelling-bot Report

:red_circle: Please review

Unrecognized words (4) ``` Debounce Jfif Mozilla sys ```
Previously acknowledged words that are now absent bc ci classpath clj cx debounce dequantize df dh eb eol ericsson erl fd fh fsx gb gh gitattributes gx gy gz hxx ip jfif jq Jv kp libz lz mjpeg Mozilla's mx Mz nc px py qa rb resx ri rw ry scss sql sx sy SZ td tt uk unzigzagged upsampler vn vx vy Wx xf xn xp xproj xy ycbcr zd zr zu
Available dictionaries could cover words not in the dictionary [cspell:cpp/cpp.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/cpp/cpp.txt) (104293) covers 285 of them [cspell:html/html.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/html/html.txt) (542) covers 119 of them [cspell:css/css.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/css/css.txt) (993) covers 114 of them [cspell:filetypes/filetypes.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/filetypes/filetypes.txt) (337) covers 42 of them [cspell:django/django.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/django/django.txt) (2342) covers 30 of them [cspell:golang/go.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/golang/go.txt) (7745) covers 24 of them [cspell:fullstack/fullstack.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/fullstack/fullstack.txt) (181) covers 24 of them [cspell:aws/aws.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/aws/aws.txt) (1485) covers 23 of them [cspell:java/java.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/java/java.txt) (33524) covers 20 of them [cspell:npm/npm.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/npm/npm.txt) (671) covers 17 of them [cspell:rust/rust.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/rust/rust.txt) (112) covers 16 of them [cspell:scala/scala.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/scala/scala.txt) (2752) covers 13 of them [cspell:python/python.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/python/python.txt) (364) covers 11 of them [cspell:lua/lua.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/lua/lua.txt) (391) covers 10 of them [cspell:csharp/csharp.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/csharp/csharp.txt) (123) covers 8 of them [cspell:ruby/ruby.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/ruby/ruby.txt) (354) covers 6 of them [cspell:php/php.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/php/php.txt) (9785) covers 5 of them [cspell:dotnet/dotnet.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/dotnet/dotnet.txt) (9824) covers 3 of them [cspell:bash/bash-words.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/bash/bash-words.txt) (22) covers 1 of them [cspell:ada/ada.txt](https://raw.githubusercontent.com/check-spelling/cspell-dicts/HEAD/dictionaries/ada/ada.txt) (72) covers 1 of them Consider adding them using: ``` with: extra_dictionaries: cspell:cpp/cpp.txt cspell:html/html.txt cspell:css/css.txt cspell:filetypes/filetypes.txt cspell:django/django.txt cspell:golang/go.txt cspell:fullstack/fullstack.txt cspell:aws/aws.txt cspell:java/java.txt cspell:npm/npm.txt cspell:rust/rust.txt cspell:scala/scala.txt cspell:python/python.txt cspell:lua/lua.txt cspell:csharp/csharp.txt cspell:ruby/ruby.txt cspell:php/php.txt cspell:dotnet/dotnet.txt cspell:bash/bash-words.txt cspell:ada/ada.txt ``` To stop checking additional dictionaries, add: ``` with: check_extra_dictionaries: '' ```
Some files were automatically ignored These sample patterns would exclude them: ``` ^\.gitattributes$ ^\.idea/\.name$ ^\.idea/dictionaries/lilith\.xml$ ^\.idea/dictionaries/n\.xml$ ^c_components/\.idea/imageflow_c\.iml$ ^c_components/src/lib\.rs$ ^ci/cloud/mods/download_imageflow\.sh$ ^ci/packaging_extras/requirements/ubuntu_16_04-x86_64\.txt$ ^ci/packaging_extras/requirements/ubuntu_18_04-x86_64\.txt$ ^docs/src/imageflow_server\.md$ ^docs/src/imageflow_tool\.md$ ``` You should consider excluding directory paths (e.g. `(?:^|/)vendor/`), filenames (e.g. `(?:^|/)yarn\.lock$`), or file extensions (e.g. `\.gz$`) You should consider adding them to: ``` .github/actions/spell-check/excludes.txt ``` File matching is via Perl regular expressions. To check these files, more of their words need to be in the dictionary than not. You can use `patterns.txt` to exclude portions, add items to the dictionary (e.g. by adding them to `allow.txt`), or fix typos.
To accept these unrecognized words as correct (and remove the previously acknowledged and now absent words), run the following commands ... in a clone of the [git@github.com:petecooper/imageflow.git](https://github.com/petecooper/imageflow.git) repository on the `main` branch: ``` update_files() { perl -e ' my @expect_files=qw('".github/actions/spell-check/expect/expect.txt"'); @ARGV=@expect_files; my @stale=qw('"$patch_remove"'); my $re=join "|", @stale; my $suffix=".".time(); my $previous=""; sub maybe_unlink { unlink($_[0]) if $_[0]; } while (<>) { if ($ARGV ne $old_argv) { maybe_unlink($previous); $previous="$ARGV$suffix"; rename($ARGV, $previous); open(ARGV_OUT, ">$ARGV"); select(ARGV_OUT); $old_argv = $ARGV; } next if /^(?:$re)(?:(?:\r|\n)*$| .*)/; print; }; maybe_unlink($previous);' perl -e ' my $new_expect_file=".github/actions/spell-check/expect/018321b4c4e0258088986bc3dfea300753eb708a.txt"; use File::Path qw(make_path); use File::Basename qw(dirname); make_path (dirname($new_expect_file)); open FILE, q{<}, $new_expect_file; chomp(my @words = ); close FILE; my @add=qw('"$patch_add"'); my %items; @items{@words} = @words x (1); @items{@add} = @add x (1); @words = sort {lc($a)."-".$a cmp lc($b)."-".$b} keys %items; open FILE, q{>}, $new_expect_file; for my $word (@words) { print FILE "$word\n" if $word =~ /\w/; }; close FILE; system("git", "add", $new_expect_file); ' (cat '.github/actions/spell-check/excludes.txt' - < '.github/actions/spell-check/excludes.txt.temp' && mv '.github/actions/spell-check/excludes.txt.temp' '.github/actions/spell-check/excludes.txt' } comment_json=$(mktemp) curl -L -s -S \ -H "Content-Type: application/json" \ "https://api.github.com/repos/imazen/imageflow/issues/comments/1100653080" > "$comment_json" comment_body=$(mktemp) jq -r ".body // empty" "$comment_json" > $comment_body rm $comment_json patch_remove=$(perl -ne 'next unless s{^(.*)
$}{$1}; print' < "$comment_body") patch_add=$(perl -e '$/=undef; $_=<>; print "$1" if m{Unrecognized words[^<]*\n*```\n*([^<]*)```\n*$}m;' < "$comment_body") update_files rm $comment_body git add -u ```
lilith commented 2 years ago

This looks good to me, not sure why it was closed?

petecooper commented 2 years ago

@lilith - I didn't have the resources to run the remediation for the failed tests, so I closed it and made a note to return when I had the time available.