Skip to content
This repository has been archived by the owner on Jan 19, 2019. It is now read-only.

WIP: Add array-type rule #117

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added docs/rules/array-type.md
Empty file.
58 changes: 58 additions & 0 deletions lib/rules/array-type.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* @fileoverview Requires using either 'T[]' or 'Array' for arrays.
* @author Mackie Underdown
*/
"use strict";

const util = require("../util");

//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------

module.exports = {
meta: {
docs: {
description: "Requires using either 'T[]' or 'Array' for arrays",
extraDescription: [util.tslintRule("array-type")],
category: "TypeScript",
url:
"https://github.com/nzakas/eslint-plugin-typescript/blob/master/docs/rules/array-type.md"
},
schema: [
{
enum: ["array", "generic", "array-simple"]
}
]
},
create(context) {
const arrayType = context.options[0] || "array";
//----------------------------------------------------------------------
// Public
//----------------------------------------------------------------------

return {
TypeAnnotation: console.log, // eslint-disable-line no-console
TSArrayType(node) {
console.log(node); // eslint-disable-line no-console
if (arrayType === "generic") {
context.report({
node,
message:
"Array type using 'T[]' is forbidden. Use 'Array<T>' instead."
});
}
},
TSTypeReference(node) {
console.log(node); // eslint-disable-line no-console
if (node.typeName.name === "Array" && arrayType === "array") {
context.report({
node,
message:
"Array type using 'Array<T>' is forbidden. Use 'T[]' instead."
});
}
}
};
}
};
122 changes: 122 additions & 0 deletions tests/lib/rules/array-type.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
/**
* @fileoverview Requires using either 'T[]' or 'Array' for arrays.
* @author Mackie Underdown
*/
"use strict";

//------------------------------------------------------------------------------
// Requirements
//------------------------------------------------------------------------------

const rule = require("../../../lib/rules/array-type"),
RuleTester = require("eslint").RuleTester;

//------------------------------------------------------------------------------
// Tests
//------------------------------------------------------------------------------

const arrayMessage =
"Array type using 'Array<T>' is forbidden. Use 'T[]' instead.";
const genericMessage =
"Array type using 'T[]' is forbidden. Use 'Array<T>' instead.";

const ruleTester = new RuleTester({
parser: "typescript-eslint-parser"
});

ruleTester.run("array-type", rule, {
valid: [
{
code: "let a: string[] = []",
options: ["array"]
},
{
code: "let a: (string | number)[] = []",
options: ["array"]
},
{
code: "let a: ({ foo: Bar[] })[] = []",
options: ["array"]
},
{
code: "let a: Array<string> = []",
options: ["generic"]
},
{
code: "let a: Array<string| number> = []",
options: ["generic"]
},
{
code: "let a: Array<{ foo: Array<Bar> }> = []",
options: ["generic"]
}
],
invalid: [
{
code: "let a: Array<string> = []",
options: ["array"],
errors: [
{
message: arrayMessage,
line: 1,
column: 8
}
]
},
{
code: "let a: Array<string | number> = []",
options: ["array"],
errors: [
{
message: arrayMessage,
line: 1,
column: 8
}
]
},
{
code: "let a: ({ foo: Array<Bar> })[] = []",
options: ["array"],
errors: [
{
message: arrayMessage,
line: 1,
column: 8
}
]
},
{
code: "let a: string[] = []",
options: ["generic"],
errors: [
{
message: genericMessage,
line: 1,
column: 8
}
]
},
{
code: "let a: (string | number)[] = []",
options: ["generic"],
errors: [
{
message: genericMessage,
line: 1,
column: 8
}
]
},
{
code: "let a: Array<{ foo: Bar[] }> = []",
options: ["generic"],
errors: [
{
message: genericMessage,
line: 1,
column: 8
}
]
}
]
});