Merge pull request #113 from bem-sdk/fix/typings

Fix typings
bem-sdk-archive · Apr 20, 2017 · a97884b · a97884b
2 parents 9ac650f + cedd0ea
commit a97884b
Show file tree

Hide file tree

Showing 22 changed files with 110 additions and 115 deletions.
diff --git a/README.md b/README.md
@@ -393,7 +393,7 @@ TypeScript support
 
 The package includes [typings](./index.d.ts) for TypeScript. You have to set up transpilation yourself. When you set `module` to `commonjs` in your `tsconfig.json` file, TypeScript will automatically find the type definitions for `@bem/entity-name`.
 
-The interfaces are provided in global namespace `BemSDK.EntityName`. It is necessary to use interfaces in JsDoc.
+The interfaces are provided in global namespace `BEMSDK.EntityName`. It is necessary to use interfaces in JsDoc.
 
 Debuggability
 -------------

diff --git a/index.d.ts b/index.d.ts
@@ -1,27 +1,3 @@
-import './globals.d';
-
-declare class BemEntityName {
-    constructor(obj: BemSDK.EntityName.Options);
-
-    readonly block: string;
-    readonly elem: string | undefined;
-    readonly mod: BemSDK.EntityName.ModifierRepresentation | undefined;
-    readonly modName: string | undefined;
-    readonly modVal: string | true | undefined;
-    readonly type: BemSDK.EntityName.TYPE;
-    readonly scope: BemEntityName | null;
-    readonly id: string;
-
-    isSimpleMod(): boolean | null;
-    isEqual(entityName: BemEntityName): boolean;
-    belongsTo(entityName: BemEntityName): boolean;
-    valueOf(): BemSDK.EntityName.StrictRepresentation;
-    toJSON(): BemSDK.EntityName.StrictRepresentation;
-    toString(): string;
-    inspect(depth: number, options: object): string;
-
-    static create(obj: BemSDK.EntityName.NonStrictRepresentation | string): BemEntityName;
-    static isBemEntityName(entityName: any): boolean;
-}
+import BemEntityName from './types/entity-name.d';
 
 export = BemEntityName;
diff --git a/jsconfig.json b/jsconfig.json
@@ -1,10 +1,17 @@
 {
-    "compilerOptions": {
-        "target": "ES6",
-        "module": "commonjs"
-    },
-    "files": [
-        "index.js",
-        "index.d.ts"
-    ]
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "commonjs"
+  },
+  "include": [
+    "lib",
+    "types"
+  ],
+  "exclude": [
+    "node_modules"
+  ],
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ]
 }
diff --git a/lib/entity-name.js b/lib/entity-name.js
@@ -22,7 +22,7 @@ const TYPES = {
 
 class BemEntityName {
     /**
-     * @param {BemSDK.EntityName.Options} obj — representation of entity name.
+     * @param {BEMSDK.EntityName.Options} obj — representation of entity name.
      */
     constructor(obj) {
         if (!obj.block) {
@@ -61,7 +61,7 @@ class BemEntityName {
      *
      * name.block; // button
      *
-     * @returns {string} name of entity block.
+     * @returns {BEMSDK.EntityName.BlockName} name of entity block.
      */
     get block() { return this._data.block; }
 
@@ -76,7 +76,7 @@ class BemEntityName {
      *
      * name.elem; // text
      *
-     * @returns {?string} - name of entity element.
+     * @returns {?BEMSDK.EntityName.ElementName} - name of entity element.
      */
     get elem() { return this._data.elem; }
 
@@ -94,7 +94,7 @@ class BemEntityName {
      * modName.mod;   // { name: 'disabled', val: true }
      * blockName.mod; // undefined
      *
-     * @returns {?BemSDK.EntityName.ModifierRepresentation} - entity modifier.
+     * @returns {?BEMSDK.EntityName.Modifier} - entity modifier.
      */
     get mod() { return this._data.mod; }
 
@@ -103,7 +103,7 @@ class BemEntityName {
      *
      * If entity is not modifier then returns `undefined`.
      *
-     * @returns {?string} - entity modifier name.
+     * @returns {?BEMSDK.EntityName.ModifierName} - entity modifier name.
      * @deprecated use {@link BemEntityName#mod.name}
      */
     get modName() {
@@ -117,7 +117,7 @@ class BemEntityName {
      *
      * If entity is not modifier then returns `undefined`.
      *
-     * @returns {?(string|true)} - entity modifier name.
+     * @returns {?BEMSDK.EntityName.ModifierValue} - entity modifier name.
      * @deprecated use {@link BemEntityName#mod.val}
      */
     get modVal() {
@@ -141,7 +141,7 @@ class BemEntityName {
      *
      * name.type; // elemMod
      *
-     * @returns {string} - type of entity. One of 'block', 'elem', 'blockMod', 'elemMod'.
+     * @returns {BEMSDK.EntityName.Type} - type of entity.
      */
     get type() {
         if (this._type) { return this._type; }
@@ -172,7 +172,7 @@ class BemEntityName {
      * buttonTextName.scope;     // BemEntityName { block: 'button' }
      * buttonTextBoldName.scope; // BemEntityName { block: 'button', elem: 'elem' }
      *
-     * @returns {BemEntityName} - scope entity name.
+     * @returns {(BemEntityName|null)} - scope entity name.
      */
     get scope() {
         if (this.type === TYPES.BLOCK) { return null; }
@@ -200,7 +200,7 @@ class BemEntityName {
      *
      * name.id; // button_disabled
      *
-     * @returns {string} - id of entity.
+     * @returns {BEMSDK.EntityName.Id} - id of entity.
      */
     get id() {
         if (this._id) { return this._id; }
@@ -300,7 +300,7 @@ class BemEntityName {
      *
      * // ➜ { block: 'button', mod: { name: 'focused', value: true } }
      *
-     * @returns {BemSDK.EntityName.StrictRepresentation}
+     * @returns {BEMSDK.EntityName.Representation}
      */
     valueOf() { return this._data; }
 
@@ -314,7 +314,7 @@ class BemEntityName {
      *
      * JSON.stringify(name); // {"block":"input","mod":{"name":"available","val":true}}
      *
-     * @returns {BemSDK.EntityName.StrictRepresentation}
+     * @returns {BEMSDK.EntityName.Representation}
      */
     toJSON() {
         return this._data;
@@ -373,7 +373,7 @@ class BemEntityName {
      * BemEntityName.create({ block: 'my-button', modName: 'theme', modVal: 'red' });
      * // → BemEntityName { block: 'my-button', mod: { name: 'theme', val: 'red' } }
      *
-     * @param {(BemSDK.EntityName.NonStrictRepresentation|string)} obj — representation of entity name.
+     * @param {(BEMSDK.EntityName.CreateOptions|string)} obj — representation of entity name.
      * @returns {BemEntityName} An object representing entity name.
      */
     static create(obj) {

diff --git a/package.json b/package.json
@@ -25,9 +25,9 @@
   "typings": "index.d.ts",
   "files": [
     "lib/**",
+    "types/**",
     "index.js",
-    "index.d.ts",
-    "globals.d.ts"
+    "index.d.ts"
   ],
   "engines": {
     "node": ">= 4.0"
@@ -38,6 +38,7 @@
     "es6-error": "4.0.2"
   },
   "devDependencies": {
+    "@types/node": "^4.2.5",
     "@types/proxyquire": "^1.3.27",
     "@types/sinon": "^2.1.2",
     "ava": "^0.19.0",
@@ -56,7 +57,7 @@
     "test": "nyc ava",
     "lint": "npm run lint:js && npm run lint:dts",
     "lint:js": "eslint .",
-    "lint:dts": "tslint **.d.ts",
+    "lint:dts": "tslint types/*.d.ts",
     "coveralls": "nyc report --reporter=text-lcov | coveralls"
   },
   "ava": {

diff --git a/test/belongs-to.test.js b/test/belongs-to.test.js
@@ -1,6 +1,6 @@
-const test = require('ava');
+import test from 'ava';
 
-const BemEntityName = require('../lib/entity-name');
+import BemEntityName from '..';
 
 test('should not detect belonging between block and itself', t => {
     const blockName = new BemEntityName({ block: 'block' });

diff --git a/test/bem-fields.test.js b/test/bem-fields.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should provide `block` field', t => {
     const entityName = new BemEntityName({ block: 'block' });

diff --git a/test/create.test.js b/test/create.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should return object as is if it`s a BemEntityName', t => {
     const entityName = new BemEntityName({ block: 'block' });

diff --git a/test/deprecate.test.js b/test/deprecate.test.js
@@ -1,8 +1,8 @@
-const test = require('ava');
-const sinon = require('sinon');
-const proxyquire = require('proxyquire');
+import test from 'ava';
+import sinon from 'sinon';
+import proxyquire from 'proxyquire';
 
-const BemEntityName = require('../lib/entity-name');
+import BemEntityName from '..';
 
 const deprecateSpy = sinon.spy();
 const deprecate = proxyquire('../lib/deprecate', {

diff --git a/test/entity-type-error.test.js b/test/entity-type-error.test.js
@@ -1,6 +1,6 @@
-const test = require('ava');
+import test from 'ava';
 
-const EntityTypeError = require('../lib/entity-type-error');
+import EntityTypeError from '../lib/entity-type-error';
 
 test('should create type error', t => {
     const error = new EntityTypeError();

diff --git a/test/id.test.js b/test/id.test.js
@@ -1,8 +1,8 @@
 import test from 'ava';
-const sinon = require('sinon');
-const proxyquire = require('proxyquire');
+import sinon from 'sinon';
+import proxyquire from 'proxyquire';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should build equal id for equal blocks', t => {
     const entityName1 = new BemEntityName({ block: 'block' });

diff --git a/test/inspect.test.js b/test/inspect.test.js
@@ -1,9 +1,9 @@
-import test from 'ava';
-const sinon = require('sinon');
+import {EOL} from 'os';
 
-import BemEntityName from '../lib/entity-name';
+import test from 'ava';
+import sinon from 'sinon';
 
-const EOL = require('os').EOL;
+import BemEntityName from '..';
 
 test.beforeEach(t => {
     t.context.stdoutWriteStub = sinon.stub(process.stdout, 'write');

diff --git a/test/is-bem-entity-name.test.js b/test/is-bem-entity-name.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should check valid entities', t => {
     const entityName = new BemEntityName({ block: 'block' });

diff --git a/test/is-equal.test.js b/test/is-equal.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should detect equal block', t => {
     const entityName1 = new BemEntityName({ block: 'block' });

diff --git a/test/is-simple-mod.test.js b/test/is-simple-mod.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should be true for simple modifiers', t => {
     const entityName = new BemEntityName({ block: 'block', mod: 'mod' });

diff --git a/test/scope.test.js b/test/scope.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should return scope of block', t => {
     const entityName = new BemEntityName({ block: 'block' });

diff --git a/test/to-json.test.js b/test/to-json.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should create stringified object', t => {
     const entityName = new BemEntityName({ block: 'button' });

diff --git a/test/to-string.test.js b/test/to-string.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
-const sinon = require('sinon');
-const proxyquire = require('proxyquire');
+import sinon from 'sinon';
+import proxyquire from 'proxyquire';
 
 const spy = sinon.spy();
 const BemEntityName = proxyquire('../lib/entity-name', {

diff --git a/test/type.test.js b/test/type.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should determine block', t => {
     const entityName = new BemEntityName({ block: 'block' });

diff --git a/test/value-of.test.js b/test/value-of.test.js
@@ -1,6 +1,6 @@
 import test from 'ava';
 
-import BemEntityName from '../lib/entity-name';
+import BemEntityName from '..';
 
 test('should return normalized object', t => {
     const entity = new BemEntityName({ block: 'block', mod: 'mod' });

diff --git a/types/entity-name.d.ts b/types/entity-name.d.ts
@@ -0,0 +1,27 @@
+import './globals.d';
+
+declare class BemEntityName {
+    constructor(obj: BEMSDK.EntityName.Options);
+
+    readonly block: BEMSDK.EntityName.BlockName;
+    readonly elem: BEMSDK.EntityName.ElementName | undefined;
+    readonly mod: BEMSDK.EntityName.Modifier | undefined;
+    readonly modName: BEMSDK.EntityName.ModifierName | undefined;
+    readonly modVal: BEMSDK.EntityName.ModifierValue | undefined;
+    readonly type: BEMSDK.EntityName.Type;
+    readonly scope: BemEntityName | null;
+    readonly id: BEMSDK.EntityName.Id;
+
+    isSimpleMod(): boolean | null;
+    isEqual(entityName: BemEntityName): boolean;
+    belongsTo(entityName: BemEntityName): boolean;
+    valueOf(): BEMSDK.EntityName.Representation;
+    toJSON(): BEMSDK.EntityName.Representation;
+    toString(): string;
+    inspect(depth: number, options: object): string;
+
+    static create(obj: BEMSDK.EntityName.CreateOptions | string): BemEntityName;
+    static isBemEntityName(entityName: any): boolean;
+}
+
+export = BemEntityName;