我正在尝试使用grunt-unused删除多个子目录中所有未使用的图像链接。为清晰起见,这是我的文件夹结构:
|-- dist
| |-- site-1
| | |—-index.html
| | |—-style.css
| | |—-app.js
| | |—-image1.jpg
| | |—-image2.jpg
| | |—-image3.jpg
| | |—-image4.jpg
| |-- site-2
| | |—-index.html
| | |—-style.css
| | |—-app.js
| | |—-image1.jpg
| | |—-image2.jpg
| | |—-image3.jpg
| | |—-image4.jpg
| |-- site-3
| | |—-index.html
| | |—-style.css
| | |—-app.js
| | |—-image1.jpg
| | |—-image2.jpg
| | |—-image3.jpg
| | |—-image4.jpg
我写了一个' forEach'函数来定位这些子文件夹,然后引用每个文件夹,类似于this post,但它不适用于未使用的任务。它不会遍历每个目录,并且控制台会在很短的时间内检测到没有未使用的文件,就像它实际上没有做任何事情一样。
我哪里错了?
grunt.registerTask('prodOutput', function () {
// read all subdirectories of dist/ folder, excluding the assets folder
grunt.file.expand('dist/*', '!dist/assets/**').forEach(function (dir) {
//get the current unused config
var unusedConfig = grunt.config.get('unused') || {};
//set options for grunt-unused, including the folder variable 'dir' as the reference of where to look
unusedConfig[dir] = {
option: {
reference: dir + '/',
directory: ['**/*.css', '**/*.html', '**/*.js'],
remove: false, // set to true to delete unused files from project
reportOutput: 'report.txt', // set to false to disable file output
fail: false // set to true to make the task fail when unused files are found
}
};
grunt.config.set('unused', unusedConfig);
});
grunt.task.run('unused');
});
答案 0 :(得分:0)
正如我在评论中提到的那样......主要问题是您在运行任务之前在forEach
函数中动态配置多个Targets,但是grunt-unused不支持多目标配置。
同样grunt-unused
期望包含对其他文件(即index.html
)的引用/链接的文件与其引用的文件(例如图像,css等)位于不同的目录/文件夹中,但是,帖子中提供的文件夹结构是扁平化的。
快速浏览一下其他grunt插件后,似乎并不能满足您的要求。我认为你可以实现这一目标的唯一方法是编写自己的自定义任务/插件来处理这个问题。
要实现这一目标,您可以执行以下操作:
创建一个导出Registered MutliTask的单独Javascript模块。将文件命名为delete-unused.js
并将其保存到名为tasks
的目录中,该目录与Gruntfile.js
位于同一顶级目录中。
目录结构
您的目录结构应该是这样的:
.
├── dist
│ ├── site-1
│ ├── site-2
│ ├── ...
│ └── assets
│
├── Gruntfile.js
│
├── node_modules
│ └── ...
│
├── package.json
│
└── tasks
└── delete-unused.js
删除-unused.js 强>
module.exports = function(grunt) {
'use strict';
// Requirements
var fs = require('fs');
var path = require('path');
grunt.registerMultiTask('unused', 'Delete unused assets', function() {
// Default options. These are used when no options are
// provided via the initConfig({...}) papaparse task.
var options = this.options({
reportOutput: false,
remove: false
});
var reportTxt = '';
// Loop over each src directory path provided via the configs src array.
this.data.src.forEach(function(dir) {
// Log if the directory src path provided cannot be found.
if (!grunt.file.isDir(dir)) {
grunt.fail.warn('Directory not found: '.yellow + dir.yellow);
}
// Append a forward slash If the directory path provided
// in the src Array does not end with one.
if (dir.slice(-1) !== '/') {
dir += '/';
}
// Generate the globbin pattern (only one level deep !).
var glob = [dir, '*'].join('');
// Create an Array of all top level folders (e.g. site-*)
// in the dist directory and exclude the assets directory.
var dirs = grunt.file.expand(glob).map(function(dir) {
return dir;
});
// Loop over each directory.
dirs.forEach(function(dir) {
// Add the folders to exclude here.
if (dir === './dist/assets') {
return;
}
// Log status and update report
grunt.log.write('\nProcessing folder ' + dir);
reportTxt += '\nProcessing folder ' + dir;
// Empty Array to be populated with unused asset references.
var unused = [];
// Define the path to index.html
var pathToHtml = [dir, '/', 'index.html'].join('');
// Create Array of file names and filepaths (exclude index.html)
var assets = grunt.file.expand([dir + '/**/*.*', '!index.html'])
.map(function(file) {
return {
fpath: file,
fname: path.basename(file)
};
});
// Log/Report missing 'index.html' and return early.
if (!grunt.file.exists(pathToHtml)) {
grunt.log.write('\n >> Cannot find index.html in ' + dir + '/\n');
reportTxt += '\n >> Cannot find index.html in ' + dir + '/\n';
return;
}
// Read the contents of index.html.
var html = fs.readFileSync(pathToHtml, {
encoding: 'utf8'
});
// Loop over each file asset to find if linked in index.html
assets.forEach(function(asset) {
// Backslash-escape the dot [.] in filename for RegExp object.
var escapedFilename = asset.fname.replace('.', '\\.');
// Dynamically create a RegExp object to search for instances
// of the asset filename in the contents of index.html.
// This ensures the reference is an actual linked asset and
// not plain text written elsewhere in the document.
//
// For an explanation of this Regular Expression visit:
// https://regex101.com/r/XZpldm/4/
var regex = new RegExp("(?:href=|src=|url\\()(?:[\",']?)(.*"
+ escapedFilename + ")[\",',\\)]+?", "g");
// Search index.html using the regex
if (html.search(regex) === -1 && asset.fname !== 'index.html') {
unused.push(asset); // <-- Not found so add to list.
}
});
// Log status and update report
grunt.log.write('\n ' + unused.length + ' unused assets found:\n');
reportTxt += '\n ' + unused.length + ' unused assets found:\n';
//Delete the unused asset files.
unused.forEach(function(asset) {
if (options.remove) {
grunt.file.delete(asset.fpath);
// Log status and update report
grunt.log.write(' deleted: ' + asset.fpath + '\n');
reportTxt += ' deleted: ' + asset.fpath + '\n';
} else {
// Log status and update report
grunt.log.write(' ' + asset.fpath + '\n');
reportTxt += ' ' + asset.fpath + '\n';
}
});
});
if (options.reportOutput) {
grunt.file.write(options.reportOutput, reportTxt);
}
});
});
};
<强> Gruntfile.js 强>
按如下方式配置Gruntfile.js
。
module.exports = function(grunt) {
'use strict';
grunt.initConfig({
// ...
unused: {
options: {
reportOutput: 'report.txt',
remove: true
},
dist: {
src: ['./dist/']
}
}
});
// Load the custom multiTask named `unused` - which is defined
// in `delete-unused.js` stored in the directory named `tasks`.
grunt.loadTasks('./tasks');
// Register and add unused to the default Task.
grunt.registerTask('default', [
// ...
'unused',
// ...
]);
// Or add it to another named Task.
grunt.registerTask('foobar', [
// ...
'unused',
// ...
]);
};
备注强>
不再使用grunt-unused
插件,因此您可以通过CLi工具运行以下插件来卸载它:$ npm un -D grunt-unused
delete-unused.js
自定义模块在Gruntfile.js
中提供了类似的配置,其选项少于grunt-unused
中的选项。配置中的src
数组接受要处理的文件夹(即./dist/
)的路径。而不是glob模式 - 在grunt-unused.js
内生成glob模式。
reportOutput
和remove
的默认选项设置为false
中的grunt-unused.js
。首次运行任务时,我建议您最初在remove
配置中将false
选项设置为Gruntfile.js
。这将只是将未使用的资产记录到控制台,并允许您检查它是否符合您的要求。显然,将remove
选项设置为true
会在重新运行时删除所有未使用的资产。
我注意到您在帖子中提供了glob模式'!dist/assets/**'
以排除assets
文件夹的处理。不是通过src
配置传递glob模式以进行排除,而是在delete-unused.js
中对其进行了硬编码。您将在以下行中看到它:
// Add the folders to exclude here.
if (dir === './dist/assets') {
return;
}
如果您要排除dist
文件夹中的其他目录,则需要在那里添加:例如:
// Add the folders to exclude here.
if (dir === './dist/assets'
|| dir === './dist/foo'
|| dir === './dist/quux') {
return;
}
此解决方案检查site-*
文件夹中找到的资产是否仅在相应的index.html
内链接/引用,并不检查它们是否在任何.css
文件中引用
delete-unused.js
使用正则表达式查找资产是否实际链接到index.html
,而不是文档中其他位置写的纯文本(在文本段落中)例如)。可以找到所使用的自定义正则表达式的解释here。
我希望这有帮助!