feat: Migrate to webpack Asset Modules

https://webpack.js.org/guides/asset-modules/
pangolinjs · Aug 9, 2021 · 7f89a3b · 7f89a3b
1 parent 7159cd9
commit 7f89a3b
Show file tree

Hide file tree

Showing 20 changed files with 2,126 additions and 2,728 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,7 +32,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: 15
+          node-version: 16
       - name: Install dependencies
         run: npm ci
       - name: Test unit

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-15
+16
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Framework for design system development with Nunjucks, Sass, and JavaScript.
 
-Requires [Node.js 15](https://nodejs.org).
+Requires [Node.js 15 or higher](https://nodejs.org).
 
 ## Create a new project with `npx`
 

diff --git a/lib/generate-asset-filename.js b/lib/generate-asset-filename.js
@@ -0,0 +1,10 @@
+/**
+ * Generate file-loader options
+ * @param {Object} options Options
+ * @param {'img'|'video'|'audio'|'font'} options.type File type
+ * @param {boolean|'imported'|'all'} [options.hash] Hash file names
+ * @returns {string} file-loader options
+ */
+export default function ({ type, hash }) {
+  return `${type}/${hash ? '[contenthash:8]' : '[name]'}[ext]`
+}
diff --git a/lib/generate-file-loader-options.js b/lib/generate-file-loader-options.js
diff --git a/lib/generate-output-filename.js b/lib/generate-output-filename.js
@@ -2,7 +2,7 @@
  * Generate output filename
  * @param {Object} options Options
  * @param {'js'|'css'} options.type File type
- * @param {boolean|'imported'|'all'} options.hash Hash file names
+ * @param {boolean|'imported'|'all'} [options.hash] Hash file names
  * @returns {string} File name
  */
 export default function ({ type, hash }) {

diff --git a/lib/get-config.js b/lib/get-config.js
@@ -46,8 +46,8 @@ const defaultConfig = {
 /**
  * Get config
  * @param {Object} options Options
- * @param {string} options.context Working directory
- * @returns {Object} Config
+ * @param {string} [options.context] Working directory
+ * @returns {Promise<Object>} Config
  */
 export default async function ({ context }) {
   const pkg = await getPkg({ context })

diff --git a/lib/get-pkg.js b/lib/get-pkg.js
@@ -5,7 +5,7 @@ import path from 'path'
  * Get package.json
  * @param {Object} options Options
  * @param {string} options.context Working directory
- * @returns {Object} package.json
+ * @returns {Promise<Object>} package.json
  */
 export default async function ({ context }) {
   try {