1.6.0

Author: [Interfaced] Кирилл Дронкин

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Change log
 
+## 1.6.0 (release date: 6.12.2018)
+
+* `caps-const`: fixed an exception on enum-variables checking
+* `event-const-value`: fixed an exception on constant-variables checking
+
+* New rules:
+    - `singular-enum`
+    - `no-jsdoc-type-multi-spaces`
+
+* Renamed rules:
+    - `no-tabs-in-jsdoc-type` -> `no-jsdoc-type-tabs`
+
+* Removed rules:
+    - `statics-order`
+    - `lines-between-static`
+    - `prevent-unused-typedef-vars`
+
+* Added `type` field to rule metas
+* Support for global constants, enums and typedefs
+* Support for exported constants, enums and typedefs
+
 ## 1.5.0 (release date: 19.10.2018)
 
 * `abstract-class-name-prefix`, `interface-name-prefix`: handle anonymous class declarations
@@ -41,7 +62,7 @@
 
 * `lines-around-class`: use `1` as the default value for `before` and `after`
 * `prefer-shorthand-jsdoc-types`: autofixing; removed `consistent` option
-* `jsdoc-type-spacing`: autofixing; completely new options (see docs/rules/jsdoc-type-spacing)
+* `jsdoc-type-spacing`: autofixing; completely new options (see `docs/rules/jsdoc-type-spacing`)
 * `jsdoc-type-application-dot`: autofixing
 * `jsdoc-tags-order`: autofixing
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2017 Interfaced
+Copyright © 2017-2018 Interfaced
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the “Software”), to deal

README.md

@@ -1,6 +1,6 @@
 # eslint-plugin-interfaced
 
-[ESLint](https://eslint.org) plugin with rules for the approaches adopted by [Interfaced](http://interfaced.tv) company.
+[ESLint](https://eslint.org) plugin with essential rules for [Closure Compiler](https://developers.google.com/closure/compiler/) environment and [JSDoc](http://usejsdoc.org/).
 
 ## Usage
 
@@ -10,7 +10,7 @@
 npm i eslint-plugin-interfaced --save-dev
 ```
 
-2) Specify "interfaced" as a plugin in your .eslintrc:
+2) Specify "interfaced" as a plugin in your `.eslintrc`:
 
 ```json
 {
@@ -20,7 +20,7 @@ npm i eslint-plugin-interfaced --save-dev
 }
 ```
 
-3) Enable all of the rules that you would like to use in your .eslintrc:
+3) Enable all of the rules that you would like to use in your `.eslintrc`:
 
 ```json
 {
@@ -32,38 +32,47 @@ npm i eslint-plugin-interfaced --save-dev
 
 ## Rules
 
-* [interfaced/abstract-class-name-prefix](docs/rules/abstract-class-name-prefix.md)
-* [interfaced/capitalized-enum](docs/rules/capitalized-enum.md)
-* [interfaced/capitalized-typedef](docs/rules/capitalized-typedef.md)
-* [interfaced/caps-const](docs/rules/caps-const.md)
-* [interfaced/event-const-desc](docs/rules/event-const-desc.md)
-* [interfaced/event-const-value](docs/rules/event-const-value.md)
-* [interfaced/interface-name-prefix](docs/rules/interface-name-prefix.md)
-* [interfaced/jsdoc-tags-order](docs/rules/jsdoc-tags-order.md)
-* [interfaced/jsdoc-type-application-dot](docs/rules/jsdoc-type-application-dot.md)
-* [interfaced/jsdoc-type-indent](docs/rules/jsdoc-type-indent.md)
-* [interfaced/jsdoc-type-spacing](docs/rules/jsdoc-type-spacing.md)
-* [interfaced/lines-around-class](docs/rules/lines-around-class.md)
-* [interfaced/lines-between-methods](docs/rules/lines-between-methods.md)
-* [interfaced/lines-between-props](docs/rules/lines-between-props.md)
-* [interfaced/lines-between-statics](docs/rules/lines-between-statics.md)
-* [interfaced/methods-order](docs/rules/methods-order.md)
-* [interfaced/no-empty-method](docs/rules/no-empty-method.md)
-* [interfaced/no-public-underscore](docs/rules/no-public-underscore.md)
-* [interfaced/no-restricted-jsdoc-tags](docs/rules/no-restricted-jsdoc-tags.md)
-* [interfaced/no-tabs-in-jsdoc-type](docs/rules/no-tabs-in-jsdoc-type.md)
-* [interfaced/prefer-shorthand-jsdoc-types](docs/rules/prefer-shorthand-jsdoc-types.md)
-* [interfaced/prevent-unused-jsdoc-types](docs/rules/prevent-unused-jsdoc-types.md)
-* [interfaced/prevent-unused-meta-params](docs/rules/prevent-unused-meta-params.md)
-* [interfaced/prevent-unused-typedef-vars](docs/rules/prevent-unused-typedef-vars.md)
-* [interfaced/props-order](docs/rules/props-order.md)
-* [interfaced/statics-order](docs/rules/statics-order.md)
-* [interfaced/typecast-spacing](docs/rules/typecast-spacing.md)
-
-## Redefined rules
-
-Some useful rules which are provided by ESLint are slightly inappropriate for Closure Compiler environment, 
-so we redefine them with some adjusting for our requirements.
+### JSDoc
+
+* [interfaced/jsdoc-tags-order](docs/rules/jsdoc-tags-order.md) - enforce the specified order for JSDoc tags
+* [interfaced/jsdoc-type-application-dot](docs/rules/jsdoc-type-application-dot.md) - enforce dot before "<" symbol in JSDoc type application
+* [interfaced/jsdoc-type-indent](docs/rules/jsdoc-type-indent.md) - enforce consistent indentation in JSDoc type
+* [interfaced/jsdoc-type-spacing](docs/rules/jsdoc-type-spacing.md) - enforce consistent spacing in JSDoc type
+* [interfaced/no-jsdoc-type-multi-spaces](docs/rules/no-jsdoc-type-multi-spaces.md) - disallow multiple spaces in JSDoc type
+* [interfaced/no-jsdoc-type-tabs](docs/rules/no-jsdoc-type-tabs.md) - disallow tab characters in JSDoc type
+* [interfaced/no-restricted-jsdoc-tags](docs/rules/no-restricted-jsdoc-tags.md) - disallow the specified JSDoc tags
+* [interfaced/prefer-shorthand-jsdoc-types](docs/rules/prefer-shorthand-jsdoc-types.md) - enforce usage of a shorthand notation for some JSDoc types
+* [interfaced/prevent-unused-jsdoc-types](docs/rules/prevent-unused-jsdoc-types.md) - prevent variables used in JSDoc type to be marked as unused
+
+### Naming convention
+
+* [interfaced/abstract-class-name-prefix](docs/rules/abstract-class-name-prefix.md) - enforce "Abstract" prefix for abstract class name
+* [interfaced/capitalized-enum](docs/rules/capitalized-enum.md) - enforce capitalization of the first letter of an enum
+* [interfaced/capitalized-typedef](docs/rules/capitalized-typedef.md) - enforce capitalization of the first letter of a typedef
+* [interfaced/caps-const](docs/rules/caps-const.md) - enforce caps notation for constant name and enum properties
+* [interfaced/event-const-desc](docs/rules/event-const-desc.md) - enforce event description ("Fired with: ...") for event constant
+* [interfaced/event-const-value](docs/rules/event-const-value.md) - enforce event constant value to be a lowercase latin string with dash sign delimiter
+* [interfaced/interface-name-prefix](docs/rules/interface-name-prefix.md) - enforce "I" prefix for interface name
+* [interfaced/singular-enum](docs/rules/singular-enum.md) - enforce enum name to be singular
+
+### Stylistic issues
+
+* [interfaced/lines-around-class](docs/rules/lines-around-class.md) - enforce newlines before and after class
+* [interfaced/lines-between-methods](docs/rules/lines-between-methods.md) - enforce newlines between methods
+* [interfaced/lines-between-props](docs/rules/lines-between-props.md) - enforce newlines between properties
+* [interfaced/methods-order](docs/rules/methods-order.md) - enforce the specified order for methods
+* [interfaced/props-order](docs/rules/props-order.md) - enforce the specified order for properties
+* [interfaced/typecast-spacing](docs/rules/typecast-spacing.md) - enforce spacing in typecast (JSDoc + parenthesis)
+
+### Other
+
+* [interfaced/no-empty-method](docs/rules/no-empty-method.md) - disallow empty methods when class is neither abstract, interface nor record
+* [interfaced/no-public-underscore](docs/rules/no-public-underscore.md) - disallow methods and properties with name that starts from "_" without private/protected access modifier
+* [interfaced/prevent-unused-meta-params](docs/rules/prevent-unused-meta-params.md) - prevent interface, record, abstract or overriding method params to be marked as unused
+
+### Redefined
+
+Some useful rules provided by ESLint are slightly inappropriate for our environment, so we redefine them with some adjusting:
 
 * [interfaced/camelcase](docs/redefined/camelcase.md)
 * [interfaced/no-param-reassign](docs/redefined/no-param-reassign.md)

docs/rules/event-const-value.md

@@ -1,6 +1,6 @@
 # interfaced/event-const-value
 
-Enforce event constant value to be a lowercase latinic string with dash sign delimiter.
+Enforce event constant value to be a lowercase latin string with dash sign delimiter.
 
 ## Resources
 

docs/rules/jsdoc-type-application-dot.md

@@ -1,6 +1,6 @@
 # interfaced/jsdoc-type-application-dot
 
-Enforce dot before `<` symbol in JSDoc type application.
+Enforce dot before "<" symbol in JSDoc type application.
 
 **Fixable:** this rule is automatically fixable by `--fix`.
 

docs/rules/lines-between-statics.md

@@ -0,0 +1,28 @@
+# interfaced/no-jsdoc-type-multi-spaces
+
+Disallow multiple spaces in JSDoc type.
+
+**Fixable:** this rule is automatically fixable by `--fix`.
+
+## Examples
+
+**Correct** code for this rule:
+
+```js
+/**
+ * @type {string | number}
+ */
+```
+
+**Incorrect** code for this rule:
+
+```js
+/**
+ * @enum {string  |  number}
+ */
+```
+
+## Resources
+
+* [Source](../../lib/rules/no-jsdoc-type-multi-spaces.js)
+* [Tests](../../test/eslint/rules/no-jsdoc-type-multi-spaces.js)

docs/rules/no-jsdoc-type-multi-spaces.md

@@ -0,0 +1,30 @@
+# interfaced/no-jsdoc-type-tabs
+
+Disallow tab characters in JSDoc type.
+
+## Examples
+
+**Correct** code for this rule:
+
+```js
+/**
+ * @type {{
+ *     key: number
+ *}}
+ */
+```
+
+**Incorrect** code for this rule:
+
+```js
+/**
+ * @type {{
+ * \t key: number
+ * }}
+ */
+```
+
+## Resources
+
+* [Source](../../lib/rules/no-jsdoc-type-tabs.js)
+* [Tests](../../test/eslint/rules/no-jsdoc-type-tabs.js)

docs/rules/no-jsdoc-type-tabs.md

@@ -1,6 +1,6 @@
 # interfaced/no-public-underscore
 
-Disallow methods and properties with name that starts from `_` without `private`/`protected` access modifier.
+Disallow methods and properties with name that starts from "_" without private/protected access modifier.
 
 ## Resources