Bug 1935984 - Review Request: js-termynal - Lightweight and modern terminal animations using async/await
Summary: Review Request: js-termynal - Lightweight and modern terminal animations usin...
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Robert-André Mauchin 🐧
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard: Trival
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-03-05 20:46 UTC by Ben Beasley
Modified: 2021-03-26 17:52 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-03-22 02:07:46 UTC
Type: ---
Embargoed:
zebob.m: fedora-review+


Attachments (Terms of Use)

Description Ben Beasley 2021-03-05 20:46:15 UTC
Spec URL: https://gitlab.com/musicinmybrain/fedora-rpm/-/raw/1cfaa66e2c4f482377929583493e65ebc484a8f4/js-termynal.spec
SRPM URL: https://kojipkgs.fedoraproject.org//work/tasks/7506/63157506/js-termynal-0.0.1-1.20210305git9b30189.fc35.src.rpm
Description:

Typing animations are nothing new and Termynal isn’t particularly
revolutionary. The author wrote it because they needed a modern and lightweight
version with minimal JavaScript and without messy, nested setTimeout calls.
Most of the existing libraries rely on JavaScript for both the rendering,
styling and animation, or even require jQuery. This is inconvenient, especially
if you’re using the animation as part of your software’s documentation. If a
user has JavaScript disabled, they will only see a blank window.

Termynal uses async and await, which is now supported pretty much across all
major browsers. Termynal lets you write all input and output in plain HTML, and
all styling in plain CSS. Non-JS users will still see the complete code, just
no animation. The width and height of the terminal window is read off the
original container. This means you won’t have to worry about sizing or layout
reflows. Termynal also comes with a flexible HTML API, so you can use it
without having to write a single line of JavaScript yourself.

Fedora Account System Username: music

Koji builds:

F35: https://koji.fedoraproject.org/koji/taskinfo?taskID=63157505
F34: https://koji.fedoraproject.org/koji/taskinfo?taskID=63157884
F33: https://koji.fedoraproject.org/koji/taskinfo?taskID=63158183

(F32 lacks esbuild. I could package it without minification, or possibly use uglify-js, but there is no need to bother.)

This package is needed for the full HTML documentation of python-fastapi.

Comment 1 Ben Beasley 2021-03-05 23:17:36 UTC
Marking this as a trivial review. Please consult https://docs.fedoraproject.org/en-US/packaging-guidelines/JavaScript/ for applicable guidelines.

It appears gitlab is serving a 403 error to the fedora-review tool even though the spec URL is otherwise good, perhaps by blocking user-agents not on a whitelist. This is obnoxious. The following URL should work for everyone: https://music.fedorapeople.org/js-termynal.spec

Comment 2 Robert-André Mauchin 🐧 2021-03-16 07:51:42 UTC
Package approved.


Package Review
==============

Legend:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed



===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses
     found: "Expat License", "Unknown or generated". 6 files have unknown
     license. Detailed output of licensecheck in
     /home/bob/packaging/review/js-termynal/review-js-
     termynal/licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory
     names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 20480 bytes in 4 files.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least
     one supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: There are rpmlint messages (see attachment).
[x]: If (and only if) the source package includes the text of the
     license(s) in its own file, then that file, containing the text of the
     license(s) for the package is included in %license.
[x]: Package requires other packages for directories it uses.
[x]: Package does not own files or directories owned by other packages.
[x]: Package uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Dist tag is present.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Package use %makeinstall only when make install DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package does not use a name that already exists.
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as
     provided in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate
     file from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[?]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[-]: Sources are verified with gpgverify first in %prep if upstream
     publishes signatures.
     Note: gpgverify is not used.
[-]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[-]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: js-termynal-0.0.1-1.20210316git9b30189.fc35.noarch.rpm
          js-termynal-0.0.1-1.20210316git9b30189.fc35.src.rpm
js-termynal.noarch: W: spelling-error Summary(en_US) async -> sync, a sync
js-termynal.noarch: W: spelling-error %description -l en_US isn -> sin, ins, ism
js-termynal.noarch: W: spelling-error %description -l en_US setTimeout -> set Timeout, set-timeout, timeout
js-termynal.noarch: W: spelling-error %description -l en_US jQuery -> j Query, query, equerry
js-termynal.noarch: W: spelling-error %description -l en_US async -> sync, a sync
js-termynal.noarch: W: spelling-error %description -l en_US reflows -> re flows, re-flows, ref lows
js-termynal.noarch: W: incoherent-version-in-changelog 0.0.1-1.20210305git9b30189 ['0.0.1-1.20210316git9b30189.fc35', '0.0.1-1.20210316git9b30189']
js-termynal.src: W: spelling-error Summary(en_US) async -> sync, a sync
js-termynal.src: W: spelling-error %description -l en_US isn -> sin, ins, ism
js-termynal.src: W: spelling-error %description -l en_US setTimeout -> set Timeout, set-timeout, timeout
js-termynal.src: W: spelling-error %description -l en_US jQuery -> j Query, query, equerry
js-termynal.src: W: spelling-error %description -l en_US async -> sync, a sync
js-termynal.src: W: spelling-error %description -l en_US reflows -> re flows, re-flows, ref lows
2 packages and 0 specfiles checked; 0 errors, 13 warnings.

Comment 3 Ben Beasley 2021-03-16 14:21:44 UTC
Thanks for the review!

Repository was requested: https://pagure.io/releng/fedora-scm-requests/issue/32896

Comment 4 Tomas Hrcka 2021-03-16 17:20:02 UTC
(fedscm-admin):  The Pagure repository was created at https://src.fedoraproject.org/rpms/js-termynal

Comment 5 Fedora Update System 2021-03-17 15:06:27 UTC
FEDORA-2021-b6cfada6ab has been submitted as an update to Fedora 33. https://bodhi.fedoraproject.org/updates/FEDORA-2021-b6cfada6ab

Comment 6 Fedora Update System 2021-03-17 15:06:30 UTC
FEDORA-2021-8a7eecdd1a has been submitted as an update to Fedora 34. https://bodhi.fedoraproject.org/updates/FEDORA-2021-8a7eecdd1a

Comment 7 Fedora Update System 2021-03-18 03:28:28 UTC
FEDORA-2021-b6cfada6ab has been pushed to the Fedora 33 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-b6cfada6ab \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-b6cfada6ab

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 8 Fedora Update System 2021-03-18 21:46:04 UTC
FEDORA-2021-8a7eecdd1a has been pushed to the Fedora 34 testing repository.
Soon you'll be able to install the update with the following command:
`sudo dnf install --enablerepo=updates-testing --advisory=FEDORA-2021-8a7eecdd1a \*`
You can provide feedback for this update here: https://bodhi.fedoraproject.org/updates/FEDORA-2021-8a7eecdd1a

See also https://fedoraproject.org/wiki/QA:Updates_Testing for more information on how to test updates.

Comment 9 Fedora Update System 2021-03-22 02:07:46 UTC
FEDORA-2021-8a7eecdd1a has been pushed to the Fedora 34 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 10 Fedora Update System 2021-03-26 01:20:15 UTC
FEDORA-2021-b6cfada6ab has been pushed to the Fedora 33 stable repository.
If problem still persists, please make note of it in this bug report.

Comment 11 Fedora Update System 2021-03-26 17:52:20 UTC
FEDORA-2021-b6cfada6ab has been pushed to the Fedora 33 stable repository.
If problem still persists, please make note of it in this bug report.


Note You need to log in before you can comment on or make changes to this bug.