NEW: Add rule "use-accessibility" to enforce accessibility modifiers such as public, private, and protected. (refs #4)

Author: dannyfritz

README.md

@@ -50,8 +50,4 @@ Then configure the rules you want to use under the rules section.
 ## Supported Rules
 
 * `typescript/type-annotation-spacing` - enforces one space after the colon and zero spaces before the colon of a type annotation.
-
-
-
-
-
+* `typescript/member-access` - enforces visibility modifiers on class properties and methods.

docs/rules/use-accessibility.md

@@ -0,0 +1,42 @@
+# Enforces accessibility modifiers on class properties and methods (use-accessibility)
+
+Leaving off accessibility modifier and making everything public can make
+your interface hard to use by others.
+If you make all internal pieces private or protected, your interface will
+be easier to use.
+
+## Rule Details
+
+This rule aims to make code more readable and explicit about who can use
+which properties.
+
+The following patterns are considered warnings:
+
+```ts
+class Animal {
+  name: string // No accessibility modifier
+  getName (): string {} // No accessibility modifier
+}
+```
+
+The following patterns are not warnings:
+
+```ts
+class Animal {
+  private name: string // explicit accessibility modifier
+  public getName (): string {} // explicit accessibility modifier
+}
+```
+
+## When Not To Use It
+
+If you think defaulting to public is a good default then you will not need
+this rule.
+
+## Further Reading
+
+* TypeScript [Accessibility Modifiers](https://www.typescriptlang.org/docs/handbook/classes.html#public-private-and-protected-modifiers)
+
+## Compatibility
+
+* TSLint: [member-access](http://palantir.github.io/tslint/rules/member-access/)

lib/rules/use-accessibility.js

@@ -0,0 +1,64 @@
+/**
+ * @fileoverview Enforces explicit accessibility modifier for class members
+ * @author Danny Fritz
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "Enforces explicity accessibility modifiers for class members",
+            category: "TypeScript"
+        },
+        schema: []
+    },
+
+    create: function(context) {
+
+        //----------------------------------------------------------------------
+        // Helpers
+        //----------------------------------------------------------------------
+
+        /**
+         * Checks if a method declaration has an accessibility modifier.
+         * @param {ASTNode} methodDefinition The node representing a MethodDefinition.
+         * @returns {void}
+         * @private
+         */
+        function checkMethodAccessibilityModifier(methodDefinition) {
+            if (!methodDefinition.accessibility) {
+                context.report({
+                    node: methodDefinition,
+                    message: "Missing accessibility modifier on method definition " + methodDefinition.key.name + "."
+                });
+            }
+        }
+
+        /**
+         * Checks if property has an accessibility modifier.
+         * @param {ASTNode} classProperty The node representing a ClassProperty.
+         * @returns {void}
+         * @private
+         */
+        function checkPropertyAccessibilityModifier(classProperty) {
+            if (!classProperty.accessibility) {
+                context.report({
+                    node: classProperty,
+                    message: "Missing accessibility modifier on class property " + classProperty.key.name + "."
+                });
+            }
+        }
+
+        //----------------------------------------------------------------------
+        // Public
+        //----------------------------------------------------------------------
+        return {
+            ClassProperty: checkPropertyAccessibilityModifier,
+            MethodDefinition: checkMethodAccessibilityModifier
+        };
+    }
+};

package.json

@@ -21,7 +21,7 @@
     "eslint": "~3.0.0",
     "eslint-config-eslint": "^3.0.0",
     "mocha": "^2.4.5",
-    "typescript-eslint-parser": "~0.1.1"
+    "typescript-eslint-parser": "^0.4.0"
   },
   "engines": {
     "node": ">=4"

tests/lib/rules/use-accessibility.js

@@ -0,0 +1,70 @@
+/**
+ * @fileoverview Enforces explicit accessibility modifiers for class members
+ * @author Danny Fritz
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var rule = require("../../../lib/rules/use-accessibility"),
+    RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+var ruleTester = new RuleTester();
+ruleTester.run("use-accessibility", rule, {
+
+    valid: [
+        {
+            code: `
+class Test {
+  protected name: string
+  private x: number
+  public getX () {
+    return this.x
+  }
+}
+            `,
+            parser: "typescript-eslint-parser"
+        }
+    ],
+    invalid: [
+        {
+            code: `
+class Test {
+  x: number
+  public getX () {
+    return this.x
+  }
+}
+          `,
+            parser: "typescript-eslint-parser",
+            errors: [{
+                message: "Missing accessibility modifier on class property x.",
+                line: 3,
+                column: 3
+            }]
+        },
+        {
+            code: `
+class Test {
+  private x: number
+  getX () {
+    return this.x
+  }
+}
+          `,
+            parser: "typescript-eslint-parser",
+            errors: [{
+                message: "Missing accessibility modifier on method definition getX.",
+                line: 4,
+                column: 3
+            }]
+        }
+    ]
+});