Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added module.exports and removed (almost) all _global #317

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Added module.exports and removed (almost) all _global #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3cc86a5
Added module.exports and removed (almost) all _global
pieterD7 Dec 26, 2023
cee2c39
Missing exports
pieterD7 Dec 26, 2023
b3d1871
Removed new functions witout purpose
pieterD7 Dec 27, 2023
35b44fc
browserify instead of uglify
pieterD7 Jan 2, 2024
dd30a07
Added Section 508
pieterD7 Jan 7, 2024
160f7a5
Changed object sniff container
pieterD7 Jan 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 38 additions & 36 deletions Auditor/HTMLCSAuditor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*
*/

_global.HTMLCSAuditor = new function()
var HTMLCSAuditor = new function()
{
var _prefix = 'HTMLCS-';
var _screen = '';
Expand Down Expand Up @@ -151,7 +151,7 @@ _global.HTMLCSAuditor = new function()
var header = _doc.createElement('div');
header.className = _prefix + 'header';
header.innerHTML = 'HTML_CodeSniffer by Squiz';
header.setAttribute('title', _global.HTMLCS.getTranslation("auditor_using_standard") + standard);
header.setAttribute('title', HTMLCS.getTranslation("auditor_using_standard") + standard);

var dragging = false;
var prevX = 0;
Expand Down Expand Up @@ -210,7 +210,7 @@ _global.HTMLCSAuditor = new function()

var closeIcon = _doc.createElement('div');
closeIcon.className = _prefix + 'close';
closeIcon.setAttribute('title', _global.HTMLCS.getTranslation("auditor_close"));
closeIcon.setAttribute('title', HTMLCS.getTranslation("auditor_close"));
closeIcon.onmousedown = function() {
self.close.call(self);
};
Expand Down Expand Up @@ -245,25 +245,25 @@ _global.HTMLCSAuditor = new function()
var divider = ', &#160;<span class="' + _prefix + 'divider"></span>';

if (errors > 0) {
var typeName = _global.HTMLCS.getTranslation("auditor_errors");
var typeName = HTMLCS.getTranslation("auditor_errors");
if (errors === 1) {
typeName = _global.HTMLCS.getTranslation("auditor_error");
typeName = HTMLCS.getTranslation("auditor_error");
}
leftContents.push('<strong>' + errors + '</strong> ' + typeName);
}

if (warnings > 0) {
var typeName = _global.HTMLCS.getTranslation("auditor_warnings");
var typeName = HTMLCS.getTranslation("auditor_warnings");
if (warnings === 1) {
typeName = _global.HTMLCS.getTranslation("auditor_warning");
typeName = HTMLCS.getTranslation("auditor_warning");
}
leftContents.push('<strong>' + warnings + '</strong> ' + typeName);
}

if (notices > 0) {
var typeName = _global.HTMLCS.getTranslation("auditor_notices");
var typeName = HTMLCS.getTranslation("auditor_notices");
if (notices === 1) {
typeName = _global.HTMLCS.getTranslation("auditor_notice");
typeName = HTMLCS.getTranslation("auditor_notice");
}
leftContents.push('<strong>' + notices + '</strong> ' + typeName);
}
Expand Down Expand Up @@ -333,7 +333,7 @@ _global.HTMLCSAuditor = new function()
lineageHomeLink.href = 'javascript:';

var lineageHomeSpan = _doc.createElement('span');
lineageHomeSpan.innerHTML = _global.HTMLCS.getTranslation("auditor_home");
lineageHomeSpan.innerHTML = HTMLCS.getTranslation("auditor_home");
lineageHomeLink.appendChild(lineageHomeSpan);

lineageHomeLink.onmousedown = function() {
Expand All @@ -347,8 +347,8 @@ _global.HTMLCSAuditor = new function()
var lineageReportLink = _doc.createElement('a');
lineageReportLink.className = _prefix + 'lineage-link';
lineageReportLink.href = 'javascript:';
lineageReportLink.innerHTML = _global.HTMLCS.getTranslation("auditor_report");
lineageReportLink.setAttribute('title', _global.HTMLCS.getTranslation("auditor_back_to_report"));
lineageReportLink.innerHTML = HTMLCS.getTranslation("auditor_report");
lineageReportLink.setAttribute('title', HTMLCS.getTranslation("auditor_back_to_report"));

lineageReportLink.onmousedown = function() {
var list = _doc.querySelectorAll('.HTMLCS-inner-wrapper')[0];
Expand All @@ -363,7 +363,7 @@ _global.HTMLCSAuditor = new function()
// Issue Count item.
var lineageTotalsItem = _doc.createElement('li');
lineageTotalsItem.className = _prefix + 'lineage-item';
lineageTotalsItem.innerHTML = _global.HTMLCS.getTranslation("auditor_issue") + ' ' + issue + ' ' + _global.HTMLCS.getTranslation("auditor_of") + ' ' + totalIssues;
lineageTotalsItem.innerHTML = HTMLCS.getTranslation("auditor_issue") + ' ' + issue + ' ' + HTMLCS.getTranslation("auditor_of") + ' ' + totalIssues;

lineageHomeItem.appendChild(lineageHomeLink);
lineageReportItem.appendChild(lineageReportLink);
Expand All @@ -375,7 +375,7 @@ _global.HTMLCSAuditor = new function()
var buttonGroup = _doc.createElement('div');
buttonGroup.className = _prefix + 'button-group';

var prevButton = buildSummaryButton(_prefix + 'button-previous-issue', 'previous', _global.HTMLCS.getTranslation("auditor_previous_issue"), function(target) {
var prevButton = buildSummaryButton(_prefix + 'button-previous-issue', 'previous', HTMLCS.getTranslation("auditor_previous_issue"), function(target) {
var newIssue = Number(issue) - 1;

if (newIssue >= 1) {
Expand All @@ -391,7 +391,7 @@ _global.HTMLCSAuditor = new function()
}//end if
});

var nextButton = buildSummaryButton(_prefix + 'button-next-issue', 'next', _global.HTMLCS.getTranslation("auditor_next_issue"), function(target) {
var nextButton = buildSummaryButton(_prefix + 'button-next-issue', 'next', HTMLCS.getTranslation("auditor_next_issue"), function(target) {
var newIssue = Number(issue) + 1;

if (newIssue <= _messages.length) {
Expand Down Expand Up @@ -489,7 +489,7 @@ _global.HTMLCSAuditor = new function()
useStandardDiv.id = _prefix + 'settings-use-standard';

var useStandardLabel = _doc.createElement('label');
useStandardLabel.innerHTML = _global.HTMLCS.getTranslation("auditor_standards") + ':';
useStandardLabel.innerHTML = HTMLCS.getTranslation("auditor_standards") + ':';
useStandardLabel.setAttribute('for', _prefix + 'settings-use-standard-select');

var useStandardSelect = _doc.createElement('select');
Expand Down Expand Up @@ -519,11 +519,11 @@ _global.HTMLCSAuditor = new function()

var issueCountHelpDiv = _doc.createElement('div');
issueCountHelpDiv.id = _prefix + 'settings-issue-count-help';
issueCountHelpDiv.innerHTML = _global.HTMLCS.getTranslation("auditor_select_types");
issueCountHelpDiv.innerHTML = HTMLCS.getTranslation("auditor_select_types");

var viewReportDiv = _doc.createElement('div');
viewReportDiv.id = _prefix + 'settings-view-report';
viewReportDiv.innerHTML = _global.HTMLCS.getTranslation("auditor_view_report");
viewReportDiv.innerHTML = HTMLCS.getTranslation("auditor_view_report");

viewReportDiv.onclick = function() {
if (/disabled/.test(this.className) === false) {
Expand Down Expand Up @@ -576,23 +576,23 @@ _global.HTMLCSAuditor = new function()
levelCountDiv.className = 'HTMLCS-tile-text';

if(level == "error") {
levelName = _global.HTMLCS.getTranslation('auditor_error');
levelName = HTMLCS.getTranslation('auditor_error');
if (msgCount !== 1) {
levelName = _global.HTMLCS.getTranslation('auditor_errors');
levelName = HTMLCS.getTranslation('auditor_errors');
}
}

if(level == "warning") {
levelName = _global.HTMLCS.getTranslation('auditor_warning');
levelName = HTMLCS.getTranslation('auditor_warning');
if (msgCount !== 1) {
levelName = _global.HTMLCS.getTranslation('auditor_warnings');
levelName = HTMLCS.getTranslation('auditor_warnings');
}
}

if(level == "notice") {
levelName = _global.HTMLCS.getTranslation('auditor_notice');
levelName = HTMLCS.getTranslation('auditor_notice');
if (msgCount !== 1) {
levelName = _global.HTMLCS.getTranslation('auditor_notices');
levelName = HTMLCS.getTranslation('auditor_notices');
}
}
var content = '<strong>' + msgCount + '</strong> ' + levelName;
Expand Down Expand Up @@ -822,20 +822,20 @@ _global.HTMLCSAuditor = new function()

var msgElementSourceInner = _doc.createElement('div');
msgElementSourceInner.className = _prefix + 'issue-source-inner-u2p';
var msg = _global.HTMLCS.getTranslation('auditor_unable_to_point');
var msg = HTMLCS.getTranslation('auditor_unable_to_point');

if (message.element.nodeName === '#document') {
msg = _global.HTMLCS.getTranslation('auditor_applies_entire_document');
msg = HTMLCS.getTranslation('auditor_applies_entire_document');
} else if (message.element.ownerDocument === null) {
msg = _global.HTMLCS.getTranslation('auditor_unable_to_point_removed');
msg = HTMLCS.getTranslation('auditor_unable_to_point_removed');
} else {
var body = message.element.ownerDocument.getElementsByTagName('body')[0];
if (HTMLCS.util.isInDocument(message.element) === false) {
msg += _global.HTMLCS.getTranslation('auditor_unable_to_point_entire');
msg += HTMLCS.getTranslation('auditor_unable_to_point_entire');
} else if (HTMLCS.util.contains(body, message.element) === false) {
msg = _global.HTMLCS.getTranslation('auditor_unable_to_point_outside');
msg = HTMLCS.getTranslation('auditor_unable_to_point_outside');
} else {
msg += ' ' + _global.HTMLCS.getTranslation('auditor_unable_to_point_outside');
msg += ' ' + HTMLCS.getTranslation('auditor_unable_to_point_outside');
}
}

Expand Down Expand Up @@ -865,9 +865,9 @@ _global.HTMLCSAuditor = new function()
msgElementSourceHeader.className = _prefix + 'issue-source-header';

var msgSourceHeaderText = _doc.createElement('strong');
msgSourceHeaderText.innerHTML = _global.HTMLCS.getTranslation("auditor_code_snippet");
msgSourceHeaderText.innerHTML = HTMLCS.getTranslation("auditor_code_snippet");

var btnPointTo = buildSummaryButton(_prefix + 'button-point-to-element-' + id, 'pointer', _global.HTMLCS.getTranslation("auditor_point_to_element"), function() {
var btnPointTo = buildSummaryButton(_prefix + 'button-point-to-element-' + id, 'pointer', HTMLCS.getTranslation("auditor_point_to_element"), function() {
self.pointToElement(message.element);
});

Expand Down Expand Up @@ -960,7 +960,7 @@ _global.HTMLCSAuditor = new function()
var msgElementSourceInner = _doc.createElement('div');
msgElementSourceInner.className = _prefix + 'issue-source-not-supported';

var nsText = _global.HTMLCS.getTranslation('auditor_unsupported_browser');
var nsText = HTMLCS.getTranslation('auditor_unsupported_browser');

msgElementSourceInner.appendChild(_doc.createTextNode(nsText));
msgElementSource.appendChild(msgElementSourceInner);
Expand Down Expand Up @@ -989,7 +989,7 @@ _global.HTMLCSAuditor = new function()
var pageNum = _doc.createElement('span');
pageNum.className = _prefix + 'page-number';
// pageNum.innerHTML = 'Page ' + page + ' of ' + totalPages;
pageNum.innerHTML = _global.HTMLCS.getTranslation("auditor_page") + ' ' + page + ' ' + _global.HTMLCS.getTranslation("auditor_of") + ' ' + totalPages;
pageNum.innerHTML = HTMLCS.getTranslation("auditor_page") + ' ' + page + ' ' + HTMLCS.getTranslation("auditor_of") + ' ' + totalPages;
navDiv.appendChild(pageNum);

var next = _doc.createElement('span');
Expand All @@ -1015,7 +1015,7 @@ _global.HTMLCSAuditor = new function()
}

pageNum.innerHTML = '';
pageNum.appendChild(document.createTextNode(_global.HTMLCS.getTranslation("auditor_page") + ' ' + _page + ' ' + _global.HTMLCS.getTranslation("auditor_of") + ' ' + totalPages));
pageNum.appendChild(document.createTextNode(HTMLCS.getTranslation("auditor_page") + ' ' + _page + ' ' + HTMLCS.getTranslation("auditor_of") + ' ' + totalPages));

var issueList = _doc.querySelectorAll('.HTMLCS-issue-list')[0];
issueList.style.marginLeft = ((_page - 1) * -300) + 'px';
Expand All @@ -1034,7 +1034,7 @@ _global.HTMLCSAuditor = new function()
}

pageNum.innerHTML = '';
pageNum.appendChild(document.createTextNode(_global.HTMLCS.getTranslation("auditor_page") + ' ' + _page + ' ' + _global.HTMLCS.getTranslation("auditor_of") + ' ' + totalPages));
pageNum.appendChild(document.createTextNode(HTMLCS.getTranslation("auditor_page") + ' ' + _page + ' ' + HTMLCS.getTranslation("auditor_of") + ' ' + totalPages));

var issueList = _doc.querySelectorAll('.HTMLCS-issue-list')[0];
issueList.style.marginLeft = ((_page - 1) * -300) + 'px';
Expand Down Expand Up @@ -2189,3 +2189,5 @@ _global.HTMLCSAuditor = new function()
};

};

module.exports.HTMLCSAuditor = HTMLCSAuditor;
46 changes: 40 additions & 6 deletions Gruntfile.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ module.exports = function (grunt) {
eslint: {
target: ['Standards/**/*.js', 'Contrib/PhantomJS/*.js']
},
browserify:{
dist:{
src: ['index.js'],
dest: 'build/HTMLCS.js',
options:{
browserifyOptions: {
debug: true
},
require: [
],
}
}
},
uglify: {
debug: {
options: {
Expand All @@ -16,7 +29,7 @@ module.exports = function (grunt) {
footer: grunt.file.read('Contrib/Build/umd-footer.js')
},
files: {
'build/HTMLCS.js': ['Translations/*.js', 'Standards/**/*.js', 'HTMLCS.js', 'HTMLCS.Util.js', 'Contrib/PhantomJS/runner.js', 'Auditor/HTMLCSAuditor.js']
'build/HTMLCS.js': ['Translations/*.js', 'Standards/all.js', 'HTMLCS.js', 'HTMLCS.Util.js', 'Contrib/PhantomJS/runner.js', 'Auditor/HTMLCSAuditor.js']
}
},
dist: {
Expand All @@ -25,7 +38,7 @@ module.exports = function (grunt) {
footer: grunt.file.read('Contrib/Build/umd-footer.js')
},
files: {
'build/HTMLCS.js': ['Translations/*.js', 'Standards/**/*.js', 'HTMLCS.js', 'HTMLCS.Util.js', 'Contrib/PhantomJS/runner.js', 'Auditor/HTMLCSAuditor.js']
'build/HTMLCS.js': ['Translations/*.js', 'Standards/all.js', 'HTMLCS.js', 'HTMLCS.Util.js', 'Contrib/PhantomJS/runner.js', 'Auditor/HTMLCSAuditor.js']
}
},
bookmarklet: {
Expand All @@ -34,7 +47,7 @@ module.exports = function (grunt) {
footer: grunt.file.read('Contrib/Build/umd-footer.js')
},
files: {
'build/HTMLCS.js': ['Translations/*.js', 'Standards/**/*.js', 'HTMLCS.js', 'HTMLCS.Util.js', 'Contrib/PhantomJS/runner.js', 'Auditor/Auditor_with_beacon.js']
'build/HTMLCS.js': ['Translations/*.js', 'Standards/all.js', 'HTMLCS.js', 'HTMLCS.Util.js', 'Contrib/PhantomJS/runner.js', 'Auditor/Auditor_with_beacon.js']
}
}
},
Expand Down Expand Up @@ -71,9 +84,30 @@ module.exports = function (grunt) {
grunt.file.setBase('./');
require('load-grunt-tasks')(grunt);

grunt.loadNpmTasks('grunt-browserify');

grunt.registerTask('default', ['eslint']);
grunt.registerTask('build', ['uglify:dist', 'copy:dist']);
grunt.registerTask('build-bookmarklet', ['uglify:bookmarklet', 'copy:dist']);
grunt.registerTask('build', ['exportVars', 'uglify:dist', 'copy:dist']);
grunt.registerTask('build-bookmarklet', ['exportVars', 'uglify:bookmarklet', 'copy:dist']);

return grunt.registerTask('build-debug', ['uglify:debug', 'copy:dist']);
grunt.registerTask('exportVars', function() {
var catted = '';

grunt.file.expand({ filter: 'isFile' }, 'Standards/{Section508,WCAG2AAA}/**/**/**/*.js')
.forEach(function(file) {
catted += grunt.file.read(file) + '\n';
var parts = file.split("/"),
varName = "HTMLCS_" + parts.slice(1).join('_').replace(/[.]js$/, "");
if(varName.match(/_ruleset$/))
varName = varName.replace(/_ruleset$/, "");
catted += "module.exports." + varName + " = " + varName + ";\n";
}
);
catted += grunt.file.read('Standards/WCAG2AA/ruleset.js');
catted += grunt.file.read('Standards/WCAG2A/ruleset.js');
catted += grunt.file.read('Standards/Section508/ruleset.js');
grunt.file.write('Standards/all.js', catted, { encoding: 'utf8' })
});

return grunt.registerTask('build-debug', ['exportVars', 'browserify:dist', 'copy:dist']);
};
4 changes: 3 additions & 1 deletion HTMLCS.Util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
* +--------------------------------------------------------------------+
*
*/
_global.HTMLCS.util = function() {
HTMLCS = HTMLCS || {}

HTMLCS.util = function() {
var self = {};

/**
Expand Down
7 changes: 5 additions & 2 deletions HTMLCS.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@
*
*/

_global.HTMLCS = new function()
var HTMLCS = new function()
{
var translation = _global.translation;
var _standards = {};
var _sniffs = [];
var _tags = {};
Expand Down Expand Up @@ -59,7 +60,7 @@ _global.HTMLCS = new function()
}

// Set a language to use.
var languages = Object.keys(_global.translation);
var languages = Object.keys(translation);
if (language && languages.indexOf(language) !== -1) {
this.lang = language;
}
Expand Down Expand Up @@ -628,3 +629,5 @@ _global.HTMLCS = new function()
}
};
};

module.exports.HTMLCS = HTMLCS;
2 changes: 1 addition & 1 deletion Standards/Section508/Sniffs/A.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*
*/

_global.HTMLCS_Section508_Sniffs_A = {
var HTMLCS_Section508_Sniffs_A = {
/**
* Determines the elements to register for processing.
*
Expand Down
2 changes: 1 addition & 1 deletion Standards/Section508/Sniffs/B.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*
*/

_global.HTMLCS_Section508_Sniffs_B = {
var HTMLCS_Section508_Sniffs_B = {
/**
* Determines the elements to register for processing.
*
Expand Down
2 changes: 1 addition & 1 deletion Standards/Section508/Sniffs/C.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
*
*/

_global.HTMLCS_Section508_Sniffs_C = {
var HTMLCS_Section508_Sniffs_C = {
/**
* Determines the elements to register for processing.
*
Expand Down
Loading