Merged in isqua/chrome_point_plus/code-style (pull request #14)

Code style checking
2024-11-23 10:46:02 +00:00 · 2015-02-04 13:56:19 +03:00 · 2015-02-04 13:56:19 +03:00 · 74c0e0319f
parent 81ad370af1 0a2b4c7538
commit 74c0e0319f
9 changed files with 236 additions and 43 deletions
--- a/.gitignore
+++ b/.gitignore
@ -1,5 +1,6 @@
 chrome_point_plus/vendor/
 /nbproject/private/
 node_modules/
+npm-debug.log
 publish
 vendor/
--- a/.jscs.json
+++ b/.jscs.json
@ -0,0 +1,119 @@
+{
+    "disallowImplicitTypeConversion": [ "numeric", "boolean", "binary" ],
+    "disallowKeywordsOnNewLine": [ "else" ],
+    "disallowMixedSpacesAndTabs": true,
+    "disallowMultipleLineBreaks": true,
+    "disallowMultipleLineStrings": true,
+    "disallowNewlineBeforeBlockStatements": true,
+    "disallowOperatorBeforeLineBreak": [ "+", "-", "*", "/", "." ],
+    "disallowPaddingNewlinesInBlocks": true,
+    "disallowQuotedKeysInObjects": "allButReserved",
+    "disallowSpaceAfterObjectKeys": true,
+    "disallowSpaceAfterPrefixUnaryOperators": [ "++", "--", "+", "-" ],
+    "disallowSpaceBeforePostfixUnaryOperators": true,
+    "disallowSpacesInCallExpression": true,
+    "disallowSpacesInFunctionExpression": {
+        "beforeOpeningRoundBrace": true
+    },
+    "disallowSpacesInNamedFunctionExpression": {
+        "beforeOpeningRoundBrace": true
+    },
+    "disallowSpacesInsideParentheses": true,
+    "disallowTrailingComma": true,
+    "disallowTrailingWhitespace": true,
+    "disallowYodaConditions": true,
+    "requireBlocksOnNewline": true,
+    "requireCapitalizedConstructors": true,
+    "requireCommaBeforeLineBreak": true,
+    "requireCurlyBraces": [
+        "if",
+        "else",
+        "for",
+        "while",
+        "do",
+        "try",
+        "catch"
+    ],
+    "requireDotNotation": true,
+    "requireLineBreakAfterVariableAssignment": true,
+    "requireLineFeedAtFileEnd": true,
+    "requirePaddingNewlinesBeforeKeywords": [
+        "do",
+        "for",
+        "if",
+        "switch",
+        "try",
+        "void",
+        "while",
+        "with",
+        "return"
+    ],
+    "requireSpaceAfterBinaryOperators": true,
+    "requireSpaceAfterKeywords": [
+        "do",
+        "for",
+        "if",
+        "else",
+        "switch",
+        "case",
+        "try",
+        "catch",
+        "void",
+        "while",
+        "with",
+        "return",
+        "typeof"
+    ],
+    "requireSpaceAfterLineComment": {
+        "allExcept": [ "#", "=" ]
+    },
+    "requireSpaceAfterPrefixUnaryOperators": [ "~", "!" ],
+    "requireSpaceBeforeBinaryOperators": [
+        "=",
+        "+",
+        "-",
+        "/",
+        "*",
+        "==",
+        "===",
+        "!=",
+        "!=="
+    ],
+    "requireSpaceBeforeBlockStatements": true,
+    "requireSpaceBeforeKeywords": [
+        "else",
+        "while",
+        "catch"
+    ],
+    "requireSpaceBeforeObjectValues": true,
+    "requireSpaceBetweenArguments": true,
+    "requireSpacesInAnonymousFunctionExpression": {
+        "beforeOpeningCurlyBrace": true
+    },
+    "requireSpacesInForStatement": true,
+    "requireSpacesInFunctionDeclaration": {
+        "beforeOpeningCurlyBrace": true
+    },
+    "requireSpacesInFunctionExpression": {
+        "beforeOpeningCurlyBrace": true
+    },
+    "requireSpacesInNamedFunctionExpression": {
+        "beforeOpeningCurlyBrace": true
+    },
+    "requireSpacesInsideObjectBrackets": "allButNested",
+    "validateIndentation": 4,
+    "validateLineBreaks": "LF",
+    "validateParameterSeparator": ", ",
+
+
+    "excludeFiles": [
+        "chrome_point_plus/js/bquery_ajax.js",
+        "chrome_point_plus/js/markitup/sets/markdown/set.js",
+        "chrome_point_plus/js/point-plus.js",
+        "chrome_point_plus/vendor/**",
+        "nbproject/**",
+        "node_modules/**",
+        "publish/**",
+        "vendor/**"
+    ]
+}
--- a/.jshintignore
+++ b/.jshintignore
@ -0,0 +1,9 @@
+.git/**
+chrome_point_plus/js/bquery_ajax.js
+chrome_point_plus/js/markitup/sets/markdown/set.js
+chrome_point_plus/js/point-plus.js
+chrome_point_plus/vendor/**
+nbproject/**
+node_modules/**
+publish/**
+vendor/**
--- a/.jshintrc
+++ b/.jshintrc
@ -0,0 +1,26 @@
+{
+    "bitwise": true,
+    "camelcase": false,
+    "curly": true,
+    "eqeqeq": true,
+    "es3": false,
+    "forin": true,
+    "freeze": true,
+    "latedef": true,
+    "maxlen": 120,
+    "maxparams": 4,
+    "newcap": true,
+    "noarg": true,
+    "noempty": true,
+    "nonbsp": true,
+    "quotmark": "single",
+    "shadow": "inner",
+    "undef": true,
+    "unused": true,
+    "browser": true,
+    "jquery": true,
+    "globals": {
+        "chrome": true,
+        "console": true
+    }
+}
--- a/Gruntfile.js
+++ b/Gruntfile.js
@ -22,8 +22,8 @@ vendorCopy.push({
    dest: 'chrome_point_plus/'
 });

+/* global module */
 module.exports = function(grunt) {
-
    // Настройки
    grunt.initConfig({
        pkg: grunt.file.readJSON('package.json'),
@ -46,7 +46,7 @@ module.exports = function(grunt) {
                gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d',
                globalReplace: true
            }
-        },
+        }
    });

    // Загрузить плагины
--- a/README.md
+++ b/README.md
@ -1,30 +1,57 @@
-# README #
-
-Коротенькое пояснение what the fuck is going on.
-
-### Что это за репозиторий? ###
-
-В данном репозитории располагаются исходные коды расширения Point+, которое предназначено для расширения функциональности сайта [Point.im](https://point.im/).
-
-### Как заставить его работать? ###
-
-Есть несколько вариантов. Выбирайте на свой вкус:
-
-* Установить расширение из [репозитория Opera addons](https://addons.opera.com/en/extensions/details/point/?display=en)
-* Установить расширение из [репозитория Google Chrome Extensions](https://chrome.google.com/webstore/detail/point%2B/ghaddonhnchkdjaciggjijhophciboam?hl=ru)
-* Установить расширение из [раздела Downloads на Bitbucket](https://bitbucket.org/skobkin/chrome_point_plus/downloads) (*.nex - Opera, *.crx - Chrome)
-* Собрать самостоятельно из исходников ([Chrome](https://developer.chrome.com/extensions/packaging), [Opera](https://dev.opera.com/extensions/tut_basics.html))
-
-
-### Как настраивать? ###
-
-В адресной строке (омнибокс) появится иконка Point.im. Если на нёё нажать - появится окошко настроек.
-
-![Настройки расширения](https://storage4.static.itmages.ru/i/15/0107/h_1420652338_6632200_307d80b672.png "Окно настроек расширения")
-
-### Хочу помочь, ШТОДЕЛОЦ? ###
-
-* Писать мне [в поинте](https://skobkin-ru.point.im/) или [куда-нибудь ещё](https://skobk.in/contacts/)
-* Сразу присылать пулл-реквесты с шашкой наголо
-* Поставить в магазинах Opera и Chrome оценку расширению
-* Задонатить (см. таб Feedback в настройках)
+# README #
+
+Коротенькое пояснение what the fuck is going on.
+
+### Что это за репозиторий? ###
+
+В данном репозитории располагаются исходные коды расширения Point+, которое предназначено для расширения функциональности сайта [Point.im](https://point.im/).
+
+### Как заставить его работать? ###
+
+Есть несколько вариантов. Выбирайте на свой вкус:
+
+* Установить расширение из [репозитория Opera addons](https://addons.opera.com/en/extensions/details/point/?display=en)
+* Установить расширение из [репозитория Google Chrome Extensions](https://chrome.google.com/webstore/detail/point%2B/ghaddonhnchkdjaciggjijhophciboam?hl=ru)
+* Установить расширение из [раздела Downloads на Bitbucket](https://bitbucket.org/skobkin/chrome_point_plus/downloads) (*.nex - Opera, *.crx - Chrome)
+* Собрать самостоятельно из исходников ([Chrome](https://developer.chrome.com/extensions/packaging), [Opera](https://dev.opera.com/extensions/tut_basics.html))
+
+
+### Как настраивать? ###
+
+В адресной строке (омнибокс) появится иконка Point.im. Если на нёё нажать - появится окошко настроек.
+
+![Настройки расширения](https://storage4.static.itmages.ru/i/15/0107/h_1420652338_6632200_307d80b672.png "Окно настроек расширения")
+
+### Хочу помочь, ШТОДЕЛОЦ? ###
+
+* Писать мне [в поинте](https://skobkin-ru.point.im/) или [куда-нибудь ещё](https://skobk.in/contacts/)
+* Сразу присылать пулл-реквесты с шашкой наголо
+* Поставить в магазинах Opera и Chrome оценку расширению
+* Задонатить (см. таб Feedback в настройках)
+
+### Как собрать из исходников
+
+Для сборки используется Node.js. Ещё нужно глобально установить npm-пакет grunt-cli (`npm i -g grunt-cli`).
+
+Все команды ниже нужно выполнять в корне проекта.
+
+Установить npm и bower зависимости и разложить библиотеки по местам:
+
+```
+npm install
+```
+
+Если у вас нет Node.js, то вы можете посмотреть используемые библиотеки в файле `bower.json` и положить их
+в `chrome_point_plus/vendor`.
+
+Проверить кодстайл:
+
+```
+npm run lint
+```
+
+Поднять версию ([примеры](https://github.com/vojtajina/grunt-bump/blob/master/README.md#usage-examples)):
+
+```
+grunt bump
+```
--- a/chrome_point_plus/js/background.js
+++ b/chrome_point_plus/js/background.js
@ -42,6 +42,7 @@ function injectFiles(files, injectOne, onAllInjected, results) {
 * @constructor Менеджер сообщений
 */
 function MessageListener() {
+    /* jshint unused:false */
    chrome.runtime.onMessage.addListener(function(message, sender, sendResponse) {
        if (this.isMethodAvailable(message)) {
            console.info('Call #%s() method for tab #%s', message.type, this.getTabId(sender));
@ -54,6 +55,7 @@ function MessageListener() {
            return false;
        }
    }.bind(this));
+    /* jshint unused:true */
 }

 /**
@ -121,7 +123,7 @@ MessageListener.prototype.getManifestVersion = function(message, sender, sendRes
 MessageListener.prototype.getFiles = function(message, defaultRunAt) {
    var files;

-    if ( ! message.files) {
+    if (! message.files) {
        return false;
    } else {
        files = Array.isArray(message.files) ? message.files : [ message.files ];
@ -147,7 +149,7 @@ MessageListener.prototype.executeJSFiles = function(message, sender, sendRespons
    injectFiles(
        this.getFiles(message, 'document_end'),
        function(file, callback) {
-            chrome.tabs.executeScript(tabId, file, callback)
+            chrome.tabs.executeScript(tabId, file, callback);
        },
        sendResponse
    );
@ -169,7 +171,6 @@ MessageListener.prototype.injectCSSFiles = function(message, sender, sendRespons
        },
        sendResponse
    );
-
 };

 new MessageListener();
@ -185,6 +186,8 @@ chrome.storage.sync.get('options_version', function(data) {

 // Adding notification click event listener
 chrome.notifications.onClicked.addListener(function(notificationId) {
+    var tab_url;
+
    // Detecting notification type
    if (notificationId.indexOf('comment_') === 0) {
        tab_url = 'https://point.im/' + notificationId.replace(/comment_/g, '');
--- a/chrome_point_plus/js/options.js
+++ b/chrome_point_plus/js/options.js
@ -8,15 +8,15 @@ function OptionsPage() {
    this.form = document.querySelector('form');

    this.listenTabs();
-    
+
    chrome.runtime.sendMessage(null, {
        type: 'getManifestVersion'
    }, null, function(response) {
        this.version = response.version || 'undefined';
-        
+
        this.showVersion();
        this.restore();
-        
+
        this.form.addEventListener('change', this._onChange.bind(this));
    }.bind(this));
 }
@ -40,7 +40,8 @@ OptionsPage.prototype.updateOptionsFromFrom = function() {
            }, function() {
                console.log('Default options initialized. Version upgraded to %s.', this.version);

-                if ( ! confirm(chrome.i18n.getMessage('options_text_new_version'))) {
+                /* global confirm */
+                if (! confirm(chrome.i18n.getMessage('options_text_new_version'))) {
                    window.close();
                }
            });
@ -127,7 +128,7 @@ OptionsPage.prototype.updateOptionFromInput = function(input) {
        this._options[key] = {
            type: 'plain',
            value: input.value
-        }
+        };
    }
 };

@ -188,11 +189,14 @@ OptionsPage.prototype.checkOldStyle = function() {
            console.log('Found old-style options. Cleaning...');

            chrome.storage.sync.get(null, function(data) {
+                var option;

                console.log('Old data: %O', data);

                for (option in data) {
-                    chrome.storage.sync.remove(option);
+                    if (data.hasOwnProperty(option)) {
+                        chrome.storage.sync.remove(option);
+                    }
                }

                console.log('All old data removed');
--- a/package.json
+++ b/package.json
@ -4,7 +4,9 @@
  "description": "Chrome extension for point.im",
  "main": "index.js",
  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "postinstall": "./node_modules/.bin/bower install && grunt",
+    "lint": "./node_modules/.bin/jshint . && ./node_modules/.bin/jscs .",
+    "test": "npm run lint"
  },
  "repository": {
    "type": "git",
@ -16,6 +18,8 @@
    "bower": "^1.3.12",
    "grunt": "^0.4.5",
    "grunt-bump": "git://github.com/nkirkes/grunt-bump.git#nkirkes/restrict-version-key-name",
-    "grunt-contrib-copy": "^0.7.0"
+    "grunt-contrib-copy": "^0.7.0",
+    "jscs": "^1.10.0",
+    "jshint": "^2.6.0"
  }
 }