Build: Don't commit the min file or version to main, add release process

.gitignore

@@ -12,6 +12,7 @@ tmp
 
 npm-debug.log*
 
+/dist
 /node_modules
 
 # Ignore BrowserStack testing files

.release-it.js

@@ -0,0 +1,29 @@
+"use strict";
+
+module.exports = {
+    preReleaseBase: 1,
+    hooks: {
+        "before:init": "bash ./build/release/pre-release.sh",
+        "after:version:bump":
+            "sed -i 's/main\\/AUTHORS.txt/${version}\\/AUTHORS.txt/' package.json",
+        "after:bump": "cross-env VERSION=${version} npm run build",
+        "before:git:release": "git add -f dist/",
+        "after:release": "echo 'Run the following to complete the release:' && " +
+            "echo './build/release/post-release.sh $\{version}'"
+    },
+    git: {
+        commitMessage: "Release: ${version}",
+        getLatestTagFromAllRefs: true,
+        pushRepo: "[email protected]:jquery/jquery-mousewheel.git",
+        requireBranch: "main",
+        requireCleanWorkingDir: true
+    },
+    github: {
+        pushRepo: "[email protected]:jquery/jquery-mousewheel.git",
+        release: true,
+        tokenRef: "JQUERY_GITHUB_TOKEN"
+    },
+    npm: {
+        publish: true
+    }
+};

ChangeLog.md → CHANGELOG.md

@@ -1,4 +1,4 @@
-# Mouse Wheel ChangeLog
+# Mouse Wheel Change Log
 
 ## 3.2.2
 

build/release/post-release.sh

@@ -0,0 +1,30 @@
+#!/bin/sh
+
+set -euo pipefail
+
+# $1: Version
+
+dist=tmp/release/dist
+
+if [[ -z "$1" ]] then
+	echo "Version is not set (1st argument)"
+	exit 1
+fi
+
+if [[ -z "$2" ]] then
+	echo "Blog URL is not set (2nd argument)"
+	exit 1
+fi
+
+# Restore AUTHORS URL
+sed -i "s/$1\/AUTHORS.txt/main\/AUTHORS.txt/" package.json
+git add package.json
+
+# Remove built files from tracking.
+npm run build:clean
+git rm --cached -r dist/
+git commit -m "Release: remove dist files from main branch"
+
+# Wait for confirmation from user to push changes
+read -p "Press enter to push changes to main branch"
+git push

build/release/pre-release.sh

@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -euo pipefail
+
+read -p "Press enter if you updated CHANGELOG.md; abort otherwise"
+
+# Install dependencies
+npm ci
+
+# Clean all release and build artifacts
+npm run build:clean
+
+# Run tests
+npm test

build/tasks/build.mjs

@@ -0,0 +1,51 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+import { exec as nodeExec } from "node:child_process";
+import util from "node:util";
+import { minify } from "./minify.mjs";
+
+const exec = util.promisify( nodeExec );
+
+const pkg = JSON.parse( await fs.readFile( "./package.json", "utf8" ) );
+
+async function isCleanWorkingDir() {
+    const { stdout } = await exec( "git status --untracked-files=no --porcelain" );
+    return !stdout.trim();
+}
+
+async function versionForDist( { srcPath, destPath, version } ) {
+    const code = await fs.readFile( srcPath, "utf8" );
+    const compiledContents = code.replace( /@VERSION/g, version );
+
+    await fs.mkdir( path.dirname( destPath ), { recursive: true } );
+    await fs.writeFile( destPath, compiledContents );
+    console.log( `${ destPath } v${ version } created.` );
+}
+
+export async function build( { version = process.env.VERSION } = {} ) {
+
+    // Add the short commit hash to the version string
+    // when the version is not for a release.
+    if ( !version ) {
+        const { stdout } = await exec( "git rev-parse --short HEAD" );
+        const isClean = await isCleanWorkingDir();
+
+        // "+SHA" is semantically correct
+        // Add ".dirty" as well if the working dir is not clean
+        version = `${ pkg.version }+${ stdout.trim() }${
+            isClean ? "" : ".dirty"
+        }`;
+    }
+
+    await versionForDist( {
+        srcPath: "src/jquery.mousewheel.js",
+        destPath: "dist/jquery.mousewheel.js",
+        version
+    } );
+
+    await minify( {
+        srcPath: "dist/jquery.mousewheel.js",
+        destPath: "dist/jquery.mousewheel.min.js",
+        version
+    } );
+}

build/minify.mjs → build/tasks/minify.mjs

@@ -1,11 +1,11 @@
 import fs from "node:fs/promises";
-import path from "node:path";
 import swc from "@swc/core";
+import path from "node:path";
 
-const rjs = /\.js$/;
+export async function minify( { srcPath, destPath, version } ) {
+    const contents = await fs.readFile( srcPath, "utf8" );
 
-export async function minify( { filename, dir } ) {
-    const contents = await fs.readFile( path.join( dir, filename ), "utf8" );
+    await fs.mkdir( path.dirname( destPath ), { recursive: true } );
 
     const { code } = await swc.minify(
         contents,
@@ -17,7 +17,11 @@ export async function minify( { filename, dir } ) {
             },
             format: {
                 ecma: 5,
-                asciiOnly: true
+                asciiOnly: true,
+                comments: false,
+                preamble: `/*! jQuery Mousewheel ${ version }` +
+                    " | (c) OpenJS Foundation and other contributors" +
+                    " | jquery.org/license */\n"
             },
             inlineSourcesContent: false,
             mangle: true,
@@ -26,12 +30,10 @@ export async function minify( { filename, dir } ) {
         }
     );
 
-    const minFilename = filename.replace( rjs, ".min.js" );
-
     await fs.writeFile(
-        path.join( dir, minFilename ),
+        destPath,
         code
     );
 
-    console.log( `file ${ minFilename } created.` );
+    console.log( `file ${ destPath } created.` );
 }

eslint.config.mjs

@@ -3,15 +3,19 @@ import globals from "globals";
 
 export default [
     {
-        ignores: [ "**/*.min.js" ],
+        ignores: [ "dist/**/*.js" ],
         rules: {
             ...jqueryConfig.rules,
             indent: [ "error", 4 ]
         }
     },
 
     {
-        files: [ "jquery.mousewheel.js", "jquery.mousewheel.min.js", "test/**/*.js" ],
+        files: [
+            "src/**/*.js",
+            "dist/**/*.js",
+            "test/**/*.js"
+        ],
         languageOptions: {
 
             // Support: IE 9 - 11+
@@ -31,7 +35,7 @@ export default [
     },
 
     {
-        files: [ "jquery.mousewheel.js" ],
+        files: [ "src/**/*.js" ],
         rules: {
             strict: [ "error", "function" ],
             indent: [
@@ -61,7 +65,21 @@ export default [
     },
 
     {
-        files: [ "eslint.config.mjs", "build/**/*.mjs" ],
+        files: [ "*.js" ],
+        languageOptions: {
+            ecmaVersion: "latest",
+            sourceType: "commonjs",
+            globals: {
+                ...globals.node
+            }
+        },
+        rules: {
+            ...jqueryConfig.rules
+        }
+    },
+
+    {
+        files: [ "*.mjs", "build/**/*.mjs" ],
         languageOptions: {
             ecmaVersion: "latest",
             sourceType: "module",