grunt-swn-cachebuster 0.2.0 → 0.3.0

package/.jshintrc

@@ -1,13 +1,13 @@
-{
-  "curly": true,
-  "eqeqeq": true,
-  "immed": true,
-  "latedef": true,
-  "newcap": true,
-  "noarg": true,
-  "sub": true,
-  "undef": true,
-  "boss": true,
-  "eqnull": true,
-  "node": true
-}
+{
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "boss": true,
+  "eqnull": true,
+  "node": true
+}

package/Gruntfile.js

@@ -1,73 +1,73 @@
-/*
- * grunt-swn-cachebuster
- * https://github.com/Swaven/grunt-swn-cachebuster
- *
- * Copyright (c) 2017 Swaven
- * Licensed under the MIT license.
- */
-
-'use strict';
-
-module.exports = function(grunt) {
-
-  // Project configuration.
-  grunt.initConfig({
-    jshint: {
-      all: [
-        'Gruntfile.js',
-        'tasks/*.js',
-        '<%= nodeunit.tests %>'
-      ],
-      options: {
-        jshintrc: '.jshintrc'
-      }
-    },
-
-    // Before generating any new files, remove any previously-created files.
-    clean: {
-      tests: ['tmp']
-    },
-
-    // Configuration to be run (and then tested).
-    cachebuster: {
-      default_options: {
-        options: {
-        },
-        files: {
-          'tmp/default_options': ['test/fixtures/testing', 'test/fixtures/123']
-        }
-      },
-      custom_options: {
-        options: {
-          separator: ': ',
-          punctuation: ' !!!'
-        },
-        files: {
-          'tmp/custom_options': ['test/fixtures/testing', 'test/fixtures/123']
-        }
-      }
-    },
-
-    // Unit tests.
-    nodeunit: {
-      tests: ['test/*_test.js']
-    }
-
-  });
-
-  // Actually load this plugin's task(s).
-  grunt.loadTasks('tasks');
-
-  // These plugins provide necessary tasks.
-  grunt.loadNpmTasks('grunt-contrib-jshint');
-  grunt.loadNpmTasks('grunt-contrib-clean');
-  grunt.loadNpmTasks('grunt-contrib-nodeunit');
-
-  // Whenever the "test" task is run, first clean the "tmp" dir, then run this
-  // plugin's task(s), then test the result.
-  grunt.registerTask('test', ['clean', 'cachebuster', 'nodeunit']);
-
-  // By default, lint and run all tests.
-  grunt.registerTask('default', ['jshint', 'test']);
-
-};
+/*
+ * grunt-swn-cachebuster
+ * https://github.com/Swaven/grunt-swn-cachebuster
+ *
+ * Copyright (c) 2017 Swaven
+ * Licensed under the MIT license.
+ */
+
+'use strict';
+
+module.exports = function(grunt) {
+
+  // Project configuration.
+  grunt.initConfig({
+    jshint: {
+      all: [
+        'Gruntfile.js',
+        'tasks/*.js',
+        '<%= nodeunit.tests %>'
+      ],
+      options: {
+        jshintrc: '.jshintrc'
+      }
+    },
+
+    // Before generating any new files, remove any previously-created files.
+    clean: {
+      tests: ['tmp']
+    },
+
+    // Configuration to be run (and then tested).
+    cachebuster: {
+      default_options: {
+        options: {
+        },
+        files: {
+          'tmp/default_options': ['test/fixtures/testing', 'test/fixtures/123']
+        }
+      },
+      custom_options: {
+        options: {
+          separator: ': ',
+          punctuation: ' !!!'
+        },
+        files: {
+          'tmp/custom_options': ['test/fixtures/testing', 'test/fixtures/123']
+        }
+      }
+    },
+
+    // Unit tests.
+    nodeunit: {
+      tests: ['test/*_test.js']
+    }
+
+  });
+
+  // Actually load this plugin's task(s).
+  grunt.loadTasks('tasks');
+
+  // These plugins provide necessary tasks.
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-nodeunit');
+
+  // Whenever the "test" task is run, first clean the "tmp" dir, then run this
+  // plugin's task(s), then test the result.
+  grunt.registerTask('test', ['clean', 'cachebuster', 'nodeunit']);
+
+  // By default, lint and run all tests.
+  grunt.registerTask('default', ['jshint', 'test']);
+
+};

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2017 Swaven
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2017 Swaven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,62 +1,55 @@
-# grunt-swn-cachebuster
-
-> Appends timestamp param to import urls
-
-## Getting Started
-This plugin requires Grunt `>=0.4.5`
-
-If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
-
-```shell
-npm install grunt-swn-cachebuster --save-dev
-```
-
-Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
-
-```js
-grunt.loadNpmTasks('grunt-swn-cachebuster');
-```
-
-## The "cachebuster" task
-
-### Overview
-
-This task looks into source files, and edits all html and js file urls to append a timestamp query string parameter. It ignores urls that start with  */bower_components*.
-
-In your project's Gruntfile, add a section named `cachebuster` to the data object passed into `grunt.initConfig()`.
-
-```js
-grunt.initConfig({
-  cachebuster: {
-    your_target: {
-      // Target-specific file lists and/or options go here.
-    },
-  },
-});
-```
-
-### Usage Examples
-
-```js
-grunt.initConfig({
-  cachebuster: {
-    all: {
-      expand: true,
-      cwd: 'assets/',
-      src: ['*.html', 'elements/**/*.html', '!build/', 'elements/swn-app/swn-app.js'],
-      dest: 'assets/build/'
-    },
-  },
-});
-```
-
-## Contributing
-In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
-
-## Release History
-
-* 2017-09-18: [v0.2.0](https://github.com/Swaven/grunt-swn-cachebuster/releases/tag/v0.2.0): error handling
-* 2017-09-18: [v0.1.3](https://github.com/Swaven/grunt-swn-cachebuster/releases/tag/v0.1.3): add some tests
-* 2017-06-28: [v0.1.2](https://github.com/Swaven/grunt-swn-cachebuster/releases/tag/v0.1.2): fix regex
-* 2017-06-27: [v0.1.1](https://github.com/Swaven/grunt-swn-cachebuster/releases/tag/v0.1.1): more robust regex
-* 2017-06-27: [v0.1.0](https://github.com/Swaven/grunt-swn-cachebuster/releases/tag/v0.1.0): first release
+# grunt-swn-cachebuster
+
+> Appends timestamp param to import urls
+
+## Getting Started
+
+This plugin requires **Node.js `>=22`** and **Grunt `^1.6.1`**.
+
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
+
+```shell
+npm install grunt-swn-cachebuster --save-dev
+```
+
+Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+
+```js
+grunt.loadNpmTasks('grunt-swn-cachebuster');
+```
+
+## The "cachebuster" task
+
+### Overview
+
+This task looks into source files, and edits all html and js file urls to append a timestamp query string parameter. It ignores urls that start with  */bower_components*.
+
+In your project's Gruntfile, add a section named `cachebuster` to the data object passed into `grunt.initConfig()`.
+
+```js
+grunt.initConfig({
+  cachebuster: {
+    your_target: {
+      // Target-specific file lists and/or options go here.
+    },
+  },
+});
+```
+
+### Usage Examples
+
+```js
+grunt.initConfig({
+  cachebuster: {
+    all: {
+      expand: true,
+      cwd: 'assets/',
+      src: ['*.html', 'elements/**/*.html', '!build/', 'elements/swn-app/swn-app.js'],
+      dest: 'assets/build/'
+    },
+  },
+});
+```
+
+## Contributing
+In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

package/{tasks → lib}/replace.js

@@ -1,13 +1,14 @@
-'use strict'
-
-const rx = /(\/?bower_components)?(\/.*\.(html|js))('|"|`)/gi, // find all dependencies except bower components
-      ts = Date.now() // timestamp we'll add to all dependencies urls
-
-module.exports = exports = function replace(content){
-  if (typeof content !== 'string')
-    throw new Error('Content is not a string')
-
-  return content.replace(rx, ($0, $1, $2, $3, $4) => {
-    return $1 ? $0 : `${$2}?v=${ts}${$4}`
-  })
-}
+'use strict'
+
+const rx = /(\/?bower_components)?(\/.*\.(html|js))('|"|`)/gi, // find all dependencies
+      ts = Date.now() // timestamp we'll add to all dependencies urls
+
+module.exports = exports = function replace(content){
+  if (typeof content !== 'string')
+    throw new Error(`Content is not a string`)
+
+  return content.replace(rx, ($0, $1, $2, $3, $4) => {
+    // ignore urls to bower_components
+    return $1 ? $0 : `${$2}?v=${ts}${$4}`
+  })
+}

package/package.json

@@ -1,42 +1,45 @@
-{
-  "name": "grunt-swn-cachebuster",
-  "description": "Appends timestamp param to import urls",
-  "version": "0.2.0",
-  "homepage": "https://github.com/Swaven/grunt-swn-cachebuster",
-  "author": {
-    "name": "Swaven",
-    "email": "antoine@swaven.com"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Swaven/grunt-swn-cachebuster.git"
-  },
-  "bugs": {
-    "url": "https://github.com/Swaven/grunt-swn-cachebuster/issues"
-  },
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "https://github.com/Swaven/grunt-swn-cachebuster/blob/master/LICENSE-MIT"
-    }
-  ],
-  "engines": {
-    "node": ">=6.10.2"
-  },
-  "scripts": {
-    "test": "mocha"
-  },
-  "devDependencies": {
-    "chai": "^4.1.2",
-    "grunt": "~0.4.5",
-    "grunt-contrib-clean": "^0.5.0",
-    "grunt-contrib-jshint": "^0.9.2",
-    "grunt-contrib-nodeunit": "^0.3.3"
-  },
-  "keywords": [
-    "gruntplugin"
-  ],
-  "dependencies": {
-    "mkdirp": "^0.5.1"
-  }
-}
+{
+  "name": "grunt-swn-cachebuster",
+  "description": "Appends timestamp param to import urls",
+  "version": "0.3.0",
+  "homepage": "https://github.com/Swaven/grunt-swn-cachebuster",
+  "author": {
+    "name": "Swaven",
+    "email": "antoine@swaven.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Swaven/grunt-swn-cachebuster.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Swaven/grunt-swn-cachebuster/issues"
+  },
+  "licenses": [
+    {
+      "type": "MIT",
+      "url": "https://github.com/Swaven/grunt-swn-cachebuster/blob/master/LICENSE-MIT"
+    }
+  ],
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "test": "mocha"
+  },
+  "overrides": {
+    "js-yaml": "~3.14.2",
+    "lodash": "~4.18.1",
+    "minimatch": "^3.1.3 || ^5.1.8 || ^9.0.9"
+  },
+  "devDependencies": {
+    "chai": "^4.1.2",
+    "grunt": "^1.6.1",
+    "grunt-contrib-clean": "^2.0.1",
+    "grunt-contrib-jshint": "^3.2.0",
+    "grunt-contrib-nodeunit": "^5.0.0",
+    "mocha": "^11.0.0"
+  },
+  "keywords": [
+    "gruntplugin"
+  ]
+}

package/tasks/cachebuster.js

@@ -1,70 +1,65 @@
-'use strict'
-
-/*
-* grunt-swn-cachebuster
-* https://github.com/Swaven/grunt-swn-cachebuster
-*
-* Copyright (c) 2017 Swaven
-* Licensed under the MIT license.
-*/
-
-const fs = require('fs'),
-      path = require('path'),
-      mkdirp = require('mkdirp'),
-      replace = require('./replace.js')
-
-module.exports = function(grunt){
-
-
-  grunt.registerMultiTask('cachebuster', 'Appends timestamp param to import urls', function(){
-    const done = this.async(),
-          options = this.options(),
-          self = this
-
-    var proms = []
-
-    // get all files' content and dependencies
-    for (let i = 0; i < this.files.length; i++){
-      proms.push(updateLinks(this.files[i]))
-    }
-
-    Promise.all(proms)
-    .then(() => {
-      done(true)
-    })
-  })
-
-  // reads file, updates all dependencies urls and write at destination
-  function updateLinks(fileInfo){
-    return new Promise((resolve, reject) => {
-      var filepath = fileInfo.src[0]
-      fs.readFile(filepath, {encoding: 'utf8'}, (err, data) => {
-        if (err){
-          grunt.fail.warn(`Error reading ${filepath}: ${err}`)
-          return reject()
-        }
-        // add timestamp query string to all matches
-        try{
-          let result = replace(data)
-          return resolve(result)
-        }
-        catch(err){
-          grunt.file.warn(`Error replacing ${filepath}: ${err}`)
-        }
-      })
-    })
-    .then(data => {
-      return new Promise((resolve, reject) => {
-        mkdirp.sync(path.dirname(fileInfo.dest))
-        fs.writeFile(fileInfo.dest, data, 'utf8', (err, data) => {
-          if (err){
-            grunt.fail.warn(`Error writing ${fileInfo.dest}: ${err}`)
-            return reject()
-          }
-          return resolve()
-        })
-      })
-    })
-
-  }
-}
+'use strict'
+
+/*
+* grunt-swn-cachebuster
+* https://github.com/Swaven/grunt-swn-cachebuster
+*
+* Copyright (c) 2017 Swaven
+* Licensed under the MIT license.
+*/
+
+const fs = require('fs'),
+      path = require('path'),
+      replace = require('../lib/replace.js'),
+      util = require('util'),
+      lstat = util.promisify(fs.lstat),
+      readFile = util.promisify(fs.readFile),
+      writeFile = util.promisify(fs.writeFile)
+
+module.exports = function(grunt){
+
+
+  grunt.registerMultiTask('cachebuster', 'Appends timestamp param to import urls', function(){
+    const done = this.async(),
+          options = this.options(),
+          self = this
+
+    var proms = []
+
+    // get all files' content and dependencies
+    for (let i = 0; i < this.files.length; i++){
+      proms.push(updateLinks(this.files[i]))
+    }
+
+    Promise.all(proms)
+    .then(() => {
+      done(true)
+    })
+  })
+
+  // reads file, updates all dependencies urls and write at destination
+  async function updateLinks(fileInfo){
+    var filepath = fileInfo.src[0]
+
+    try{
+      let stats = await lstat(filepath)
+
+      // not a file: ignore
+      if (!stats.isFile()){
+        // console.log(`${filepath} is not a file, ignore`)
+        return Promise.resolve()
+      }
+
+      let data = await readFile(filepath, {encoding: 'utf8'}),
+          result = replace(data)
+
+      // write update content to output file
+      fs.mkdirSync(path.dirname(fileInfo.dest), { recursive: true })
+      await writeFile(fileInfo.dest, result, 'utf8')
+      return Promise.resolve()
+    }
+    catch(err){
+      grunt.fail.warn(`${filepath}: ${err.message}`)
+    }
+  }
+}

package/test/test.js

@@ -1,7 +1,7 @@
 
 const assert = require('chai').assert
 
-var replace = require('../tasks/replace.js')
+var replace = require('../lib/replace.js')
 
 describe('Replace', () => {
   it('ignore bower_components', () => {

package/.npmignore

@@ -1,3 +0,0 @@
-node_modules
-npm-debug.log
-tmp