eslint-plugin-hackmud2
Version:
Linting rules for hackmud player-scripts
221 lines (185 loc) • 7.02 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.create = exports.validateSecLevel = exports.validateIdentifier = exports.subscriptInfo = exports.meta = undefined;
var _config = require("../config.js");
var meta = exports.meta = {
docs: {
description: "validate subscript directive syntax",
category: "Possible Errors",
recommended: true
},
schema: [] // no options
};
var subscriptInfo = exports.subscriptInfo = function subscriptInfo(node) {
var sub = /^\$(\w?S)_/.exec(node.name);
var secLevel = sub[1];
var identifier = [node.name.substr(secLevel.length + 2)];
var root = node;
while (root.parent.type == 'MemberExpression') {
identifier.push(root.parent.property.name);
root = root.parent;
}
return {
secLevel,
identifier,
root: root.parent,
node
};
};
var validateIdentifier = exports.validateIdentifier = function validateIdentifier(context, _ref) {
var secLevel = _ref.secLevel,
identifier = _ref.identifier,
root = _ref.root,
node = _ref.node;
if (!identifier.length || !identifier[0]) {
context.report({
message: 'Missing subscript identifier',
node: node
});
return false;
}
if (identifier.length > 2) {
context.report({
message: `Invalid subscript identifier`,
node: root
});
return false;
}
var user = identifier[0];
var script = identifier[1];
var subscript = '#' + secLevel.toLowerCase() + '.' + identifier.join('.');
if (!/^[a-z0-9_]*$/.test(user)) {
context.report({
message: 'Invalid username for subscript ' + subscript,
node: root
});
}
if (!script) {
context.report({
message: 'Missing script name for subscript ' + subscript,
node: root
});
return false;
}
if (!/^[a-z][a-z0-9_]*$/.test(user)) {
context.report({
message: 'Invalid script name for subscript ' + subscript,
node: root
});
return false;
}
return true;
};
var validateSecLevel = exports.validateSecLevel = function validateSecLevel(context, _ref2) {
var secLevel = _ref2.secLevel,
identifier = _ref2.identifier,
root = _ref2.root;
if (!['F', 'H', 'M', 'L', 'N', '4', '3', '2', '1', '0'].includes(secLevel[0].toUpperCase())) {
context.report({
message: 'Invalid security level for subscript #' + secLevel.toLowerCase() + '.' + identifier.join('.'),
node: root
});
return false;
}
return true;
};
var create = exports.create = function create(context) {
var globalScope = void 0;
/**
* makeDefined() - Force define identifiers on the fly.
* Borrowed from https://github.com/gajus/eslint-plugin-flowtype/blob/1edcaec087695482c0a860bead6bfa4f19c15ea3/src/rules/defineFlowType.js
*
* Copyright (c) 2015, Gajus Kuizinas (http://gajus.com/)
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Gajus Kuizinas (http://gajus.com/) nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL ANUARY BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
var makeDefined = function makeDefined(ident) {
var ii = void 0;
// start from the right since we're going to remove items from the array
for (ii = globalScope.through.length - 1; ii >= 0; ii--) {
var ref = globalScope.through[ii];
if (ref.identifier.name === ident.name) {
// use "__defineGeneric" since we don't have a reference to "escope.Variable"
globalScope.__defineGeneric( // eslint-disable-line no-underscore-dangle
ident.name, globalScope.set, globalScope.variables);
var variable = globalScope.set.get(ident.name);
variable.writeable = false;
// "through" contains all references whose definition cannot be found
// so we need to update references and remove the ones that were added
globalScope.through.splice(ii, 1);
ref.resolved = variable;
variable.references.push(ref);
}
}
};
return {
"Program": function Program() {
return globalScope = context.getScope();
},
"ReturnStatement > FunctionExpression Identifier[name=/^\\$S_/]": function ReturnStatementFunctionExpressionIdentifierName$S_(node) {
return context.report({
message: 'Deprecated syntax: missing security level identifier',
node
});
},
"ReturnStatement > FunctionExpression Identifier[name=/^\\$\\wS_/]": function ReturnStatementFunctionExpressionIdentifierName$WS_(node) {
var sinfo = subscriptInfo(node);
if (!validateSecLevel(context, sinfo) || !validateIdentifier(context, sinfo)) return;
var root = sinfo.root,
identifier = sinfo.identifier;
if (root.type != 'CallExpression') {
return context.report({
message: 'Missing calling parenthesis',
node: node
});
}
var nextToken = context.getTokenAfter(root.callee);
if (nextToken.value != '(') {
return context.report({
message: 'Unexpected {{ type }} {{ token }} Expected: (',
node: root,
data: {
type: nextToken.type,
token: nextToken.value
}
});
}
var source = context.getSourceCode();
if (source.isSpaceBetweenTokens(root.callee, nextToken)) {
return context.report({
message: 'Unexpected whitespace between subscript identifier and call',
node: root
});
}
// If the scriptor's valid, mark it as "defined" to avoid no-undef hints
makeDefined(node);
}
};
};
exports.default = {
meta,
create
};