Dependency notes #358
Dependency notes #358
Conversation
Formatted the information to be more presentable and fixed some mistakes in the writing.
Rtyujklop
left a comment
Rtyujklop
left a comment
There was a problem hiding this comment.
These are the changes I can see now, overall it's good some tweaks can be done if you want.
README.md
Outdated
| ## Dependencies | ||
| ### root | ||
| `ajv`: seems to be unused, may be a subdependency. Compiles JSON schemas to JavaScript code. |
There was a problem hiding this comment.
Since ajv is flagged as “seems to be unused”, it might be worth explicitly noting whether it appears in dependencies vs devDependencies in package.json
There was a problem hiding this comment.
Changes from a recent commit now note which of the packages are used as devDependencies.
README.md
Outdated
| `@semantic-ui-react/css-patch`: patches semicolon issue with semantic (should have been fixed in an update of semanticUI?). | ||
| `@testing-library/jest-dom`: currently unused. |
There was a problem hiding this comment.
For @testing-library/jest-dom and @testing-library/user-event, it might be helpful to say “kept for future test expansion” or “candidate for removal” so it’s clear whether they’re intentionally retained.
There was a problem hiding this comment.
A notice to keep these dependencies for now, has since been included.
README.md
Outdated
| `html-entities`: is used for the same thing as `he`. | ||
| `prop-types`: a tool used for validating the data types of properties. |
There was a problem hiding this comment.
Maybe mention whether the project is using PropTypes consistently in new components, or if this is mainly for legacy components.
There was a problem hiding this comment.
I've now added more information about the components in which prop-types is used.
| `html-to-text`: converts HTML into formatted text. Unclear if this needs to be in root. | ||
| ### server |
There was a problem hiding this comment.
This is a really helpful addition to the README – having dependency intent documented will make future upgrades and removals much safer.
Dependency documentation now notes which dependencies are in devDependencies. Additionally, the accuracy of the documentation for the package ajv has been improved.
…or-Project into dependency-notes
Finished incomplete sentence in the caniuse-lite documentation and noted that the package is a transitive dependency of react-scripts similar to ajv.
github-project-automation
bot
moved this from Needs Planning
to Under Review
in Portal Development
Created documentation for node dependencies in the project.