Modernize package #22
Conversation
CHANGELOG.md
Outdated
|
|
||
| ### Breaking Changes | ||
|
|
||
| - Made package server only. There isn't any reason for code to run on the client and doing so has been a confusing experience in the past. This will break some current usage if code is used on the client. |
There was a problem hiding this comment.
Maybe a mention that this update will cause false-negatives for all modules that are only imported in client code, and that in 1.0.0+ calls to checkNpmVersions must be followed by a require for the desired package
| @@ -15,6 +17,8 @@ checkNpmVersions({ | |||
| const Griddle = require('griddle-react'); | |||
| ``` | |||
|
|
|||
| >This must be run on the server so that it has access to the package.json of the package where it can examine the version that is installed. | |||
|
|
|||
There was a problem hiding this comment.
Add section for client-only package instructions, since you will need to statically import either the whole package, or just the package.json for the module to be included in the server bundle so we can check that it exists.
checkNpmVersions({
'client-only': '1.3.x'
}, 'my:package');
require('client-only/package.json');
There was a problem hiding this comment.
What about adding a check to make sure we are in development and effectively turn the checkNpmVersions into a noop for production?
|
Ok, so I've finally gotten around and tested things out quite a bit and it's looking like that because of the way the build system works, the server does not have access to the package.json of a package unless it's imported on the server. This means that leaving the package so that it runs in both environments is probably best for usability. Unfortunately this won't give any savings to the bundle size, but I think that maybe if package authors use dynamic imports this could be accomplished on their end. |
Setup typescript, linting, and commit hooks. Also made the package server only to avoid issues when used client side.