NEW: Add rule "member-access" to enforce visibility modifiers such as public, private, protected, and static. (refs bradzacher#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/member-access.md

@@ -0,0 +1,42 @@
+# Enforces visibility modifier on class properties and methods (method-access)
+
+Leaving off visibility 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 visibility modifier
+  getName (): string {} // No visibility modifier
+}
+```
+
+The following patterns are not warnings:
+
+```ts
+class Animal {
+  private name: string // explicit visibility modifier
+  public getName (): string {} // explicit visibility 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 [Visibility 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/member-access.js

@@ -0,0 +1,80 @@
+/**
+ * @fileoverview Enforces explicit visibility modifier for class members
+ * @author Danny Fritz
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "Enforces explicity visibility modifiers for class members",
+            category: "TypeScript"
+        },
+        schema: []
+    },
+
+    create: function(context) {
+
+        var sourceCode = context.getSourceCode();
+        var visibilityRegExp = /^(public)|(private)|(static)|(protected)/;
+
+        //----------------------------------------------------------------------
+        // Helpers
+        //----------------------------------------------------------------------
+
+        /**
+         * Checks if a string starts with a visibility modifier.
+         * @param {string} nodeText The text representing a node.
+         * @returns {boolean} true if it has a visibility decorator
+         * @private
+         */
+        function hasVisibilityDeclaration(nodeText) {
+            if (visibilityRegExp.test(nodeText)) {
+                return true;
+            }
+            return false;
+        }
+
+        /**
+         * Checks if a method declaration has visibility modifier.
+         * @param {ASTNode} methodDefinition The node representing a MethodDefinition.
+         * @returns {void}
+         * @private
+         */
+        function checkMethodVisibilityModifier(methodDefinition) {
+            if (!hasVisibilityDeclaration(sourceCode.getText(methodDefinition))) {
+                context.report({
+                    node: methodDefinition,
+                    message: "Missing visibility modifier on method definition " + methodDefinition.key.name + "."
+                });
+            }
+        }
+
+        /**
+         * Checks if property has visibility modifiers.
+         * @param {ASTNode} classProperty The node representing a ClassProperty.
+         * @returns {void}
+         * @private
+         */
+        function checkPropertyVisibilityModifier(classProperty) {
+            if (!hasVisibilityDeclaration(sourceCode.getText(classProperty))) {
+                context.report({
+                    node: classProperty,
+                    message: "Missing visibility modifier on class property " + classProperty.key.name + "."
+                });
+            }
+        }
+
+        //----------------------------------------------------------------------
+        // Public
+        //----------------------------------------------------------------------
+        return {
+            ClassProperty: checkPropertyVisibilityModifier,
+            MethodDefinition: checkMethodVisibilityModifier
+        };
+    }
+};

tests/lib/rules/member-access.js

@@ -0,0 +1,70 @@
+/**
+ * @fileoverview Enforces explicit visibility modifiers for class members
+ * @author Danny Fritz
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var rule = require("../../../lib/rules/member-access"),
+    RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+var ruleTester = new RuleTester();
+ruleTester.run("member-access", rule, {
+
+    valid: [
+        {
+            code: `
+class Test {
+  static 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 visibility 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 visibility modifier on method definition getX.",
+                line: 4,
+                column: 3
+            }]
+        }
+    ]
+});