Gathering detailed insights and metrics for webpack-font-preload-plugin
Gathering detailed insights and metrics for webpack-font-preload-plugin
Installations
npm install webpack-font-preload-pluginDeveloper
sn-satyendra
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
>= 10.17.0
Typescript Support
Yes
Node Version
16.13.1
NPM Version
8.1.2
Statistics
20 Stars
121 Commits
10 Forks
3 Watching
5 Branches
3 Contributors
Updated on 10 Nov 2024
Languages
TypeScript (95.81%)
JavaScript (4.19%)
Total Downloads
Cumulative downloads
Total Downloads
5,068,014
Last day
1.8%
16,646
Compared to previous day
Last week
4.3%
108,112
Compared to previous week
Last month
33.9%
428,716
Compared to previous month
Last year
93.6%
2,834,629
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
1
Dev Dependencies
22
@babel/core@babel/preset-env@types/jsdom@types/webpack-sourcesbabel-jestbabel-loadercss-loadereslinteslint-config-airbnb-baseeslint-config-prettiereslint-plugin-importeslint-plugin-jesteslint-plugin-prettierhtml-webpack-pluginhuskyjestlint-stagedmini-css-extract-pluginprettierrimraftypescriptwebpack
Versions
webpack-font-preload-plugin
A webpack plugin to allow preloading or prefetching of fonts.
Introduction
The preload value of the <link> element's rel attribute lets you declare fetch requests in the HTML's <head>, specifying resources that your page will need very soon, which you want to start loading early in the page lifecycle, before browsers' main rendering machinery kicks in. This ensures they are available earlier and are less likely to block the page's render, improving performance.
This plugin specifically targets fonts used with the application which are bundled using webpack. The plugin would add <link> tags in the begining of <head> of your html:
1<link rel="preload" href="/font1.woff" as="font" crossorigin /> 2<link rel="preload" href="/font2.woff" as="font" crossorigin />
Getting Started
To begin, you'll need to install webpack-font-preload-plugin:
1$ npm install webpack-font-preload-plugin --save-dev
Then add the plugin to your webpack config. For example:
webpack.config.js
1const FontPreloadPlugin = require("webpack-font-preload-plugin"); 2 3module.exports = { 4 plugins: [new FontPreloadPlugin()], 5};
And run webpack via your preferred method.
Options
index
Type: string
Default: index.html
Optional: true
Name of the index file which needs modification.
1// in your webpack.config.js
2new FontPreloadPlugin({
3 index: "index.html",
4});extensions
Type: string[]
Default: ['woff', 'woff2', 'ttf', 'eot']
Optional: true
Default font extensions which should be used.
1// in your webpack.config.js 2new FontPreloadPlugin({ 3 extensions: ["woff", "ttf", "eot"], 4});
crossorigin
Type: boolean
Default: true
Optional: true
Is the font request crossorigin or not.
1// in your webpack.config.js
2new FontPreloadPlugin({
3 crossorigin: true,
4});loadType
Type: string
Default: preload
Optional: true
Type of load. It can be either preload or prefetch.
1// in your webpack.config.js
2new FontPreloadPlugin({
3 loadType: "preload",
4});insertBefore
Type: string
Default: head > title
Optional: true
The selector for node before which the preload/prefetch links should be added.
1// in your webpack.config.js
2new FontPreloadPlugin({
3 // Add the preload statements before any other <link> tag present in html
4 insertBefore: "head > link:nth-child(1)",
5});replaceCallback
Type: Function
Default: undefined
Optional: true
Callback for doing custom manipulations to index.html for special use cases like templating or server side rendering. This callback would be passed an object as parameter with 2 keys:
indexSource: Full source string of the index.html.linksAsString:<link>tags for preloading fonts as a string.
The consuming app can use this information to generate the final index.html and must return an updated string which would be used as index.html after webpack build.
1// in your webpack.config.js 2new FontPreloadPlugin({ 3 replaceCallback: ({ indexSource, linksAsString }) => { 4 return indexSource.replace("{{{links}}}", linksAsString); 5 }, 6});
filter
Type: string
Default: undefined
Optional: true
Expression for allowing more granular filtering of the font assets for doing a preload/prefetch. The filter is applied on the font assets selected by the extensions option. If the filter is a string, all the font assets which contain the string as part of the name are included in the preload and rest are ignored. In case filter is regex, the font asset's name is tested to match the regex for allowing preload. If you don't pass this option, all the font assets will be preloaded.
1// To only preload font's which have string `app-font` as part of there name.
2new FontPreloadPlugin({
3 filter: "app-font",
4});
5
6// To preload fonts which start with `mui` or `app` in there name.
7new FontPreloadPlugin({
8 filter: /^mui|^app/i,
9});License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/sn-satyendra/webpack-font-preload-plugin/node.js.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/node.js.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/sn-satyendra/webpack-font-preload-plugin/node.js.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/sn-satyendra/webpack-font-preload-plugin/npm-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/sn-satyendra/webpack-font-preload-plugin/npm-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/sn-satyendra/webpack-font-preload-plugin/npm-publish.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/sn-satyendra/webpack-font-preload-plugin/npm-publish.yml/master?enable=pin
- Info: 0 out of 6 GitHub-owned GitHubAction dependencies pinned
- Info: 3 out of 3 npmCommand dependencies pinned
Reason
Found 0/4 approved changesets -- score normalized to 0
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/node.js.yml:1
- Warn: no topLevel permission defined: .github/workflows/npm-publish.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
17 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
- Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
- Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-hc6q-2mpp-qw7j
- Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More