From 6c3501bf9ab178cfc893d11487f0fb44ff93efc9 Mon Sep 17 00:00:00 2001 From: Rob Garrison Date: Sun, 27 Aug 2017 12:36:36 -0500 Subject: [PATCH] Use rules or config consistently --- _locales/en/messages.json | 38 ++++---- edit.html | 2 +- edit/csslint-config.js | 2 +- edit/lint.js | 88 +++++++++---------- .../codemirror/addon/lint/css-lint.js | 14 +-- 5 files changed, 72 insertions(+), 72 deletions(-) diff --git a/_locales/en/messages.json b/_locales/en/messages.json index 92ecafc0..7e89af27 100644 --- a/_locales/en/messages.json +++ b/_locales/en/messages.json @@ -349,24 +349,33 @@ "message": "Install update", "description": "Label for the button to install an update for a single style" }, - "linterConfigTitle": { - "message": "Open a popup to configure the linter rules", - "description": "Tooltip on an icon to indicate it opens a popup with linter configuration settings" + "linterConfigPopupTitle": { + "message": "Set $linter$ rules configuration", + "description": "Stylelint or CSSLint popup header", + "placeholders": { + "linter": { + "content": "$1" + } + } + }, + "linterConfigTooltip": { + "message": "Click to configure this linter", + "description": "Icon tooltip to indicate that it opens a popup with the selected linter configuration" }, "linterCSSLintSettings": { - "message": "(Set rules: 0 = disabled; 1 = warning; 2 = error)", + "message": "(Set rule as: 0 = disabled; 1 = warning; 2 = error)", "description": "CSSLint rule config values" }, - "linterInvalidRuleError": { - "message": "Not saved due to these invalid rules:", - "description": "Invalid linter rules will show a message followed by a list of invalid rules" + "linterInvalidConfigError": { + "message": "Not saved due to these invalid configuration settings:", + "description": "Invalid linter config will show a message followed by a list of invalid entries" }, "linterIssues": { "message": "Issues", "description": "Label for the CSS linter issues block on the style edit page" }, "linterIssuesHelp": { - "message": "The issues found by $link$ rules:", + "message": "These issues were found by $link$:", "description": "Help popup message for the selected CSS linter issues block on the style edit page", "placeholders": { "link": { @@ -376,7 +385,7 @@ }, "linterJSONError": { "message": "Invalid JSON format", - "description": "Setting linter rules with invalid JSON message" + "description": "Setting linter config with invalid JSON" }, "linterResetMessage": { "message": "To undo accidental reset, press Ctrl-Z (or Cmd-Z) in the text box", @@ -384,16 +393,7 @@ }, "linterRulesLink": { "message": "See a full list of rules", - "description": "Stylelint or CSSLint rules label added before a link" - }, - "linterRulesTitle": { - "message": "Set rules for $linter$", - "description": "Stylelint or CSSLint popup header", - "placeholders": { - "linter": { - "content": "$1" - } - } + "description": "Stylelint or CSSLint rules label added immediately before a link" }, "manageFilters": { "message": "Filters", diff --git a/edit.html b/edit.html index 7e3164fb..234725eb 100644 --- a/edit.html +++ b/edit.html @@ -189,7 +189,7 @@ - +   diff --git a/edit/csslint-config.js b/edit/csslint-config.js index a6168828..c48e6e8e 100644 --- a/edit/csslint-config.js +++ b/edit/csslint-config.js @@ -4,7 +4,7 @@ * CSSLint Config values * 0 = disabled; 1 = warning; 2 = error */ -window.csslintDefaultRuleConfig = { +window.csslintDefaultConfig = { // Default warnings 'display-property-grouping': 1, 'duplicate-properties': 1, diff --git a/edit/lint.js b/edit/lint.js index 94f740a6..d3aaf8db 100644 --- a/edit/lint.js +++ b/edit/lint.js @@ -1,6 +1,6 @@ /* global CodeMirror messageBox */ /* global editors makeSectionVisible showCodeMirrorPopup showHelp */ -/* global stylelintDefaultConfig csslintDefaultRuleConfig onDOMscripted injectCSS require */ +/* global stylelintDefaultConfig csslintDefaultConfig onDOMscripted injectCSS require */ 'use strict'; function initLint() { @@ -13,25 +13,25 @@ function initLint() { if ('ontouchstart' in document.body) { $('#lint h2').addEventListener('click', toggleLintReport); } - // initialize storage of rules - BG.chromeSync.getValue('editorStylelintRules').then(rules => setStylelintRules(rules)); - BG.chromeSync.getValue('editorCSSLintRules').then(config => setCSSLintRules(config)); + // initialize storage of linter config + BG.chromeSync.getValue('editorStylelintConfig').then(config => setStylelintConfig(config)); + BG.chromeSync.getValue('editorCSSLintConfig').then(config => setCSSLintConfig(config)); } -function setStylelintRules(rules) { - // can't use default parameters, because rules may be null - if (Object.keys(rules || []).length === 0 && typeof stylelintDefaultConfig !== 'undefined') { - rules = deepCopy(stylelintDefaultConfig.rules); +function setStylelintConfig(config) { + // can't use default parameters, because config may be null + if (Object.keys(config || []).length === 0 && typeof stylelintDefaultConfig !== 'undefined') { + config = deepCopy(stylelintDefaultConfig.rules); } - BG.chromeSync.setValue('editorStylelintRules', rules); - return rules; + BG.chromeSync.setValue('editorStylelintConfig', config); + return config; } -function setCSSLintRules(config) { - if (Object.keys(config || []).length === 0 && typeof csslintDefaultRuleConfig !== 'undefined') { - config = Object.assign({}, csslintDefaultRuleConfig); +function setCSSLintConfig(config) { + if (Object.keys(config || []).length === 0 && typeof csslintDefaultConfig !== 'undefined') { + config = Object.assign({}, csslintDefaultConfig); } - BG.chromeSync.setValue('editorCSSLintRules', config); + BG.chromeSync.setValue('editorCSSLintConfig', config); return config; } @@ -226,7 +226,7 @@ function showLintHelp() { header = t('linterIssuesHelp', makeLink(url, 'stylelint')); template = rule => `
  • ${makeLink(url + rule, rule)}
    • `; } - // to-do: change this to a generator + // Only show rules with issues in the popup $$('#lint td[role="severity"]').forEach(el => { const rule = el.dataset.rule; if (!rules.includes(rule)) { @@ -266,21 +266,21 @@ function checkLinter(linter = prefs.get('editor.linter')) { return linter; } -function checkRules(linter, rules) { +function checkConfigRules(linter, config) { const invalid = []; const linterRules = linter === 'stylelint' ? Object.keys(window.stylelint.rules) : window.CSSLint.getRules().map(rule => rule.id); - Object.keys(rules).forEach(rule => { - if (!linterRules.includes(rule)) { - invalid.push(rule); + Object.keys(config).forEach(setting => { + if (!linterRules.includes(setting)) { + invalid.push(setting); } }); return invalid; } -function stringifyRules(rules) { - return JSON.stringify(rules, null, 2) +function stringifyConfig(config) { + return JSON.stringify(config, null, 2) .replace(/,\n\s+\{\n\s+("severity":\s"\w+")\n\s+\}/g, ', {$1}'); } @@ -290,17 +290,17 @@ function setupLinterSettingsEvents(popup) { const linter = checkLinter(event.target.dataset.linter); const json = tryJSONparse(popup.codebox.getValue()); if (json) { - const invalid = checkRules(linter, json); + const invalid = checkConfigRules(linter, json); if (invalid.length) { return showLinterErrorMessage( linter, - t('linterInvalidRuleError') + `
    • ${invalid.join('
    • ')}
    ` + t('linterInvalidConfigError') + `
    • ${invalid.join('
    • ')}
    ` ); } if (linter === 'stylelint') { - setStylelintRules(json); + setStylelintConfig(json); } else { - setCSSLintRules(json); + setCSSLintConfig(json); } updateLinter(linter); showSavedMessage(); @@ -312,15 +312,15 @@ function setupLinterSettingsEvents(popup) { $('.reset', popup).addEventListener('click', event => { event.preventDefault(); const linter = checkLinter(event.target.dataset.linter); - let rules; + let config; if (linter === 'stylelint') { - setStylelintRules(); - rules = stylelintDefaultConfig.rules; + setStylelintConfig(); + config = stylelintDefaultConfig.rules; } else { - setCSSLintRules(); - rules = csslintDefaultRuleConfig; + setCSSLintConfig(); + config = csslintDefaultConfig; } - popup.codebox.setValue(stringifyRules(rules)); + popup.codebox.setValue(stringifyConfig(config)); popup.codebox.focus(); }); $('.cancel', popup).addEventListener('click', event => { @@ -333,20 +333,20 @@ function openStylelintSettings() { const linter = prefs.get('editor.linter'); BG.chromeSync.getValue( linter === 'stylelint' - ? 'editorStylelintRules' - : 'editorCSSLintRules' - ).then(rules => { - if (!rules || rules.length === 0) { - rules = linter === 'stylelint' - ? setStylelintRules(rules) - : setCSSLintRules(rules); + ? 'editorStylelintConfig' + : 'editorCSSLintConfig' + ).then(config => { + if (!config || config.length === 0) { + config = linter === 'stylelint' + ? setStylelintConfig(config) + : setCSSLintConfig(config); } - const rulesString = stringifyRules(rules); - setupLinterPopup(rulesString); + const configString = stringifyConfig(config); + setupLinterPopup(configString); }); } -function setupLinterPopup(rules) { +function setupLinterPopup(config) { const linter = prefs.get('editor.linter'); const linterTitle = linter === 'stylelint' ? 'Stylelint' : 'CSSLint'; function makeButton(className, text, options = {}) { @@ -365,7 +365,7 @@ function setupLinterPopup(rules) { cm.setOption('mode', 'application/json'); cm.setOption('lint', 'json'); } - const popup = showCodeMirrorPopup(t('linterRulesTitle', linterTitle), $element({ + const popup = showCodeMirrorPopup(t('linterConfigPopupTitle', linterTitle), $element({ appendChild: [ $element({ tag: 'p', @@ -373,7 +373,7 @@ function setupLinterPopup(rules) { t('linterRulesLink') + ' ', makeLink( linter === 'stylelint' - ? 'https://stylelint.io/demo/' + ? 'https://stylelint.io/user-guide/rules/' : 'https://github.com/CSSLint/csslint/wiki/Rules-by-ID', linterTitle ), @@ -398,7 +398,7 @@ function setupLinterPopup(rules) { ]; contents.insertBefore(popup.codebox.display.wrapper, contents.firstElementChild); popup.codebox.focus(); - popup.codebox.setValue(rules); + popup.codebox.setValue(config); popup.codebox.clearHistory(); onDOMscripted(loadJSON).then(() => setJSONMode(popup.codebox)); setupLinterSettingsEvents(popup); diff --git a/vendor-overwrites/codemirror/addon/lint/css-lint.js b/vendor-overwrites/codemirror/addon/lint/css-lint.js index 245e7239..b452ae0b 100644 --- a/vendor-overwrites/codemirror/addon/lint/css-lint.js +++ b/vendor-overwrites/codemirror/addon/lint/css-lint.js @@ -4,7 +4,7 @@ // Depends on csslint.js from https://github.com/stubbornella/csslint /* global CodeMirror require define */ -/* global CSSLint stylelint stylelintDefaultConfig csslintDefaultRuleConfig */ +/* global CSSLint stylelint stylelintDefaultConfig csslintDefaultConfig */ 'use strict'; (mod => { @@ -25,10 +25,10 @@ return found; } /* STYLUS: hack start (part 1) */ - return BG.chromeSync.getValue('editorCSSLintRules').then((config = csslintDefaultRuleConfig) => { - // csslintDefaultRuleConfig stored in csslint-config.js & loaded by edit/lint.js - if (Object.keys(config).length === 0) { - config = Object.assign({}, csslintDefaultRuleConfig); + return BG.chromeSync.getValue('editorCSSLintConfig').then(config => { + // csslintDefaultConfig stored in csslint-config.js & loaded by edit/lint.js + if (Object.keys(config || []).length === 0) { + config = Object.assign({}, csslintDefaultConfig); } const results = CSSLint.verify(text, config); const messages = results.messages; @@ -73,9 +73,9 @@ const found = []; window.stylelint = require('stylelint'); if (window.stylelint) { - return BG.chromeSync.getValue('editorStylelintRules').then((rules = stylelintDefaultConfig.rules) => { + return BG.chromeSync.getValue('editorStylelintConfig').then(rules => { // stylelintDefaultConfig stored in stylelint-config.js & loaded by edit/lint.js - if (Object.keys(rules).length === 0) { + if (Object.keys(rules || []).length === 0) { rules = stylelintDefaultConfig.rules; } return stylelint.lint({