feat(utils): implement report.md formatting #196
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ons, audits section in progress
MishaSeredenkoPushBased
requested review from
BioPhoton,
ChristopherPHolder,
IKatsuba,
Tlacenka,
matejchalk and
vmasek
MishaSeredenkoPushBased
added
🔬 testing
BioPhoton
previously requested changes
Nov 2, 2023
Collaborator
BioPhoton
left a comment
BioPhoton
left a comment
There was a problem hiding this comment.
Small things I found:
No collapse for empty results
Linebreak
52 tasks
matejchalk
requested changes
Nov 2, 2023
matejchalk
requested changes
Nov 2, 2023
Contributor
Author
@BioPhoton Already fixed while fixing the comments of @matejchalk |
matejchalk
reviewed
Nov 3, 2023
Collaborator
matejchalk
left a comment
matejchalk
left a comment
There was a problem hiding this comment.
I found some minor things, but overall this is looking fantastic, great job 👏
matejchalk
approved these changes
Nov 6, 2023
MishaSeredenkoPushBased
dismissed
BioPhoton’s stale review
Quote "U are good to go"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Implemented the changes for the report.md file.
Added the following sections: Overview, Categories, Audits, About.
Note that the commit data at About section is in the scope of the task #192
Here's the example of the audit of our test react-todos-app, generated by
nx run-collect cli:Code PushUp Report
🏷 Categories
🟡 Bug prevention: 68
🟩 Disallow assignment operators in conditional expressions (ESLint) - 0
🟩 Disallow reassigning
constvariables (ESLint) - 0🟩 Disallow the use of
debugger(ESLint) - 0🟩 Disallow invalid regular expression strings in
RegExpconstructors (ESLint) - 0🟩 Disallow the use of undeclared variables unless mentioned in
/*global */comments (ESLint) - 0🟩 Disallow loops with a body that allows only one iteration (ESLint) - 0
🟩 Disallow negating the left operand of relational operators (ESLint) - 0
🟩 Disallow use of optional chaining in contexts where the
undefinedvalue is not allowed (ESLint) - 0🟩 Require calls to
isNaN()when checking forNaN(ESLint) - 0🟩 Enforce comparing
typeofexpressions against valid strings (ESLint) - 0🟥 Require the use of
===and!==(ESLint) - 1 warning🟥 Disallow missing
keyprops in iterators/collection literals (ESLint) - 1 warning🟥 Disallow missing props validation in a React component definition (ESLint) - 6 warnings
🟩 Disallow missing React when using JSX (ESLint) - 0
🟩 enforces the Rules of Hooks (ESLint) - 0
🟥 verifies the list of dependencies for Hooks like useEffect and similar (ESLint) - 2 warnings
🟡 Code style: 54
🟥 Disallow unused variables (ESLint) - 1 warning
🟥 Require braces around arrow function bodies (ESLint) - 1 warning
🟩 Enforce camelcase naming convention (ESLint) - 0
🟩 Enforce consistent brace style for all control statements (ESLint) - 0
🟥 Require the use of
===and!==(ESLint) - 1 warning🟥 Enforce a maximum number of lines of code in a function (ESLint) - 1 warning
🟩 Enforce a maximum number of lines per file (ESLint) - 0
🟥 Require or disallow method and property shorthand syntax for object literals (ESLint) - 3 warnings
🟩 Require using arrow functions for callbacks (ESLint) - 0
🟥 Require
constdeclarations for variables that are never reassigned after declared (ESLint) - 1 warning🟩 Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead (ESLint) - 0
🟩 Require or disallow "Yoda" conditions (ESLint) - 0
🟩 Require
letorconstinstead ofvar(ESLint) - 0🛡️ Audits
Disallow assignment operators in conditional expressions (ESLint)
🟩 0 (score: 100)
No detailsDisallow reassigning
constvariables (ESLint)🟩 0 (score: 100)
No detailsDisallow the use of
debugger(ESLint)🟩 0 (score: 100)
No detailsDisallow invalid regular expression strings in
RegExpconstructors (ESLint)🟩 0 (score: 100)
No detailsDisallow the use of undeclared variables unless mentioned in
/*global */comments (ESLint)🟩 0 (score: 100)
No detailsDisallow loops with a body that allows only one iteration (ESLint)
🟩 0 (score: 100)
No detailsDisallow negating the left operand of relational operators (ESLint)
🟩 0 (score: 100)
No detailsDisallow use of optional chaining in contexts where the
undefinedvalue is not allowed (ESLint)🟩 0 (score: 100)
No detailsDisallow unused variables (ESLint)
🟥 1 warning (score: 0)
src/App.jsxESLint rule no-unused-vars. 📖 Docs
Require calls to
isNaN()when checking forNaN(ESLint)🟩 0 (score: 100)
No detailsEnforce comparing
typeofexpressions against valid strings (ESLint)🟩 0 (score: 100)
No detailsRequire braces around arrow function bodies (ESLint)
🟥 1 warning (score: 0)
src/components/TodoFilter.jsxESLint rule arrow-body-style. 📖 Docs
Enforce camelcase naming convention (ESLint)
🟩 0 (score: 100)
No detailsEnforce consistent brace style for all control statements (ESLint)
🟩 0 (score: 100)
No detailsRequire the use of
===and!==(ESLint)🟥 1 warning (score: 0)
src/hooks/useTodos.jsESLint rule eqeqeq. 📖 Docs
Enforce a maximum number of lines of code in a function (ESLint)
🟥 1 warning (score: 0)
src/hooks/useTodos.jsESLint rule max-lines-per-function. 📖 Docs
Enforce a maximum number of lines per file (ESLint)
🟩 0 (score: 100)
No detailsDisallow variable declarations from shadowing variables declared in the outer scope (ESLint)
🟥 3 warnings (score: 0)
src/hooks/useTodos.jssrc/hooks/useTodos.jssrc/hooks/useTodos.jsESLint rule no-shadow. 📖 Docs
Require
letorconstinstead ofvar(ESLint)🟩 0 (score: 100)
No detailsRequire or disallow method and property shorthand syntax for object literals (ESLint)
🟥 3 warnings (score: 0)
src/hooks/useTodos.jssrc/hooks/useTodos.jssrc/hooks/useTodos.jsESLint rule object-shorthand. 📖 Docs
Require using arrow functions for callbacks (ESLint)
🟩 0 (score: 100)
No detailsRequire
constdeclarations for variables that are never reassigned after declared (ESLint)🟥 1 warning (score: 0)
src/index.jsxESLint rule prefer-const. 📖 Docs
Disallow using Object.assign with an object literal as the first argument and prefer the use of object spread instead (ESLint)
🟩 0 (score: 100)
No detailsRequire or disallow "Yoda" conditions (ESLint)
🟩 0 (score: 100)
No detailsDisallow missing
keyprops in iterators/collection literals (ESLint)🟥 1 warning (score: 0)
src/components/TodoList.jsxESLint rule jsx-key, from react plugin. 📖 Docs
Disallow missing props validation in a React component definition (ESLint)
🟥 6 warnings (score: 0)
src/components/CreateTodo.jsxsrc/components/TodoFilter.jsxsrc/components/TodoFilter.jsxsrc/components/TodoList.jsxsrc/components/TodoList.jsxsrc/components/TodoList.jsxESLint rule prop-types, from react plugin. 📖 Docs
Disallow missing React when using JSX (ESLint)
🟩 0 (score: 100)
No detailsenforces the Rules of Hooks (ESLint)
🟩 0 (score: 100)
No detailsverifies the list of dependencies for Hooks like useEffect and similar (ESLint)
🟥 2 warnings (score: 0)
src/hooks/useTodos.jssrc/hooks/useTodos.jsESLint rule exhaustive-deps, from react-hooks plugin. 📖 Docs
Disallow missing displayName in a React component definition (ESLint)
🟩 0 (score: 100)
No detailsDisallow comments from being inserted as text nodes (ESLint)
🟩 0 (score: 100)
No detailsDisallow duplicate properties in JSX (ESLint)
🟩 0 (score: 100)
No detailsDisallow
target="_blank"attribute withoutrel="noreferrer"(ESLint)🟩 0 (score: 100)
No detailsDisallow undeclared variables in JSX (ESLint)
🟩 0 (score: 100)
No detailsDisallow React to be incorrectly marked as unused (ESLint)
🟩 0 (score: 100)
No detailsDisallow variables used in JSX to be incorrectly marked as unused (ESLint)
🟩 0 (score: 100)
No detailsDisallow passing of children as props (ESLint)
🟩 0 (score: 100)
No detailsDisallow when a DOM element is using both children and dangerouslySetInnerHTML (ESLint)
🟩 0 (score: 100)
No detailsDisallow usage of deprecated methods (ESLint)
🟩 0 (score: 100)
No detailsDisallow direct mutation of this.state (ESLint)
🟩 0 (score: 100)
No detailsDisallow usage of findDOMNode (ESLint)
🟩 0 (score: 100)
No detailsDisallow usage of isMounted (ESLint)
🟩 0 (score: 100)
No detailsDisallow usage of the return value of ReactDOM.render (ESLint)
🟩 0 (score: 100)
No detailsDisallow using string references (ESLint)
🟩 0 (score: 100)
No detailsDisallow unescaped HTML entities from appearing in markup (ESLint)
🟩 0 (score: 100)
No detailsDisallow usage of unknown DOM property (ESLint)
🟩 0 (score: 100)
No detailsEnforce ES5 or ES6 class for returning value in render function (ESLint)
🟩 0 (score: 100)
No detailsAbout
Report was created by Code PushUp on Thu Nov 02 2023 12:02:52 GMT+0100 (Central European Standard Time)
The following plugins were run:
Made with ❤️ by code-pushup.dev