[1.x] Microsoft Document Viewer

Thank you for applying!
In order to review the project, we need to know the project link and which branch to review. Please add that information to the issue: The link goes in the issue summary; the branch goes in the issue title, between square brackets.

https://www.drupal.org/project/md_viewer →

Please fix PHPCS issues.

FILE: /md_viewer/config/install/field.formatter.settings.mdocviewer_field.yml
------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
------------------------------------------------------------------------------------------------------------------
 2 | ERROR | [x] Expected 1 newline at end of file; 0 found
------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------


FILE: /md_viewer/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
----------------------------------------------------------------------
  3 | WARNING | Line exceeds 80 characters; contains 379 characters
 30 | WARNING | Line exceeds 80 characters; contains 475 characters
 31 | WARNING | Line exceeds 80 characters; contains 221 characters
----------------------------------------------------------------------


FILE: /md_viewer/md_viewer.module
------------------------------------------------------------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AND 4 WARNINGS AFFECTING 4 LINES
------------------------------------------------------------------------------------------------------------------------------------------------------------------
 11 | WARNING | [ ] All constants defined by a module must be prefixed with the module's name, expected "MD_VIEWER_MDOC_EMBEDD_LINK" but found "MDOC_EMBEDD_LINK"
 11 | WARNING | [ ] Global constants should not be used, move it to a class or interface
 45 | WARNING | [x] A comma should follow the last multiline array item. Found: MDOC_EMBEDD_LINK
 46 | WARNING | [x] A comma should follow the last multiline array item. Found: ]
 54 | ERROR   | [ ] md_viewer_uninstall() is an installation hook and must be declared in an install file
------------------------------------------------------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------------------------------------------------------


FILE: /md_viewer/src/Plugin/Field/FieldFormatter/MDocViewerFieldFormatter.php
------------------------------------------------------------------------------------------------------------------
FOUND 13 ERRORS AND 2 WARNINGS AFFECTING 14 LINES
------------------------------------------------------------------------------------------------------------------
  25 | ERROR   | [ ] Missing short description in doc comment
  30 | ERROR   | [ ] Missing short description in doc comment
 116 | ERROR   | [x] Expected 1 space before opening brace; found 0
 122 | ERROR   | [x] Whitespace found at end of line
 139 | ERROR   | [x] Expected 1 space after IF keyword; 0 found
 143 | ERROR   | [x] Expected newline after closing brace
 158 | ERROR   | [x] Expected 1 space before "as"; 6 found
 170 | WARNING | [x] A comma should follow the last multiline array item. Found: )
 171 | WARNING | [x] A comma should follow the last multiline array item. Found: ]
 173 | ERROR   | [x] Expected newline after closing brace
 176 | ERROR   | [x] There should be no white space after an opening "["
 176 | ERROR   | [x] There should be no white space before a closing "]"
 178 | ERROR   | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE" but found "false"
 184 | ERROR   | [x] Expected 1 blank line after function; 0 found
 185 | ERROR   | [x] The closing brace for the class must have an empty line before it
------------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 13 MARKED SNIFF VIOLATIONS AUTOMATICALLY
------------------------------------------------------------------------------------------------------------------

PHPCS issues fixed. Please have a look

There are still a few PHPCS issues. Please fix.

FILE: /md_viewer/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 7 WARNINGS AFFECTING 7 LINES
----------------------------------------------------------------------
  3 | WARNING | Line exceeds 80 characters; contains 82 characters
  4 | WARNING | Line exceeds 80 characters; contains 81 characters
  5 | WARNING | Line exceeds 80 characters; contains 142 characters
 33 | WARNING | Line exceeds 80 characters; contains 139 characters
 34 | WARNING | Line exceeds 80 characters; contains 206 characters
 35 | WARNING | Line exceeds 80 characters; contains 128 characters
 36 | WARNING | Line exceeds 80 characters; contains 221 characters
----------------------------------------------------------------------


FILE: /md_viewer/md_viewer.module
-------------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
-------------------------------------------------------------------------------------
 1 | ERROR | [x] Missing file doc comment
 3 | ERROR | [x] There must be one blank line after the last USE statement; 0 found;
-------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-------------------------------------------------------------------------------------

Actually, the @file documentation comment exists, but it is not in the correct position.

use Drupal\md_viewer\Constants\Constants;
/**
 * @file
 * A field formatter for the File field.
 *
 * This formatter renders the file as an embedded document,
 * using Microsoft's Documents viewer.
 */

The @file documentation comment must be right after the <?php tag separated from it by an empty line.
The usual description for a module file is then Hook implementations for the Microsoft Document Viewer module.

Please have a look again

See my previous comment.
The md_viewer.module file does not contain any field formatter: it contains hook implementations, which is the reason why the description used for .module files is Hook implementations for the Microsoft Document Viewer module. (where the module name is different for each module).

Updated module file

Thank you for your contribution! I am going to update your account.

These are some recommended readings to help with excellent maintainership:

• Dries → ' post on Responsible maintainers
• Best practices for creating and maintaining projects →
• Maintaining a drupal.org project with Git →
• Commit messages - providing history and credit →
• Release naming conventions → .
• Helping maintainers in the issue queues →

You can find more contributors chatting on the Slack → #contribute channel. So, come hang out and stay involved → .
Thank you, also, for your patience with the review process.
Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review → . I encourage you to learn more about that process and join the group of reviewers.

I thank all the reviewers.

Automatically closed - issue fixed for 2 weeks with no activity.