Comparing changes

(cherry picked from commit 3dcfe42)

(cherry picked from commit 720bef0)

(cherry picked from commit ac4f8bc)

(cherry picked from commit ec25008)

@returns

### New features * Converts custom linter from JS to strict TypeScript * Adds new custom linter rules (see below) * Adds `curly: true` and `quotemark: avoid-escape` to `tslint.json` to match internal style guide * Fixes all linter violations (including missing/typo'd methods in `README.md` files) * Renames `npm run lint:imports` to `lint:mdc` * Renames `lint-imports.js` to `lint-mdc.ts` ### New linter rules #### Leading underscores are prohibited in function and property names ```ts function _emit() {} // linter error class MDCFoo { _bar = false; // linter error } ``` #### Trailing underscores are only allowed on class properties and methods ```ts interface MDCFooAdapter { bar_(): void; // linter error (trailing underscore not allowed in interface) } class MDCFooFoundation { private bar_() {} // OK } ``` #### Trailing underscore members must be marked `private` or `protected` (and vice versa) ```ts class MDCFoo { root_!: HTMLElement; // OK (there's an exception for root_) foo_ = false; // linter error (missing private/protected) private bar_ = 1; // OK protected baz = 2; // linter error (missing trailing underscore) } ``` #### Inline-initialized properties that could overwrite method-assigned values are not allowed in `component.ts` files ```ts class MDCFoo { private foo_ = -1; // linter error (this.foo_ is reassigned below) private bar_ = -1; // OK (value is never reassigned) initialize() { this.foo_ = someCondition ? 16 : 0; } } ``` #### `@returns` (plural) annotations are prohibited in favor of `@return` (singular) ```ts class MDCFoo { /** * @returns Whether the foo is a bar. // linter error (use `@return` instead) */ isBar() { return true; } /** * @return Whether the foo is a baz. // OK */ isBaz() { return true; } } ``` #### Public class methods and properties must be documented in the package's `README.md` file This includes interfaces in `adapter.ts` as well. ```markdown ### `MDCFooAdapter` Method Signature | Description --- | --- `deregisterFoo() => void` | Deregisters the foo. ### `MDCFooFoundation` Method Signature | Description --- | --- `setFoo(foo: boolean) => void` | Sets the value of `foo`. ``` ```ts /** @fileoverview adapter.ts */ interface MDCFooAdapter { registerFoo(): void; // linter error (missing from README) deregisterFoo(): void; // OK (method appears in README) } ``` ```ts /** @fileoverview foundation.ts */ class MDCFooFoundation { foo = true; // OK (property appears in README) bar = true; // linter error (missing from README) setFoo(foo) { this.foo = foo; } // OK (method appears in README) setBar(bar) { this.bar = bar; } // linter error (missing from README) } ``` ```ts /** @fileoverview types.ts */ interface MDCMenuPoint { x: number; // OK (non-adapter interfaces are exempt) y: number; // OK (non-adapter interfaces are exempt) } ``` ### Backward-incompatible changes Several internal methods had typos in their names prior to the [TS conversion](#4451). This PR fixes them. Realistically, the changes shouldn't affect any clients, but it's technically possible that someone could be relying on one of these methods: * `MDCTextField.initialSyncWithDom()` has been renamed to `initialSyncWithDOM()` to override the [base method in `MDCComponent`](https://github.com/material-components/material-components-web/blob/720bef02fe5d55cffe827614de89f6eac8b0526b/packages/mdc-base/component.ts#L50). This typo was [already present in the JS version](https://github.com/material-components/material-components-web/blob/aa4499148b39d1e7a77d68822047df536946fdb6/packages/mdc-textfield/index.js#L199). * `MDCDismissibleDrawerFoundation` methods `opened()` and `closed()` have been renamed to `opened_()` and `closed_()` to reflect their `protected` accessibility. * All methods with trailing underscores are now explicitly marked `private` or `protected`. (cherry picked from commit 7357170)

(cherry picked from commit 0dc25f4)

…#4485) (cherry picked from commit 6082dc3)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comparing changes

Open a pull request

Commits on Mar 11, 2019

This comparison is taking too long to generate.