Skip to content

Commit

Permalink
Add linting
Browse files Browse the repository at this point in the history
On the road to fixing jsdom#35.
  • Loading branch information
TimothyGu committed Aug 2, 2017
1 parent 2bd5a0d commit fa6cca8
Show file tree
Hide file tree
Showing 22 changed files with 1,254 additions and 195 deletions.
4 changes: 4 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules

test/output
test/__snapshots__
237 changes: 237 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,237 @@
{
"root": true,
"env": {
"node": true,
"es6": true
},
"parserOptions": {
"ecmaVersion": 6
},
"rules": {
// Possible errors
"comma-dangle": ["error", "never"],
"no-cond-assign": ["error", "except-parens"],
"no-console": "error",
"no-constant-condition": "error",
"no-control-regex": "off",
"no-debugger": "error",
"no-dupe-args": "error",
"no-dupe-keys": "error",
"no-duplicate-case": "error",
"no-empty": "error",
"no-empty-character-class": "error",
"no-ex-assign": "error",
"no-extra-boolean-cast": "error",
"no-extra-parens": ["error", "all", { "conditionalAssign": false, "nestedBinaryExpressions": false, "returnAssign": false }],
"no-extra-semi": "error",
"no-func-assign": "error",
"no-inner-declarations": "off",
"no-invalid-regexp": "error",
"no-irregular-whitespace": "error",
"no-negated-in-lhs": "error",
"no-obj-calls": "error",
"no-regex-spaces": "error",
"no-sparse-arrays": "error",
"no-unexpected-multiline": "error",
"no-unreachable": "error",
"no-unsafe-finally": "off",
"use-isnan": "error",
"valid-jsdoc": "off",
"valid-typeof": "error",

// Best practices
"accessor-pairs": "error",
"array-callback-return": "error",
"block-scoped-var": "off",
"complexity": "off",
"consistent-return": "error",
"curly": ["error", "all"],
"default-case": "off",
"dot-location": ["error", "property"],
"dot-notation": "error",
"eqeqeq": "error",
"guard-for-in": "off",
"no-alert": "error",
"no-caller": "error",
"no-case-declarations": "error",
"no-div-regex": "off",
"no-else-return": "error",
"no-empty-function": "off",
"no-empty-pattern": "error",
"no-eq-null": "error",
"no-eval": "error",
"no-extend-native": "error",
"no-extra-bind": "error",
"no-extra-label": "error",
"no-fallthrough": "error",
"no-floating-decimal": "error",
"no-implicit-coercion": "error",
"no-implicit-globals": "error",
"no-implied-eval": "off",
"no-invalid-this": "off", // meh
"no-iterator": "error",
"no-labels": ["error", { "allowLoop": true }],
"no-lone-blocks": "error",
"no-loop-func": "off",
"no-magic-numbers": "off",
"no-multi-spaces": "error",
"no-multi-str": "error",
"no-native-reassign": "error",
"no-new": "error",
"no-new-func": "error",
"no-new-wrappers": "error",
"no-octal": "error",
"no-octal-escape": "error",
"no-param-reassign": "off",
"no-process-env": "error",
"no-proto": "error",
"no-redeclare": "error",
"no-return-assign": ["error", "except-parens"],
"no-script-url": "off",
"no-self-assign": "error",
"no-self-compare": "error",
"no-sequences": "error",
"no-throw-literal": "error",
"no-unmodified-loop-condition": "error",
"no-unused-expressions": "error",
"no-unused-labels": "error",
"no-useless-call": "error",
"no-useless-concat": "error",
"no-useless-escape": "error",
"no-void": "error",
"no-warning-comments": "off",
"no-with": "error",
"radix": ["error", "as-needed"],
"vars-on-top": "off",
"wrap-iife": ["error", "outside"],
"yoda": ["error", "never"],

// Strict Mode
"strict": ["error", "global"],

// Variables
"init-declarations": "off",
"no-catch-shadow": "error",
"no-delete-var": "error",
"no-label-var": "error",
"no-restricted-globals": "off",
"no-shadow": "error",
"no-shadow-restricted-names": "error",
"no-undef": "error",
"no-undef-init": "error",
"no-undefined": "off",
"no-unused-vars": "error",
"no-use-before-define": ["error", "nofunc"],

// Node.js and CommonJS
"callback-return": "off",
"global-require": "error",
"handle-callback-err": "error",
"no-mixed-requires": ["error", true],
"no-new-require": "error",
"no-path-concat": "error",
"no-process-exit": "error",
"no-restricted-imports": "off",
"no-restricted-modules": "off",
"no-sync": "off",

// Stylistic Issues
"array-bracket-spacing": ["error", "never"],
"block-spacing": ["error", "always"],
"brace-style": ["error", "1tbs", { "allowSingleLine": false }],
"camelcase": ["error", { "properties": "always" }],
"comma-spacing": ["error", { "before": false, "after": true }],
"comma-style": ["error", "last"],
"computed-property-spacing": ["error", "never"],
"consistent-this": "off",
"eol-last": "error",
"func-names": "off",
"func-style": ["error", "declaration"],
"id-blacklist": "off",
"id-length": "off",
"id-match": "off",
"indent": ["error", 2, { "SwitchCase": 1 }],
"jsx-quotes": "off",
"key-spacing": ["error", { "beforeColon": false, "afterColon": true, "mode": "strict" }],
"keyword-spacing": ["error", { "before": true, "after": true }],
"linebreak-style": ["error", "unix"],
"lines-around-comment": "off",
"max-depth": "off",
"max-len": ["error", 120, { "ignoreUrls": true }],
"max-nested-callbacks": "off",
"max-params": "off",
"max-statements": "off",
"max-statements-per-line": ["error", { "max": 1 }],
"new-cap": ["error", { "capIsNewExceptions": ["USVString", "DOMString"] }],
"new-parens": "error",
"newline-after-var": "off",
"newline-before-return": "off",
"newline-per-chained-call": "off",
"no-array-constructor": "error",
"no-bitwise": "off",
"no-continue": "off",
"no-inline-comments": "off",
"no-lonely-if": "error",
"no-mixed-spaces-and-tabs": "error",
"no-multiple-empty-lines": "error",
"no-negated-condition": "off",
"no-nested-ternary": "error",
"no-new-object": "error",
"no-plusplus": "off",
"no-restricted-syntax": "off",
"no-spaced-func": "error",
"no-ternary": "off",
"no-trailing-spaces": "error",
"no-underscore-dangle": "off",
"no-unneeded-ternary": "error",
"no-whitespace-before-property": "error",
"object-curly-spacing": ["error", "always"],
"object-property-newline": "off",
"one-var": ["error", "never"],
"one-var-declaration-per-line": ["error", "initializations"],
"operator-assignment": ["error", "always"],
"operator-linebreak": ["error", "after"],
"padded-blocks": ["error", "never"],
"quote-props": ["error", "as-needed"],
"quotes": ["error", "double", { "avoidEscape": true, "allowTemplateLiterals": true }],
"require-jsdoc": "off",
"semi": ["error", "always"],
"semi-spacing": "error",
"sort-imports": "off",
"sort-vars": "off",
"space-before-blocks": ["error", "always"],
"space-before-function-paren": ["error", { "anonymous": "always", "named": "never" }],
"space-in-parens": ["error", "never"],
"space-infix-ops": "error",
"space-unary-ops": ["error", { "words": true, "nonwords": false }],
"spaced-comment": ["error", "always", { "markers": ["///"] }],
"wrap-regex": "off",

// ECMAScript 6
"arrow-body-style": "off", // meh
"arrow-parens": ["error", "as-needed"],
"arrow-spacing": "error",
"constructor-super": "error",
"generator-star-spacing": ["error", "after"],
"no-class-assign": "error",
"no-confusing-arrow": "off",
"no-const-assign": "error",
"no-dupe-class-members": "error",
"no-duplicate-imports": "error",
"no-new-symbol": "error",
"no-this-before-super": "error",
"no-useless-computed-key": "error",
"no-useless-constructor": "error",
"no-var": "error",
"object-shorthand": "error",
"prefer-arrow-callback": "error",
"prefer-const": ["error", { "ignoreReadBeforeAssign": true }],
"prefer-reflect": "off",
"prefer-rest-params": "off",
"prefer-spread": "error",
"prefer-template": "off",
"require-yield": "error",
"template-curly-spacing": ["error", "never"],
"yield-star-spacing": ["error", "after"]
}
}
4 changes: 4 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ node_js:
- 6
- stable

script:
- npm test
- npm run lint

branches:
only:
- master
Expand Down
2 changes: 1 addition & 1 deletion lib/constructs/attribute.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Attribute.prototype.generate = function () {
if (!reflector[this.idl.idlType.idlType]) {
throw new Error("Unknown reflector type: " + this.idl.idlType.idlType);
}
const attrName = shouldReflect.rhs && shouldReflect.rhs.value.replace(/_/g, '-') || this.idl.name;
const attrName = shouldReflect.rhs && shouldReflect.rhs.value.replace(/_/g, "-") || this.idl.name;
getterBody = reflector[this.idl.idlType.idlType].get(objName, attrName);
setterBody = reflector[this.idl.idlType.idlType].set(objName, attrName);
}
Expand Down
5 changes: 3 additions & 2 deletions lib/constructs/dictionary.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class Dictionary {
const fields = [];
const members = this.idl.members;
members.forEach(member => {
if (member.type !== 'field') {
if (member.type !== "field") {
throw new Error("webidl2js doesn't support non-field members in dictionaries");
}
fields.push(member);
Expand All @@ -32,7 +32,8 @@ class Dictionary {
for (const field of this._prepareFields()) {
const typeConversion = field.idlType;
const argAttrs = field.extAttrs;
const conv = Types.generateTypeConversion(this.ctx, "value", typeConversion, argAttrs, this.name, `\`\${context} has member ${field.name} that\``);
const conv = Types.generateTypeConversion(
this.ctx, "value", typeConversion, argAttrs, this.name, `context + " has member ${field.name} that"`);
Object.assign(this.requires, conv.requires);

str += `
Expand Down
27 changes: 14 additions & 13 deletions lib/constructs/interface.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
"use strict";

const path = require("path");

const utils = require("../utils");
const Attribute = require("./attribute");
const Constant = require("./constant");
Expand All @@ -15,7 +13,7 @@ function Interface(ctx, idl, opts) {
this.ctx = ctx;
this.idl = idl;
this.name = idl.name;
this.factory = !!utils.getExtAttr(this.idl.extAttrs, "WebIDL2JSFactory");
this.factory = Boolean(utils.getExtAttr(this.idl.extAttrs, "WebIDL2JSFactory"));

this.mixins = [];
this.requires = {};
Expand Down Expand Up @@ -89,21 +87,24 @@ Interface.prototype.generateConstructor = function () {
}
}

const conversions = Parameters.generateOverloadConversions(this.ctx, overloads, this.name, `Failed to construct '${this.name}': `);
const conversions =
Parameters.generateOverloadConversions(this.ctx, overloads, this.name, `Failed to construct '${this.name}': `);
Object.assign(this.requires, conversions.requires);

minConstructor.nameList = minConstructor.nameList.map((name) => (keywords.has(name) ? "_" : "") + name);
minConstructor.nameList = minConstructor.nameList.map(name => (keywords.has(name) ? "_" : "") + name);
this.str += `
function ${this.name}(${minConstructor.nameList.join(", ")}) {
`;
if (minConstructor.nameList.length !== 0) {
const plural = minConstructor.nameList.length > 1 ? "s" : "";
this.str += `
if (!new.target) {
throw new TypeError("Failed to construct '${this.name}'. Please use the 'new' operator; this constructor cannot be called as a function.");
throw new TypeError("Failed to construct '${this.name}'. Please use the 'new' operator; this constructor " +
"cannot be called as a function.");
}
if (arguments.length < ${minConstructor.nameList.length}) {
throw new TypeError("Failed to construct '${this.name}': ${minConstructor.nameList.length} argument${plural} required, but only " + arguments.length + " present.");
throw new TypeError("Failed to construct '${this.name}': ${minConstructor.nameList.length} " +
"argument${plural} required, but only " + arguments.length + " present.");
}
`;
}
Expand Down Expand Up @@ -222,7 +223,7 @@ Interface.prototype.generateIface = function () {
if (shouldExposeRoot) {
let exposedOn = ["Window"];
const exposedAttrs = this.idl.extAttrs
.filter(function (attr) { return attr.name === "Exposed"; });
.filter(attr => attr.name === "Exposed");
if (exposedAttrs.length !== 0) {
if (typeof exposedAttrs[0].rhs.value === "string") {
exposedAttrs[0].rhs.value = [exposedAttrs[0].rhs.value];
Expand All @@ -237,7 +238,7 @@ Interface.prototype.generateIface = function () {
}
}

let exposers = [];
const exposers = [];
for (let keys = Object.keys(exposedMap), i = 0; i < keys.length; ++i) {
exposers.push(keys[i] + ": { " + exposedMap[keys[i]].join(", ") + " }");
}
Expand Down Expand Up @@ -345,13 +346,13 @@ Interface.prototype.generateOperations = function () {
member = new Iterable(this.ctx, this, this.idl, memberIdl);
break;
default:
//throw new Error("Can't handle member of type '" + memberIdl.type + "'");
// throw new Error("Can't handle member of type '" + memberIdl.type + "'");
break;
}

if (member !== null) {
const data = member.generate();
Object.assign(this.requires, data.requires),
Object.assign(this.requires, data.requires);
this.str += data.body;
}
}
Expand All @@ -373,7 +374,7 @@ Interface.prototype.generateAttributes = function () {
member = new Constant(this.ctx, this, this.idl, memberIdl);
break;
default:
//throw new Error("Can't handle member of type '" + memberIdl.type + "'");
// throw new Error("Can't handle member of type '" + memberIdl.type + "'");
break;
}

Expand All @@ -396,7 +397,7 @@ Interface.prototype.generateSymbols = function () {
if (Object.keys(unscopables).length) {
this.str += `
Object.defineProperty(${this.name}.prototype, Symbol.unscopables, {
value: ${JSON.stringify(unscopables, null, ' ')},
value: ${JSON.stringify(unscopables, null, " ")},
writable: false,
enumerable: false,
configurable: true
Expand Down
Loading

0 comments on commit fa6cca8

Please sign in to comment.