darkhelm/notifications-admin
1
0
Fork 0
mirror of https://github.com/GSA/notifications-admin.git synced 2025-12-09 06:33:52 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
88c47d15f622100c0df4ed7ff52f1ee0909a8c65
notifications-admin/gulpfile.js

133 lines
4.2 KiB
JavaScript
Raw Normal View History

Updated rollup
2024-08-08 14:32:33 -06:00
const { src, dest, series } = require('gulp');
const rollup = require('@rollup/stream');
const rollupPluginCommonjs = require('@rollup/plugin-commonjs');
const rollupPluginNodeResolve = require('@rollup/plugin-node-resolve');
const source = require('vinyl-source-stream');
const buffer = require('vinyl-buffer');
Replaced stream queue
2024-08-08 14:01:05 -06:00
const gulpMerge = require('gulp-merge');
- Added support for default gulp/build commands - Moved some folders around to align with gulp copy functions
2023-04-27 13:32:23 -04:00
const uswds = require("@uswds/compile");
replace require with es6 import statment
2016-07-19 15:13:23 +01:00
Remove gulp-load-plugins It's not being updated at the moment and has a few vulnerabilities listed against its dependencies.
2019-04-05 13:31:13 +01:00
const plugins = {};
plugins.addSrc = require('gulp-add-src');
plugins.babel = require('gulp-babel');
Rewrite URLs in CSS based on environment Fix for issue that caused this revert: https://github.com/alphagov/notifications-admin/pull/3196 Note: gulp-css-url-adjuster operates on an Abstract Syntax Tree (AST) derived from `main.css`. The CSS output from this loses the compression gulp-sass applies. This moves compression out of Sass, to a step after the URLs are adjusted.
2019-11-26 14:18:57 +00:00
plugins.cleanCSS = require('gulp-clean-css');
Remove gulp-load-plugins It's not being updated at the moment and has a few vulnerabilities listed against its dependencies.
2019-04-05 13:31:13 +01:00
plugins.concat = require('gulp-concat');
plugins.jshint = require('gulp-jshint');
plugins.prettyerror = require('gulp-prettyerror');
plugins.uglify = require('gulp-uglify');
Use EcmaScript 6, w/ transpiling for compatibility ES6 has some nice new features. Specifically relevant to this piece of work are: Arrow functions[1], whose `this` context is bound the value of `this` in the current scope and can’t be overidden. The code is cleaner as a result, and doesn’t need the addition of a bind polyfill for older browsers. Template strings[2], which are similar to triple-quoted multi line strings in Python. This means less fiddly and error-prone string concatenation. This commit adds Babel[3] to the Gulp pipeline. This transpiles Javascript written to the ES6 specification into code which is compatible with older browsers that don’t understand ES6 syntax. It also rewrites the gulpfile itself using some ES6 syntax, for the same reasons. 1. https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Functions/Arrow_functions 2. https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/template_strings 3. https://babeljs.io
2015-12-20 00:00:01 +00:00
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
const paths = {
src: 'app/assets/',
dist: 'app/static/',
npm: 'node_modules/',
Add GOVUK Frontend to the frontend build - copies across the images - adds the Sass folder to the Sass include paths JS is added file-by-file so will be added when specific files are needed.
2019-10-09 15:03:35 +01:00
toolkit: 'node_modules/govuk_frontend_toolkit/',
govuk_frontend: 'node_modules/govuk-frontend/'
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
};
Add JS modules support & use for GOVUKFrontend The JS for GOVUKFrontend components is available individually so you can only include what you need: https://github.com/alphagov/govuk-frontend/blob/v2.13.0/docs/installation/installing-with-npm.md#option-2-import-javascript This uses the JS Modules syntax: *[JS module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) Our JS is delivered as one file so we need to use a bundler to convert the modules to a single file. This adds a build step to transpile all modules into a single file, which is then added to the files combined into the one that get delivered. Rollup is used as the simplest bundler to use for this purpose. It also introduces the least boilerplate JS. Note: the CommonJS plugin is needed as GOV.UK Frontend components are published as UMD modules. In future, this work should let us work on this story dependencies: https://www.pivotaltracker.com/story/show/165380360
2019-10-11 10:26:25 +01:00
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
const javascripts = () => {
Updated rollup
2024-08-08 14:32:33 -06:00
const vendored = rollup({
input: paths.src + 'javascripts/modules/all.mjs',
plugins: [
rollupPluginNodeResolve({
mainFields: ['module', 'main']
}),
rollupPluginCommonjs({
include: 'node_modules/**'
})
],
output: {
format: 'iife',
name: 'GOVUK'
}
})
.pipe(source('all.mjs'))
.pipe(buffer())
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
.pipe(plugins.addSrc.prepend([
paths.npm + 'hogan.js/dist/hogan-3.0.2.js',
paths.npm + 'jquery/dist/jquery.min.js',
paths.npm + 'query-command-supported/dist/queryCommandSupported.min.js',
paths.npm + 'timeago/jquery.timeago.js',
Support registering a new authenticator This adds Yubico's FIDO2 library and two APIs for working with the "navigator.credentials.create()" function in JavaScript. The GET API uses the library to generate options for the "create()" function, and the POST API decodes and verifies the resulting credential. While the options and response are dict-like, CBOR is necessary to encode some of the byte-level values, which can't be represented in JSON. Much of the code here is based on the Yubico library example [1][2]. Implementation notes: - There are definitely better ways to alert the user about failure, but window.alert() will do for the time being. Using location.reload() is also a bit jarring if the page scrolls, but not a major issue. - Ideally we would use window.fetch() to do AJAX calls, but we don't have a polyfill for this, and we use $.ajax() elsewhere [3]. We need to do a few weird tricks [6] to stop jQuery trashing the data. - The FIDO2 server doesn't serve web requests; it's just a "server" in the sense of WebAuthn terminology. It lives in its own module, since it needs to be initialised with the app / config. - $.ajax returns a promise-like object. Although we've used ".fail()" elsewhere [3], I couldn't find a stub object that supports it, so I've gone for ".catch()", and used a Promise stub object in tests. - WebAuthn only works over HTTPS, but there's an exception for "localhost" [4]. However, the library is a bit too strict [5], so we have to disable origin verification to avoid needing HTTPS for dev work. [1]: https://github.com/Yubico/python-fido2/blob/c42d9628a4f33d20c4401096fa8d3fc466d5b77f/examples/server/server.py [2]: https://github.com/Yubico/python-fido2/blob/c42d9628a4f33d20c4401096fa8d3fc466d5b77f/examples/server/static/register.html [3]: https://github.com/alphagov/notifications-admin/blob/91453d36395b7a0cf2998dfb8a5f52cc9e96640f/app/assets/javascripts/updateContent.js#L33 [4]: https://stackoverflow.com/questions/55971593/navigator-credentials-is-null-on-local-server [5]: https://github.com/Yubico/python-fido2/blob/c42d9628a4f33d20c4401096fa8d3fc466d5b77f/fido2/rpid.py#L69 [6]: https://stackoverflow.com/questions/12394622/does-jquery-ajax-or-load-allow-for-responsetype-arraybuffer
2021-05-07 18:10:07 +01:00
paths.npm + 'textarea-caret/index.js',
installing socketio
2024-06-05 14:56:22 -07:00
paths.npm + 'cbor-js/cbor.js',
Moving from a tabbed area to switching on account dropdown
2024-06-13 10:29:59 -04:00
paths.npm + 'd3/dist/d3.min.js'
Switch to using gulp-better-rollup Means our rollup bundling doesn't leave any artefact files lying around that we'd then have to deal with. Also includes: - removal of some JSHint config' marking the artefacts as scripts to ignore - use of streamqueue package to allow the same ordering of scripts as before
2019-11-20 13:43:07 +00:00
]));
const local = src([
paths.toolkit + 'javascripts/govuk/modules.js',
paths.toolkit + 'javascripts/govuk/show-hide-content.js',
rename api key component to copy_to_clipboard does what it says on the tin, and is also consistent with prior art: https://components.publishing.service.gov.uk/component-guide/copy_to_clipboard
2021-08-27 17:32:06 +01:00
paths.src + 'javascripts/copyToClipboard.js',
Switch to using gulp-better-rollup Means our rollup bundling doesn't leave any artefact files lying around that we'd then have to deal with. Also includes: - removal of some JSHint config' marking the artefacts as scripts to ignore - use of streamqueue package to allow the same ordering of scripts as before
2019-11-20 13:43:07 +00:00
paths.src + 'javascripts/autofocus.js',
paths.src + 'javascripts/enhancedTextbox.js',
paths.src + 'javascripts/fileUpload.js',
paths.src + 'javascripts/radioSelect.js',
paths.src + 'javascripts/updateContent.js',
paths.src + 'javascripts/listEntry.js',
paths.src + 'javascripts/liveSearch.js',
paths.src + 'javascripts/errorTracking.js',
paths.src + 'javascripts/preventDuplicateFormSubmissions.js',
paths.src + 'javascripts/fullscreenTable.js',
paths.src + 'javascripts/colourPreview.js',
paths.src + 'javascripts/templateFolderForm.js',
paths.src + 'javascripts/collapsibleCheckboxes.js',
Add a form to set priority of top 2 providers Their priority should always add up to 100%. Currently we have to ensure this by hand. Adding this form means there’s no way to not set their combined priorities to 100%. And it’s a bit more of an intuitive UI than two textboxes on separate pages.
2019-12-02 18:15:00 +00:00
paths.src + 'javascripts/radioSlider.js',
Fetch template length message as user types This commit adds some Javascript that makes AJAX requests as the users changes the content of their template. It then takes the content returned by the backend and inserts it in the page.
2021-01-06 17:32:46 +00:00
paths.src + 'javascripts/updateStatus.js',
add new error banner module for showing users js errors this ensures it's reusable by other components, and easier to unit test by isolating the separate concerns note: this is not in Modules since that's designed for classes that are then bound to an element in the DOM as indicated by a data-module attribute. This will just live at the window.GOVUK level since we want there to only ever be one `.banner-dangerous` warning.
2021-07-20 12:14:10 +01:00
paths.src + 'javascripts/errorBanner.js',
Progressively enhance the proposition illustration When users with Javascript enabled request it we can show a higher quality SVG image which will look better in certain circumstances.
2021-02-11 16:44:22 +00:00
paths.src + 'javascripts/homepage.js',
Functionality for session timer display
2023-09-07 08:38:41 -06:00
paths.src + 'javascripts/timeoutPopup.js',
927 - Updates to math in Dashboard area
2023-11-16 12:02:59 -05:00
paths.src + 'javascripts/date.js',
Commit before merge
2024-02-27 11:53:51 -05:00
paths.src + 'javascripts/loginAlert.js',
Add new analytics code to frontend build
2019-12-15 19:38:49 +00:00
paths.src + 'javascripts/main.js',
Separated the js to make it easier to test
2024-07-18 15:27:17 -04:00
paths.src + 'javascripts/totalMessagesChart.js',
paths.src + 'javascripts/activityChart.js',
Switch to using gulp-better-rollup Means our rollup bundling doesn't leave any artefact files lying around that we'd then have to deal with. Also includes: - removal of some JSHint config' marking the artefacts as scripts to ignore - use of streamqueue package to allow the same ordering of scripts as before
2019-11-20 13:43:07 +00:00
])
images and overrides
2022-07-21 18:25:23 -07:00
.pipe(plugins.prettyerror())
.pipe(plugins.babel({
presets: ['@babel/preset-env']
}));
Switch to using gulp-better-rollup Means our rollup bundling doesn't leave any artefact files lying around that we'd then have to deal with. Also includes: - removal of some JSHint config' marking the artefacts as scripts to ignore - use of streamqueue package to allow the same ordering of scripts as before
2019-11-20 13:43:07 +00:00
Replaced stream queue
2024-08-08 14:01:05 -06:00
return gulpMerge(vendored, local)
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
.pipe(plugins.uglify())
.pipe(plugins.concat('all.js'))
Updated rollup
2024-08-08 14:32:33 -06:00
.pipe(dest(paths.dist + 'javascripts/'));
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
};
Add custom static error pages for 413 and some 5xx errors
2016-09-12 16:11:34 +01:00
Added another missing file
2024-08-09 09:41:13 -06:00
// Task to copy `gtm_head.js`
Added another file
2024-08-09 09:18:50 -06:00
const copyGtmHead = () => {
return src(paths.src + 'js/gtm_head.js')
.pipe(dest(paths.dist + 'js/'));
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
};
move file around
2024-08-23 14:01:51 -07:00
// Task to copy `setTimezone.js`
const copySetTimezone = () => {
return src(paths.src + 'js/setTimezone.js')
.pipe(dest(paths.dist + 'js/'));
};
Added another missing file
2024-08-09 09:41:13 -06:00
// Task to copy images
const copyImages = () => {
Added back part that got removed that allowed png images
2024-08-13 14:15:02 -05:00
return src(paths.src + 'images/**/*', { encoding: false })
Added another missing file
2024-08-09 09:41:13 -06:00
.pipe(dest(paths.dist + 'images/'));
Bump Gulp to 4.0.0 Brings in a new API which is a breaking change: https://github.com/gulpjs/gulp/blob/master/CHANGELOG.md#400 Requires gulpfile.babel.js to be a CommonJS module and for all tasks to be exported. Replaces using ES6 modules for the CommonJS to include other packages to match the type of module the gulpfile now is. Updates to 4.0.0 include `series` and `parallel` methods which remove the need for the `run-sequence` package. Also bumps gulp-specific libraries.
2019-04-01 09:58:13 +01:00
};
Add linting for SASS and Javascript Similar to how PEP8 enforces Python style, there are tools for front end code: - jshint[1] for Javascript - sass-lint[2] for SASS This commit adds the Gulp plugins for both, and sets up some sensible rules (which can be iterated on). It also adds a command to `./scripts/run_tests.sh`, so that any errors in the front end code will fail the build before it has a chance to be deployed. 1. http://jshint.com/ 2. https://www.npmjs.com/package/sass-lint
2016-02-08 11:05:07 +00:00
Added back part that got removed that allowed png images
2024-08-13 14:15:02 -05:00
Added another missing file
2024-08-09 09:41:13 -06:00
// Configure USWDS paths
Initial USWDS install
2023-04-24 14:57:35 -04:00
uswds.settings.version = 3;
Added styling files back
2024-08-09 07:40:58 -06:00
uswds.paths.dist.css = paths.dist + 'css';
uswds.paths.dist.js = paths.dist + 'js';
uswds.paths.dist.img = paths.dist + 'img';
uswds.paths.dist.fonts = paths.dist + 'fonts';
uswds.paths.dist.theme = paths.src + 'sass/uswds';
Added another missing file
2024-08-09 09:41:13 -06:00
// Task to compile USWDS styles
Added styling files back
2024-08-09 07:40:58 -06:00
const styles = async () => {
await uswds.compile();
};
Initial USWDS install
2023-04-24 14:57:35 -04:00
Added another missing file
2024-08-09 09:41:13 -06:00
// Task to copy USWDS assets
Added styling files back
2024-08-09 07:40:58 -06:00
const copyAssets = async () => {
await uswds.copyAssets();
};
Initial USWDS install
2023-04-24 14:57:35 -04:00
move file around
2024-08-23 14:01:51 -07:00
exports.default = series(styles, javascripts, copyGtmHead, copySetTimezone, copyImages, copyAssets);
Reference in New Issue Copy Permalink