evhaus / brackets-jscs

(Deprecated) Brackets extension for JSCS

brackets-jscs

A Brackets extension that enables JSCS validation for Javascript files. For more information about JSCS see https://github.com/jscs-dev/node-jscs.

JSCS can be configured by a .jscsrc or .jscs.json file located somewhere in your project.

THIS EXTENSION IS BEING DEPRECATED

This extension is going to be deprecated soon. JSCS is being merged into ESLint. As such, there is going to be no more need it. Use the wonderful brackets-eslint extension instead.

I will still happily accept Pull Requests if you wish to fix issues, but I will no longer be actively working on it.

Requirements

• Brackets 1.2.0 or greater
• node.js

Installation

• Install the extension from the Brackets Extension registry
• Go to Help > Show Extensions Folder
• In the extensions folder navigate to /user/globexdesigns.brackets-jscs
• Open a terminal to this folder and run npm install
• Restart Brackets

Configuration

If you have disabled the default Brackets JSLint service, you will need to manually enable JSCS in your prefs file:

• Go to Debug > Open Preferences File
• Make sure your language.javascript.linting.prefer definition includes "JSCS" as such:

"language": {
	"javascript": {
		"linting.prefer": [
			"JSHint",
			"JSCS"
		]
	}
},

Using with JSX

JSCS (and brackets-jscs) can be used to validate JSX files. To enable this, add this line to your .jscsrc file:

"esprima": "babel-jscs"

Note about Additional Rules

The extension supports the additionalRules for JSCS however, changes/additions/removals of additional rules will require your to close and restart Brackets before the extension will respect the changes.

Building This Extension

npm install
grunt build

A new ZIP package will be created in /build/.

Credit

Based heavily on brackets-jshint and brackets-eslint.

brackets-jscs's Issues

Gives no hints at all

I tried to create a simple .jscs.json file and added it to my projects root-dir:

{
    "preset": "jquery",
    "excludeFiles": ["node_modules/**"]
}

The jscs command line tool gives me errors. But Brackets gives me no hints at all.
Other Brackets hinting extensions works fine like jsonhint and jshint.
I am using Brackets 1.1.

Any idea of why it is not working?

Extension doesn't get loaded

Installed the Extension through Extension manager, but it always fails with an error. This is what I've found in the console: Uncaught ReferenceError: module is not defined

Support for the fix parameter

Hi,

Would be great if there was support for the fix parameter so that when saving a file it could be fixed based on the rules used to validate.
Similar to this one: https://atom.io/packages/jscs-fixer

Feature request: Add JSCS formatting

Would it be possible to extend this to add the jscs formatting? Per this page it seems like it's done with an option.

https://medium.com/@addyosmani/auto-formatting-javascript-code-style-fe0f98a923b8

Cannot find module 'jscs'

Ubuntu 15.04 x64
Brackets Release 1.3
JSCS 0.6.3

The removal of local jscs seems to have broke on ubuntu. (only tested on works machine)
I have globally(npm -g) installed the package but it refuses to find it...

I had to locally install(npm) jscs in extensions/user/globaldesigns.brackets-jscs to get it to work.

Error Message

Unexpected JSCS processing error: Unable to load one of the modules: /home/james/.config/Brackets/extensions/user/globexdesigns.brackets-jscs/domain, reason: Cannot find module 'jscs' ```

Trailing space in comment breaks brackets-jscs

If there is a trailing space in a comment an "Unexpected token"-error is created in brackets-jscs.
This is not a problem when running JSCS in commandline.

// This line has a trailing space 
function a() {
    return;
}

Unsupported rules: additionalRules

When my repo is open (https://github.com/zaggino/brackets-git) I get a lot of these errors:

JSCS failed to initialize: Error: Unsupported rules: additionalRules, forbiddenFunctions main.js:58
JSCS failed to initialize: Error: Unsupported rules: additionalRules, forbiddenFunctions main.js:58
JSCS failed to initialize: Error: Unsupported rules: additionalRules, forbiddenFunctions main.js:58
JSCS failed to initialize: Error: Unsupported rules: additionalRules, forbiddenFunctions main.js:58

Upgrade to newest JSCS version

There is bug (jscs-dev/node-jscs#1163) that is fixed the newer versions of JSCS. So it would be great if the embedded JSCS could be upgraded in brackets-jscs :-)

Plugin breaks when JSCS is used with plugin

I have a Brackets with JSCS plugin working fine for a while, but recently I wanted to add a plugin to my .jscsrc configuration (https://github.com/jscs-dev/jscs-jsdoc) but as soon as I did this I started getting errors in Brackets:

Unexpected JSCS processing error: Cannot find module 'jscs-jsdoc'

The configuration section I've added to .jscsrc is

    "plugins": [
        "jscs-jsdoc"
    ],
    "jsDoc": {
        "checkAnnotations": "jsdoc3",
        "checkParamNames": true,
        "requireParamTypes": true,
        "checkRedundantParams": true,
        "checkReturnTypes": true,
        "checkRedundantReturns": true,
        "requireReturnTypes": true,
        "checkTypes": "strictNativeCase",
        "checkRedundantAccess": true,
        "enforceExistence": "exceptExports",
        "requireNewlineAfterDescription": true,
        "requireDescriptionCompleteSentence": true,
        "requireParamDescription": true
    }

The jscs-jsdoc module is installed correctly as it works perfectly well when I run JSCS from command line.

Unexpectedly stop the node server

When I having this extension installed, I got several errors in developer console. Please check the following screen shot.

This would cause any extension to be working. Please check the other issue. Probably it is because of I'm running in offline mode (not connected to internet)?

I'm using Brackets 1.3 on Windows 7.

After upgrading to 0.6.0 I get a JSCS processing error

Unexpected JSCS processing error: Unable to load one of the modules: C:/Users/Peter/AppData/Roaming/Brackets/extensions/user/globexdesigns.brackets-jscs/domain, reason: Cannot find module 'jscs'

Large Project - Litner Config Not Found

Hi,

In a few of our large projects (30,000+ files), the litner config is not found and brackets reverts to the default linter settings.

How can I fix this?

Thanks!!

JSCS timing out

After upgrading to 0.7.0, JSCS for Brackets is reporting JSCS has timed out after waiting for 10000 ms every time it runs.

I'm using Brackets 1.3 on Windows 7.

Is there a way to invoke jscs auto fix as part of "save" of a file?

Is there a way to invoke jscs auto fix as part of "save" of a file?

Investigate support for async linting in Brackets

Looks like async linting is now possible. Investigate: adobe/brackets#6530

update to use JSCS 3

A few of the projects I work on have now started using JSCS 3, causing this extension to show "unsupported rule" messages for some of the new rules.

The dependency is already listed as latest, but it looks like the extension has not been updated in a while.

Configuration file path

I see this problem in many extensions... I think it would be more sensitive to include the possibility of defining the path for your own configuration file, instead of trying to guess it. At least specify where should we place it, please, because this "somewhere" you mention doesn't work for any place (the extension says "Unable to find a JSCS configuration file." – I just have a folder where all the code style definitions are stored, including a .jscsrc file).

In general, I think it should be a more direct mapping between the original command-line tool and the editor's extension. Otherwise, the advantages the extension gives are lost because of the lack of flexibility, as I see it.

Thanks.

Using multiple brackets windows broke the extension

Hi, first thanks for this extension.

I got a problem when I'm running more than one window of Brackets. The extension display an error message:

Unexpected JSCS processing error: Max connection attempts reached

Is there a solution to be able to use JSCS parser with multiple window ?

Tell me if you need more information to find out what is going on.

Support JSCS v2.2.1

Can be upgraded to support the newer version?

How to upgrade to JSCS 2.0.0 ?

Hello,

Our team is updating our .jscsrc config files to use JSCS 2.0.0. They are using vi as code editor.
I am using brackets and your plugin but I can't manage to upgrade the JSCS version.

I tried upgrading the jscs node module in the plugin directory and globally, unsuccessfully.

I still have an Unsupported rule error. Do you know how can I do?

Thanks.

error after latest update:

project: https://github.com/zaggino/z-schema
no mention of airbnb in it

Files in Subsubfolders are ignored

When I put the .jscs.json into the Project Root, files in the js folder will get linted as expected:

But files in the js_inner folder are ignored:

To get linting for that file, I have to copy .jscs.json into js (or js_inner):

However when I delete the .jscs.json from the project root, only files in the direct subfolders are affected:

---

In summary, I would like to have linting for all files in the project, so I don't have to copy the settings.

.jscsrc does not appear to have any effect

Using this .jscsrc file on Ubuntu works great. It seems to be ignored on Mac OS 10.10.2. .jscs.json also appears to be ignored on that operating system. Using brackets release 1.2 build 1.2.0-15697 (release 8f82e2a97) build timestamp: Sun Feb 22 2015 22:34:50 GMT-0800

.jscs is in the project root, at the same level as .jshintrc

{
    "requireCurlyBraces": [
        "if",
        "else",
        "for",
        "while",
        "do",
        "try",
        "catch"
    ],
    "requireOperatorBeforeLineBreak": true,
    "requireCamelCaseOrUpperCaseIdentifiers": true,
    "maximumLineLength": {
      "value": 80,
      "allowComments": true,
      "allowRegex": true
    },
    "validateIndentation": "\t",
    "validateQuoteMarks": "'",

    "disallowMultipleLineStrings": true,
    "disallowMixedSpacesAndTabs": true,
    "disallowTrailingWhitespace": true,
    "disallowSpaceAfterPrefixUnaryOperators": true,
    "disallowMultipleVarDecl": false,
    "disallowKeywordsOnNewLine": ["else"],

    "requireSpaceAfterKeywords": [
      "if",
      "else",
      "for",
      "while",
      "do",
      "switch",
      "return",
      "try",
      "catch"
    ],
    "requireSpaceBeforeBinaryOperators": [
        "=", "+=", "-=", "*=", "/=", "%=", "<<=", ">>=", ">>>=",
        "&=", "|=", "^=", "+=",

        "+", "-", "*", "/", "%", "<<", ">>", ">>>", "&",
        "|", "^", "&&", "||", "===", "==", ">=",
        "<=", "<", ">", "!=", "!=="
    ],
    "requireSpaceAfterBinaryOperators": true,
    "requireSpacesInConditionalExpression": true,
    "requireSpaceBeforeBlockStatements": true,
    "requireSpacesInForStatement": true,
    "requireLineFeedAtFileEnd": true,
    "requireSpacesInFunctionExpression": {
        "beforeOpeningCurlyBrace": true
    },
    "disallowSpacesInAnonymousFunctionExpression": {
        "beforeOpeningRoundBrace": true
    },
    "disallowSpacesInsideObjectBrackets": "all",
    "disallowSpacesInsideArrayBrackets": "all",
    "disallowSpacesInsideParentheses": true,

    "disallowMultipleLineBreaks": true,
    "disallowNewlineBeforeBlockStatements": true
}

Here is the brackets.json

{
    "themes.theme": "dark-theme",
    "me.drewh.jsbeautify.on_save": false,
    "linting.collapsed": false,
    "language": {
        "javascript": {
            "linting.prefer": [
                "JSHint",
                "JSCS"
            ],
            "linting.usePreferredOnly": true
        }
    },
    "useTabChar": true
}

Support for .jscsrc file name

It would be nice if the extension supported the file format .jscsrc. It seems a lot of extensions like CSS Lint (.csslintrc) and JSHint (.jshintrc) all tend to go for that kind of file name format.

Obviously this would be easy to change and I could raise a pull request, but perhaps its better to get thoughts on this first? Should it support BOTH .jscsrc and .jscs.json? Most of the other extensions only support the one format .*rc.

I'm getting: Unexpected JSCS processing error: Unable to load one of the modules * reason: Cannot find module 'color'

Not clear install instruction

After I do Debug > Open Preferences File it open me 2 file:
defaultPreferences.json and brackets.json
no one of them have structure like:
"language": {...}
defaultPreferences.json
have few raws:

// Additional mappings from file extension to language name
"language.fileExtensions": {},
// Additional mappings from file name to language name
"language.fileNames": {},

Could you show (print screen it) where is should be?

Ignored rule: One space required after opening bracket.

JSCS for Bracket ignore rule requireSpacesInsideBrackets which command line tool return correctly as an error. We use "preset": "jquery".
This should be evaluated as an error:

ab[c][d]

and should be auto-fixed to:

ab[ c ][ d ]

My JSCS file

{
    "preset": "jquery",
    "requireCamelCaseOrUpperCaseIdentifiers": "ignoreProperties",
    "requireCapitalizedComments": { "allExcept": [ "global", "jshint", "jscs" ] }
}

This extension save me a lot of time with code style fixing. Thank you.

Please update to node-jscs 1.5.6

node-jscs updated to 1.5.6. Please use the updated version. I need the new wikimedia preset :)

Support .jscsrc file outwith project tree

I would like to share the same .jscrc configuration between multiple projects. However, searching for a .jscrc stops at the project root.

Could support for a global default config file or scanning beyond the project root be supported? For example, the Brackets JSHint extension supports scanning the complete parent tree to find a configuration file.

Node-shebangs (#!...) gives errors...

...Which works fine in JSCS CLI.

Rule disallowTrailingWhitespace broken

The JSCS rule:

{"disallowTrailingWhitespace": true}

does not work.

It is cause by the following code most probably:

// Trim trailing whitespace
JSXCode = JSXCode.replace(/( +)\n/g, '\n');

please update registry version to latest jscs

i'm getting JSCS failed to initialize: AssertionError: safeContextKeyword option requires string value but that seems not to be true for latest version:
https://github.com/mdevils/node-jscs#safecontextkeyword

Syntax error cause Brackets CodeInspector to fail

If the Javascript file has a syntax error, JSCS will fail silently and prevent any further execution of CodeInspector code - resulting in errors to slip by.

Make sure to catch syntax errors and report them back to the console.

Brackets console outputs:

[CodeInspection] Provider JSCS threw an error: Error: Syntax error at input: Line 302: Unexpected token ; 

Doesn't do anything

I've installed the extension, placed the example .jscs.json file in my project root, and then saved a random javascript file. It does absolutely nothing. And I know for a fact the javascript isn't indented and curly-braced the same way across the file. So it should do at least something. In fact, there's a piece of minified code at the top of my javascript - I expected that to be un-minified to a certain extent.

Nothing. Just nothing.
Am I missing something?...

Using Brackets 36 on Windows 7.

Update JSCS to latest version

I'm using the Google JSCS preset here: https://github.com/mdevils/node-jscs/blob/master/presets/google.json

Getting lots of errors about unsupported rules, e.g.:

JSCS failed to initialize: Error: Unsupported rules: requireSpacesInConditionalExpression ErrorNotification.js:117

I guess they were added after the version in brackets-jscs, and I couldn't figure out why JSCS wasn't working until opening the developer tools.

BUG : "disallowSpacesInsideParentheses" works like "requireSpacesInsideParentheses"

The error "missing space before closing round bracket" appears when I write in my conf file either "disallowSpacesInsideParentheses": true OR "requireSpacesInsideParentheses": "all"

But in the JSCS Rules, disallowSpacesInsideParentheses is the contrary of requireSpacesInsideParentheses !

Here my jscs.json :
{
"preset": "jquery",
"maximumLineLength": null,
"requireMultipleVarDecl": null,
"requireSpacesInsideArrayBrackets": null,
"disallowSpacesInsideArrayBrackets": "all",
"validateQuoteMarks": { "mark": "'", "escape": true },
"disallowSpacesInsideParentheses": true,
"disallowMixedSpacesAndTabs": true,
"requireMultipleVarDecl": true,
"requireBlocksOnNewline": 1
}

The JSCS 2.0 does not use esprima anymore

The new JSCS 2.0 does not use esprima anymore. Because of this, I ca not use the same .jscsrc for grunt jscs and brackets-jscs.

See: https://www.bountysource.com/issues/25066285-unknown-node-type-export-declaration?utm_campaign=plugin&utm_content=tracker%2F281640&utm_medium=issues&utm_source=github

JSCS issue "Unexpected JSCS processing error: timeout"

I had been using this plugin for about 6 months without issue. After upgrading to Brackets v1.5, build 1.5.0-16538, I noticed that the JSCS information in the output stated the following:

JSCS has not been installed in the extension. See Installation steps here: https://github.com/globexdesigns/brackets-jscs

So then I went through the installation and configuration information in the readme.md file, noticing that there were extra steps to perform that weren't there previously. So I reinstalled the plugin via Extension Manager registry to ensure I had the latest version. Ran the npm install command as specified in the readme document and checked that my preferences file matches that in the readme.md 'Configuration' Section. Then finally, restarted Brackets.

Now I get the following error and don't know how to proceed with resolving this.

Unexpected JSCS processing error: timeout

Update to the latest node-jscs (Mainly for ES6)

Currently, brackets jscs stops when it encounters ES6 features like generator functions, which have a star in their syntax. This issue was just solved in node-jscs. Updating node-jscs will allow usage of brackets-jscs with ES6.