Merge pull request #98 from bem-sdk/issue-97

Deprecation

Author: blond

README.md

@@ -28,6 +28,7 @@ Contents
 * [API](#api)
 * [TypeScript support](#typescript-support)
 * [Debuggability](#debuggability)
+* [Deprecation](#deprecation)
 
 Install
 -------
@@ -360,6 +361,19 @@ console.log(JSON.stringify(name));
 // ➜ {"block":"input","mod":{"name":"available","val":true}}
 ```
 
+Deprecation
+-----------
+
+Deprecation is performed with [depd](https://github.com/dougwilson/nodejs-depd).
+
+To silencing deprecation warnings from being output use the `NO_DEPRECATION` environment variable.
+
+```
+NO_DEPRECATION=@bem/entity-name node app.js
+```
+
+> More [details](https://github.com/dougwilson/nodejs-depd#processenvno_deprecation) in `depd` documentation
+
 License
 -------
 

index.js

@@ -4,6 +4,7 @@ const util = require('util');
 
 const ExtendableError = require('es6-error');
 const stringifyEntity = require('@bem/naming').stringify;
+const deprecate = require('depd')(require('./package.json').name);
 
 /**
  * Enum for types of BEM entities.
@@ -114,19 +115,27 @@ class BemEntityName {
      * If entity is not modifier then returns `undefined`.
      *
      * @returns {?string} - entity modifier name.
-     * @deprecated - use `mod.name` instead.
+     * @deprecated use {@link BemEntityName#mod.name}
      */
-    get modName() { return this.mod && this.mod.name; }
+    get modName() {
+        deprecate(`modName is kept just for compatibility and can be dropped in the future. Use mod.name instead in ${this.inspect()} at`);
+
+        return this.mod && this.mod.name;
+    }
 
     /**
      * Returns the modifier value of this entity.
      *
      * If entity is not modifier then returns `undefined`.
      *
      * @returns {?(string|true)} - entity modifier name.
-     * @deprecated - use `mod.val` instead.
+     * @deprecated use {@link BemEntityName#mod.val}
      */
-    get modVal() { return this.mod && this.mod.val; }
+    get modVal() {
+        deprecate(`modVal is kept just for compatibility and can be dropped in the future. Use mod.val instead in ${this.inspect()} at`);
+
+        return this.mod && this.mod.val;
+    }
 
     /**
      * Returns id for this entity.

package.json

@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@bem/naming": "2.0.0-5",
+    "depd": "1.1.0",
     "es6-error": "4.0.2"
   },
   "devDependencies": {
@@ -51,7 +52,7 @@
   },
   "scripts": {
     "pretest": "npm run lint",
-    "test": "nyc ava",
+    "test": "NO_DEPRECATION=@bem/entity-name nyc ava",
     "lint": "npm run lint:js && npm run lint:dts",
     "lint:js": "eslint .",
     "lint:dts": "tslint **.d.ts",