2.3.0

- Switched from `var` to `let` and `const` for variable scope - Removed `use strict` directives
RobLoach · Jan 4, 2024 · c9a250a · c9a250a
1 parent abad155
commit c9a250a
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 52 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,12 +2,13 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [2.3.0] - Unreleased
+## [2.3.0] - January 4th, 2024
 ### Changed
+- Switched from `var` to `let` and `const` for variable scope
+- Removed `use strict` directives
 - Updated developer dependencies
+- Minor updates to developer documentation
 - Switched to GitHub Actions for testing
-- Removed `use strict` directives
-- Switched from `var` to `let` and `const` for variable scope
 
 ## [2.2.3] - May 14th, 2019
 ### Fixed

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # License
 
-Copyright &copy; 2016-2020 [Rob Loach](http://github.com/RobLoach)
+Copyright &copy; 2016-2024 [Rob Loach](http://github.com/RobLoach)
 
 ## GPL-2.0
 

diff --git a/example/index.html b/example/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <script src="http://code.jquery.com/jquery-3.4.1.js"></script>
+    <script src="http://code.jquery.com/jquery-3.7.1.js"></script>
     <script src="../jquery.once.js"></script>
   </head>
   <body>

diff --git a/jquery.once.d.ts b/jquery.once.d.ts
@@ -1,5 +1,5 @@
 /*!
- * jQuery Once v2.2.3 Typescript Definition - http://github.com/robloach/jquery-once
+ * jQuery Once v2.3.0 Typescript Definition - http://github.com/robloach/jquery-once
  * @license MIT, GPL-2.0
  *   http://opensource.org/licenses/MIT
  *   http://opensource.org/licenses/GPL-2.0
@@ -8,7 +8,7 @@
 
 ///<reference types="jquery" />
 
-interface JQuery{
+interface JQuery {
 
   /**
    * Filter elements that have yet to be processed by the given data ID.
@@ -48,7 +48,7 @@ interface JQuery{
    * @global
    * @public
    */
-  once(id?:string): JQuery;
+  once(id?: string): JQuery;
 
   /**
    * Removes the once data from elements, based on the given ID.
@@ -113,7 +113,7 @@ interface JQuery{
    * @global
    * @public
    */
-  findOnce(id:string): JQuery;
+  findOnce(id: string): JQuery;
 }
 
 
diff --git a/jquery.once.js b/jquery.once.js
@@ -1,12 +1,12 @@
 /*!
- * jQuery Once v2.2.3 - http://github.com/robloach/jquery-once
+ * jQuery Once v2.3.0 - http://github.com/robloach/jquery-once
  * @license MIT, GPL-2.0
  *   http://opensource.org/licenses/MIT
  *   http://opensource.org/licenses/GPL-2.0
  */
 
 /**
- * Universal Module Definition
+ * jQuery Once: Universal Module Definition
  *
  * jQuery Once has a dependency on jQuery, so we wrap the code with a UMD
  * pattern in order to allow loading jQuery and jQuery Once through a module
@@ -34,7 +34,7 @@
    * @param {string} [id=once]
    *   A string representing the ID to check. Defaults to `'once'`.
    *
-   * @returns {number} The valid ID name.
+   * @returns {string} The valid ID name.
    *
    * @throws TypeError when an ID is provided, but not a string.
    * @private

diff --git a/jquery.once.min.js b/jquery.once.min.js
diff --git a/jquery.once.min.js.map b/jquery.once.min.js.map
diff --git a/package.json b/package.json
@@ -16,8 +16,9 @@
   "main": "jquery.once.js",
   "contributors": [
     "JohnAlbin (https://github.com/JohnAlbin)",
-    "Rob Loach <[email protected]> (https://github.com/RobLoach)",
-    "theodoreb (https://github.com/theodoreb)"
+    "Rob Loach (https://github.com/RobLoach)",
+    "theodoreb (https://github.com/theodoreb)",
+    "Olavo Rocha Neto (https://github.com/olavorn)"
   ],
   "repository": {
     "type": "git",
@@ -64,5 +65,10 @@
       "jquery.once.min.js",
       "jquery.once.min.js.map"
     ]
+  },
+  "xo": {
+    "rules": {
+      "unicorn/prefer-module": 0
+    }
   }
 }
diff --git a/test/index.js b/test/index.js
diff --git a/test/test.js b/test/test.js
@@ -15,36 +15,36 @@ describe('jQuery Once', () => {
    * Turn the Mocha test environment into a DOM environment with JSDom.
    */
   jsdom({
-    url: 'http://localhost'
+    url: 'http://localhost',
   });
 
   /**
    * Before the tests initiate, load jQuery and jQuery Once.
    */
-  before(function () {
+  before(() => {
     $ = require('jquery');
     $.once = require('../jquery.once.js');
   });
 
   /**
    * Before each test, reset the document body so that there is fresh data.
    */
-  beforeEach(function () {
+  beforeEach(() => {
     // Build the body HTML.
     /* globals document */
     document.body.innerHTML = '<p>This is the <span>Test</span>.</p>';
   });
 
-  it('should require ID to be a string', function () {
+  it('should require ID to be a string', () => {
     // Expect it to throw an error.
-    assert.throws(function () {
-      $('span').once(function () {
+    assert.throws(() => {
+      $('span').once(() => {
         // Nothing.
       });
     });
   });
 
-  it('properly executes .once("test2")', function () {
+  it('properly executes .once("test2")', () => {
     // Create one once('test2') call.
     $('span').once('test2').data('test2', 'foo');
 
@@ -56,12 +56,12 @@ describe('jQuery Once', () => {
     assert.strictEqual(data, 'foo');
   });
 
-  it('is called only once with an ID', function () {
+  it('is called only once with an ID', () => {
     // Count the number of times once() was called.
     $('span').data('count', 0);
 
     // Create the once() callback.
-    const callback = function () {
+    const callback = () => {
       // Increment the count variable stored in the data.
       $('span').data('count', $('span').data('count') + 1);
     };
@@ -76,12 +76,12 @@ describe('jQuery Once', () => {
     assert.strictEqual(count, 1, 'It was called ' + count + ' times.');
   });
 
-  it('is called only once without an ID', function () {
+  it('is called only once without an ID', () => {
     // Count the number of times once() was called.
     $('span').data('once', 0);
 
     // Create the once() callback.
-    const callback = function () {
+    const callback = () => {
       $('span').data('once', $('span').data('once') + 1);
     };
 
@@ -95,7 +95,7 @@ describe('jQuery Once', () => {
     assert.strictEqual(count, 1, 'It was called ' + count + ' times.');
   });
 
-  it('retrieves empty once data correctly', function () {
+  it('retrieves empty once data correctly', () => {
     // Verify that the element starts without the class.
     let hasData = $('span').data('jquery-once-test3');
     assert(!hasData, 'Value not applied in the beginning.');
@@ -108,7 +108,7 @@ describe('jQuery Once', () => {
     assert(hasData, 'The value is properly applied after once().');
   });
 
-  it('calls removeOnce() correctly', function () {
+  it('calls removeOnce() correctly', () => {
     // Create one once() call.
     $('span').once('test4');
 
@@ -122,7 +122,7 @@ describe('jQuery Once', () => {
     assert(!hasData, 'The value is properly removed when called removeOnce().');
   });
 
-  it('calls findOnce() correctly', function () {
+  it('calls findOnce() correctly', () => {
     // Append an additional span to the end.
     document.body.innerHTML += '<p>This is the <span>Test 2</span>.</p>';