Add warning to console about prototype kit usage #241
Conversation
| window.console && window.console.info | ||
| ) { | ||
| window.console.info('GOV.UK Prototype Kit - do not use for production'); | ||
| window.sessionStorage.setItem('prototypeWarning', true); |
There was a problem hiding this comment.
Presumably you want this to be set to 'false', right? Currently it’ll set it to true, then the next time you load the page check to see whether 'true' (converted internally to a string) is not equal to 'false' and show the message again. Personally, I don’t see the problem in showing it every page load though…
|
You don’t need to wait for the document to finish loading as you’re not touching it - you could move this out of the document ready block. Apart from this and my other comment, it’s a nice approach. |
|
this is a great idea. Mentioned elsewhere, but just so it's in one place: prototype kit should be lower case not sure about not showing every time - it means there's only one page view in a session that it will show, so someone will have to open the console on that one page view |
|
Probably for a separate discussion, but I consider the full name as a proper noun. I'm not sure where it was decided that it's lowercase? It's not just in that one page view, as the console content is persistent across pages. It will be at the top of the console regardless of how many pages you've visited. I'd prefer to err on the side of not being annoying and aggressive in our warnings - if we do that, people will just turn them off. |
|
My thought behind not having it every page load was that if you're debugging JavaScript it could be very annoying having a message in your console. |
|
@edwardhorsford the console is not persistent across pages by default |
# 2.0.0 - Remove the images path override from the helpers partial ([PR #292](alphagov/govuk_elements#292)). This will break background images that are currently using the `file-url` function from [the url-helpers partial in the frontend toolkit](https://github.com/alphagov/govuk_frontend_toolkit/blob/d54c9b2 6d314a6e6cb50ba90f6e96ca50049498f/stylesheets/_url-helpers.scss). As `$path` will vary from project to project you will need to define this in your main application stylesheet. - Bump govuk frontend toolkit to 4.16.1 ([PR #288](alphagov/govuk_elements#288)). This adds space key activation to links with a role of button. - Form validation patterns for conditionally revealing content ([PR #286](alphagov/govuk_elements#286)) - Centre text on full-width buttons ([PR #289](alphagov/govuk_elements#289)) - Lint JS code using [StandardJS](http://standardjs.com/) ([PR #290](alphagov/govuk_elements#290)) *This version deprecates external link styles. If your service has user research that indicates that external links are useful (or not) then we’d like to hear from you either on Slack, [digital-service-designers](https://groups.google.com/a/digital.cabinet- office.gov.uk/forum/#!forum/digital-service-designers) or [opening an issue](https://github.com/alphagov/govuk_elements/issues/new).* # 1.2.2 - Bump govuk frontend toolkit to 4.14.4 (PR #278) - Add a .column-full class (PR #270) - Add a file upload example (PR #268) - Remove the blue outline from the main content area (PR #265) - Fix legend text wrapping in IE (PR #248) # 1.2.1 - Consistent spacing underneath block labels and toggled content (PR #229) - Remove underlines from abbreviations in Firefox (PR #241)
gemmaleigh
force-pushed
the
kit-console-warning
branch
2 times, most recently
from
e3c491e
to
502564b
Compare
gemmaleigh
force-pushed
the
kit-console-warning
branch
from
502564b
to
4836b73
Compare
Breaking changes: - #244 Migrate documentation into a seperate application All changes: - Bump all GOV.UK assets to their latest versions - Remove duplicate GOV.UK assets copied to the app - #241 Warn against using the prototype kit to build production services - #268 Automatically keep the latest release branch up to date. This can be used to update the kit - #270 Add a new stylesheet for the unbranded layout to fix font issues - #257 Make CSS output easier to debug (with sourcemaps) - #237 Make links with role="button" behave like buttons - #224 Lint the prototype kit’s codebase using Standard. This only applies to the kit’s codebase - there’s no requirement for your app to meet this
Breaking changes: - #244 Migrate documentation into a separate application All changes: - Bump all GOV.UK assets to their latest versions - Remove duplicate GOV.UK assets copied to the app - #241 Warn against using the prototype kit to build production services - #268 Automatically keep the latest release branch up to date. This can be used to update the kit - #270 Add a new stylesheet for the unbranded layout to fix font issues - #257 Make CSS output easier to debug (with sourcemaps) - #237 Make links with role="button" behave like buttons - #224 Lint the prototype kit’s codebase using Standard. This only applies to the kit’s codebase - there’s no requirement for your app to meet this
Add a warning that gets printed to the console on the client side about not using the kit for production.
I've set it to only show once per session (using sessionStorage). This should hopefully strike a balance between being visible enough and not being too annoying.
Based on suggestion from @NickColley