Skip to content

Commit

Permalink
Treat JSON with comments as a separate language (#4171)
Browse files Browse the repository at this point in the history
Fixes #4153.
  • Loading branch information
Alhadis authored Jul 6, 2018
1 parent 8540865 commit 1996fd8
Show file tree
Hide file tree
Showing 21 changed files with 227 additions and 115 deletions.
56 changes: 30 additions & 26 deletions lib/linguist/languages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2087,20 +2087,46 @@ JSON:
filenames:
- ".arcconfig"
- ".htmlhintrc"
- ".jscsrc"
- ".jshintrc"
- ".tern-config"
- ".tern-project"
- composer.lock
- mcmod.info
language_id: 174
JSON5:
JSON with Comments:
type: data
group: JSON
tm_scope: source.js
ace_mode: javascript
codemirror_mode: javascript
codemirror_mime_type: text/javascript
aliases:
- jsonc
extensions:
- ".json5"
- ".sublime-build"
- ".sublime-commands"
- ".sublime-completions"
- ".sublime-keymap"
- ".sublime-macro"
- ".sublime-menu"
- ".sublime-mousemap"
- ".sublime-project"
- ".sublime-settings"
- ".sublime-theme"
- ".sublime-workspace"
- ".sublime_metrics"
- ".sublime_session"
filenames:
- ".babelrc"
- ".eslintrc.json"
- ".jscsrc"
- ".jshintrc"
- ".jslintrc"
- tsconfig.json
language_id: 423
JSON5:
type: data
extensions:
- ".json5"
tm_scope: source.js
ace_mode: javascript
codemirror_mode: javascript
Expand Down Expand Up @@ -4531,28 +4557,6 @@ SubRip Text:
ace_mode: text
tm_scope: text.srt
language_id: 360
Sublime Text Config:
type: data
group: JSON
tm_scope: source.js
ace_mode: javascript
codemirror_mode: javascript
codemirror_mime_type: text/javascript
extensions:
- ".sublime-build"
- ".sublime-commands"
- ".sublime-completions"
- ".sublime-keymap"
- ".sublime-macro"
- ".sublime-menu"
- ".sublime-mousemap"
- ".sublime-project"
- ".sublime-settings"
- ".sublime-theme"
- ".sublime-workspace"
- ".sublime_metrics"
- ".sublime_session"
language_id: 423
SugarSS:
type: markup
tm_scope: source.css.postcss.sugarss
Expand Down
File renamed without changes.
54 changes: 54 additions & 0 deletions samples/JSON with Comments/filenames/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
// Tabs > spaces
"extends": "eslint:recommended",
"env": {
"browser": true,
"es6": true,
"mocha": true,
"node": true
},
"parserOptions": {
"ecmaVersion": 2017,
"sourceType": "module"
},
"rules": {
"indent": [
"error",
"tab",
{
"ignoreComments": true,
"SwitchCase": 1
}
],
"linebreak-style": [
"error",
"unix"
],
"no-fallthrough": [
"error",
{"commentPattern": "[Ff]alls?[-\\s]?through"}
],
"no-case-declarations": 0,
"no-cond-assign": 0,
"no-console": 0,
"no-empty": 0,
"quotes": [
"error",
"double",
{"avoidEscape": true}
],
"semi": [
"error",
"always"
],
"spaced-comment": [
"error",
"always"
],
"yoda": [
"error",
"always",
{"onlyEquality": true}
]
}
}
43 changes: 43 additions & 0 deletions samples/JSON with Comments/filenames/.jscsrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"requireOperatorBeforeLineBreak": true,
"maximumLineLength": {
"value": 100,
"allowComments": true,
"allowRegex": true
},

"disallowMultipleLineStrings": true,
"disallowMixedSpacesAndTabs": true,
"disallowTrailingWhitespace": true,
"disallowSpaceAfterPrefixUnaryOperators": true,
"disallowSpaceBeforePostfixUnaryOperators": true,

"requireSpaceAfterKeywords": [
"if",
"else",
"for",
"while",
"do",
"switch",
"return",
"try",
"catch"
],
"requireSpaceBeforeBinaryOperators": true,
"requireSpaceAfterBinaryOperators": true,
"requireSpacesInConditionalExpression": true,
"requireSpaceBeforeBlockStatements": true,
"requireLineFeedAtFileEnd": true,
"requireSpacesInFunctionExpression": {
"beforeOpeningCurlyBrace": true
},
"disallowSpacesInAnonymousFunctionExpression": {
"beforeOpeningRoundBrace": true
},
"requireSpacesInsideObjectBrackets": "all",
// disabled until consensus can be formed
// "disallowSpacesInsideArrayBrackets": "all",
"disallowSpacesInsideParentheses": true,

"disallowNewlineBeforeBlockStatements": true
}
91 changes: 91 additions & 0 deletions samples/JSON with Comments/filenames/.jshintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
{
// JSHint Default Configuration File (as on JSHint website)
// See http://jshint.com/docs/ for more details

"maxerr" : 50, // {int} Maximum error before stopping

// Enforcing
"bitwise" : true, // true: Prohibit bitwise operators (&, |, ^, etc.)
"camelcase" : false, // true: Identifiers must be in camelCase
"curly" : true, // true: Require {} for every new block or scope
"eqeqeq" : true, // true: Require triple equals (===) for comparison
"forin" : true, // true: Require filtering for..in loops with obj.hasOwnProperty()
"freeze" : true, // true: prohibits overwriting prototypes of native objects such as Array, Date etc.
"immed" : false, // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
"latedef" : false, // true: Require variables/functions to be defined before being used
"newcap" : false, // true: Require capitalization of all constructor functions e.g. `new F()`
"noarg" : true, // true: Prohibit use of `arguments.caller` and `arguments.callee`
"noempty" : true, // true: Prohibit use of empty blocks
"nonbsp" : true, // true: Prohibit "non-breaking whitespace" characters.
"nonew" : false, // true: Prohibit use of constructors for side-effects (without assignment)
"plusplus" : false, // true: Prohibit use of `++` and `--`
"quotmark" : false, // Quotation mark consistency:
// false : do nothing (default)
// true : ensure whatever is used is consistent
// "single" : require single quotes
// "double" : require double quotes
"undef" : true, // true: Require all non-global variables to be declared (prevents global leaks)
"unused" : true, // Unused variables:
// true : all variables, last function parameter
// "vars" : all variables only
// "strict" : all variables, all function parameters
"strict" : true, // true: Requires all functions run in ES5 Strict Mode
"maxparams" : false, // {int} Max number of formal params allowed per function
"maxdepth" : false, // {int} Max depth of nested blocks (within functions)
"maxstatements" : false, // {int} Max number statements per function
"maxcomplexity" : false, // {int} Max cyclomatic complexity per function
"maxlen" : false, // {int} Max number of characters per line
"varstmt" : false, // true: Disallow any var statements. Only `let` and `const` are allowed.

// Relaxing
"asi" : false, // true: Tolerate Automatic Semicolon Insertion (no semicolons)
"boss" : false, // true: Tolerate assignments where comparisons would be expected
"debug" : false, // true: Allow debugger statements e.g. browser breakpoints.
"eqnull" : false, // true: Tolerate use of `== null`
"esversion" : 5, // {int} Specify the ECMAScript version to which the code must adhere.
"moz" : false, // true: Allow Mozilla specific syntax (extends and overrides esnext features)
// (ex: `for each`, multiple try/catch, function expression…)
"evil" : false, // true: Tolerate use of `eval` and `new Function()`
"expr" : false, // true: Tolerate `ExpressionStatement` as Programs
"funcscope" : false, // true: Tolerate defining variables inside control statements
"globalstrict" : false, // true: Allow global "use strict" (also enables 'strict')
"iterator" : false, // true: Tolerate using the `__iterator__` property
"lastsemic" : false, // true: Tolerate omitting a semicolon for the last statement of a 1-line block
"laxbreak" : false, // true: Tolerate possibly unsafe line breakings
"laxcomma" : false, // true: Tolerate comma-first style coding
"loopfunc" : false, // true: Tolerate functions being defined in loops
"multistr" : false, // true: Tolerate multi-line strings
"noyield" : false, // true: Tolerate generator functions with no yield statement in them.
"notypeof" : false, // true: Tolerate invalid typeof operator values
"proto" : false, // true: Tolerate using the `__proto__` property
"scripturl" : false, // true: Tolerate script-targeted URLs
"shadow" : false, // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
"sub" : false, // true: Tolerate using `[]` notation when it can still be expressed in dot notation
"supernew" : false, // true: Tolerate `new function () { ... };` and `new Object;`
"validthis" : false, // true: Tolerate using this in a non-constructor function

// Environments
"browser" : true, // Web Browser (window, document, etc)
"browserify" : false, // Browserify (node.js code in the browser)
"couch" : false, // CouchDB
"devel" : true, // Development/debugging (alert, confirm, etc)
"dojo" : false, // Dojo Toolkit
"jasmine" : false, // Jasmine
"jquery" : false, // jQuery
"mocha" : true, // Mocha
"mootools" : false, // MooTools
"node" : false, // Node.js
"nonstandard" : false, // Widely adopted globals (escape, unescape, etc)
"phantom" : false, // PhantomJS
"prototypejs" : false, // Prototype and Scriptaculous
"qunit" : false, // QUnit
"rhino" : false, // Rhino
"shelljs" : false, // ShellJS
"typed" : false, // Globals for typed array constructions
"worker" : false, // Web Workers
"wsh" : false, // Windows Scripting Host
"yui" : false, // Yahoo User Interface

// Custom Globals
"globals" : {} // additional predefined global variables
}
File renamed without changes.
8 changes: 8 additions & 0 deletions samples/JSON with Comments/filenames/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"compilerOptions": {
/* Basic Options */
"target": "es6",
"module": "commonjs",
"outDir": "dist"
}
}
88 changes: 0 additions & 88 deletions samples/JSON/filenames/.jscsrc

This file was deleted.

2 changes: 1 addition & 1 deletion vendor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,7 @@ This is a list of grammars that Linguist selects to provide syntax highlighting
- **Jison Lex:** [cdibbs/language-jison](https://github.com/cdibbs/language-jison)
- **Jolie:** [fmontesi/language-jolie](https://github.com/fmontesi/language-jolie)
- **JSON:** [textmate/json.tmbundle](https://github.com/textmate/json.tmbundle)
- **JSON with Comments:** [atom/language-javascript](https://github.com/atom/language-javascript)
- **JSON5:** [atom/language-javascript](https://github.com/atom/language-javascript)
- **JSONiq:** [wcandillon/language-jsoniq](https://github.com/wcandillon/language-jsoniq)
- **JSONLD:** [atom/language-javascript](https://github.com/atom/language-javascript)
Expand Down Expand Up @@ -357,7 +358,6 @@ This is a list of grammars that Linguist selects to provide syntax highlighting
- **Stata:** [pschumm/Stata.tmbundle](https://github.com/pschumm/Stata.tmbundle)
- **STON:** [tomas-stefano/smalltalk-tmbundle](https://github.com/tomas-stefano/smalltalk-tmbundle)
- **Stylus:** [billymoon/Stylus](https://github.com/billymoon/Stylus)
- **Sublime Text Config:** [atom/language-javascript](https://github.com/atom/language-javascript)
- **SubRip Text:** [314eter/atom-language-srt](https://github.com/314eter/atom-language-srt)
- **SugarSS:** [hudochenkov/Syntax-highlighting-for-PostCSS](https://github.com/hudochenkov/Syntax-highlighting-for-PostCSS)
- **SuperCollider:** [supercollider/language-supercollider](https://github.com/supercollider/language-supercollider)
Expand Down

0 comments on commit 1996fd8

Please sign in to comment.