Skip to content
This repository was archived by the owner on Feb 4, 2018. It is now read-only.

Commit f503b6b

Browse files
authored
Merge pull request #62 from bem-sdk/npm-scope
chore(package): use NPM scope `@bem`
2 parents 919c7b0 + 6b2c1dd commit f503b6b

File tree

3 files changed

+24
-24
lines changed

3 files changed

+24
-24
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ Install
2424
-------
2525

2626
```
27-
$ npm install --save bem-entity-name
27+
$ npm install --save @bem/entity-name
2828
```
2929

3030
Usage
3131
-----
3232

3333
```js
34-
const BemEntityName = require('bem-entity-name');
34+
const BemEntityName = require('@bem/entity-name');
3535

3636
const entityName = new BemEntityName({ block: 'button', elem: 'text' });
3737

@@ -60,7 +60,7 @@ The modifier consists of a pair of fields `mod.name` and `mod.val`. This means t
6060
**Example:**
6161

6262
```js
63-
const BemEntityName = require('bem-entity-name');
63+
const BemEntityName = require('@bem/entity-name');
6464

6565
// The modifier of block
6666
new BemEntityName({
@@ -120,7 +120,7 @@ Parameter | Type | Description
120120
The name of block to which this entity belongs.
121121

122122
```js
123-
const BemEntityName = require('bem-entity-name');
123+
const BemEntityName = require('@bem/entity-name');
124124
const name = new BemEntityName({ block: 'button' });
125125

126126
name.block; // button
@@ -133,7 +133,7 @@ The element name of this entity.
133133
If entity is not element or modifier of element then returns empty string.
134134

135135
```js
136-
const BemEntityName = require('bem-entity-name');
136+
const BemEntityName = require('@bem/entity-name');
137137
const name = new BemEntityName({ block: 'button', elem: 'text' });
138138

139139
name.elem; // text
@@ -146,7 +146,7 @@ The modifier of this entity.
146146
**Important:** If entity is not a modifier then returns `undefined`.
147147

148148
```js
149-
const BemEntityName = require('bem-entity-name');
149+
const BemEntityName = require('@bem/entity-name');
150150

151151
const blockName = new BemEntityName({ block: 'button' });
152152
const modName = new BemEntityName({ block: 'button', mod: 'disabled' });
@@ -164,7 +164,7 @@ The id for this entity.
164164
If you want to get string representation in accordance with the provisions naming convention you should use [bem-naming](https://github.com/bem-sdk/bem-naming) package.
165165

166166
```js
167-
const BemEntityName = require('bem-entity-name');
167+
const BemEntityName = require('@bem/entity-name');
168168
const name = new BemEntityName({ block: 'button', mod: 'disabled' });
169169

170170
name.id; // button_disabled
@@ -177,7 +177,7 @@ The type for this entity.
177177
Possible values: `block`, `elem`, `blockMod`, `elemMod`.
178178

179179
```js
180-
const BemEntityName = require('bem-entity-name');
180+
const BemEntityName = require('@bem/entity-name');
181181

182182
const elemName = new BemEntityName({ block: 'button', elem: 'text' });
183183
const modName = new BemEntityName({ block: 'menu', elem: 'item', mod: 'current' });
@@ -196,7 +196,7 @@ Parameter | Type | Description
196196
Determines whether specified entity is the deepEqual entity.
197197

198198
```js
199-
const BemEntityName = require('bem-entity-name');
199+
const BemEntityName = require('@bem/entity-name');
200200

201201
const inputName = new BemEntityName({ block: 'input' });
202202
const buttonName = new BemEntityName({ block: 'button' });
@@ -213,7 +213,7 @@ Returns string representing the entity name.
213213
you should use [bem-naming](https://github.com/bem-sdk/bem-naming) package.
214214

215215
```js
216-
const BemEntityName = require('bem-entity-name');
216+
const BemEntityName = require('@bem/entity-name');
217217
const name = new BemEntityName({ block: 'button', mod: 'focused' });
218218

219219
name.toString(); // button_focused
@@ -224,7 +224,7 @@ name.toString(); // button_focused
224224
Returns object representing the entity name.
225225

226226
```js
227-
const BemEntityName = require('bem-entity-name');
227+
const BemEntityName = require('@bem/entity-name');
228228
const name = new BemEntityName({ block: 'button', mod: 'focused' });
229229

230230
name.valueOf();
@@ -240,7 +240,7 @@ In Node.js, `console.log()` calls `util.inspect()` on each argument without a fo
240240
`BemEntityName` has `inspect()` method to get custom string representation of the object.
241241

242242
```js
243-
const BemEntityName = require('bem-entity-name');
243+
const BemEntityName = require('@bem/entity-name');
244244

245245
const name = new BemEntityName({ block: 'input', mod: 'disabled' });
246246

@@ -252,7 +252,7 @@ console.log(name);
252252
You can also convert `BemEntityName` object to `string`.
253253

254254
```js
255-
const BemEntityName = require('bem-entity-name');
255+
const BemEntityName = require('@bem/entity-name');
256256

257257
const name = new BemEntityName({ block: 'input', mod: 'disabled' });
258258

index.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ module.exports = class BemEntityName {
5353
* Returns the name of block to which this entity belongs.
5454
*
5555
* @example
56-
* const BemEntityName = require('bem-entity-name');
56+
* const BemEntityName = require('@bem/entity-name');
5757
* const name = new BemEntityName({ block: 'button' });
5858
*
5959
* name.block; // button
@@ -68,7 +68,7 @@ module.exports = class BemEntityName {
6868
* If entity is not element or modifier of element then returns empty string.
6969
*
7070
* @example
71-
* const BemEntityName = require('bem-entity-name');
71+
* const BemEntityName = require('@bem/entity-name');
7272
* const name = new BemEntityName({ block: 'button', elem: 'text' });
7373
*
7474
* name.elem; // text
@@ -83,7 +83,7 @@ module.exports = class BemEntityName {
8383
* Important: If entity is not a modifier then returns `undefined`.
8484
*
8585
* @example
86-
* const BemEntityName = require('bem-entity-name');
86+
* const BemEntityName = require('@bem/entity-name');
8787
*
8888
* const blockName = new BemEntityName({ block: 'button' });
8989
* const modName = new BemEntityName({ block: 'button', mod: 'disabled' });
@@ -124,7 +124,7 @@ module.exports = class BemEntityName {
124124
* you should use `bem-naming` package.
125125
*
126126
* @example
127-
* const BemEntityName = require('bem-entity-name');
127+
* const BemEntityName = require('@bem/entity-name');
128128
* const name = new BemEntityName({ block: 'button', mod: 'disabled' });
129129
*
130130
* name.id; // button_disabled
@@ -149,13 +149,13 @@ module.exports = class BemEntityName {
149149
* Returns type for this entity.
150150
*
151151
* @example <caption>type of element</caption>
152-
* const BemEntityName = require('bem-entity-name');
152+
* const BemEntityName = require('@bem/entity-name');
153153
* const name = new BemEntityName({ block: 'button', elem: 'text' });
154154
*
155155
* name.type; // elem
156156
*
157157
* @example <caption>type of element modifier</caption>
158-
* const BemEntityName = require('bem-entity-name');
158+
* const BemEntityName = require('@bem/entity-name');
159159
* const name = new BemEntityName({ block: 'menu', elem: 'item', mod: 'current' });
160160
*
161161
* name.type; // elemMod
@@ -181,7 +181,7 @@ module.exports = class BemEntityName {
181181
* you should use `bem-naming` package.
182182
*
183183
* @example
184-
* const BemEntityName = require('bem-entity-name');
184+
* const BemEntityName = require('@bem/entity-name');
185185
* const name = new BemEntityName({ block: 'button', mod: 'focused' });
186186
*
187187
* name.toString(); // button_focused
@@ -200,7 +200,7 @@ module.exports = class BemEntityName {
200200
* without private and deprecated fields (`modName` and `modVal`).
201201
*
202202
* @example
203-
* const BemEntityName = require('bem-entity-name');
203+
* const BemEntityName = require('@bem/entity-name');
204204
* const name = new BemEntityName({ block: 'button', mod: 'focused' });
205205
*
206206
* name.valueOf();
@@ -221,7 +221,7 @@ module.exports = class BemEntityName {
221221
* without private and deprecated fields (`modName` and `modVal`).
222222
*
223223
* @example
224-
* const BemEntityName = require('bem-entity-name');
224+
* const BemEntityName = require('@bem/entity-name');
225225
* const name = new BemEntityName({ block: 'button' });
226226
*
227227
* console.log(name); // BemEntityName { block: 'button' }
@@ -245,7 +245,7 @@ module.exports = class BemEntityName {
245245
*
246246
* @returns {boolean} A Boolean indicating whether or not specified entity is the deepEqual entity.
247247
* @example
248-
* const BemEntityName = require('bem-entity-name');
248+
* const BemEntityName = require('@bem/entity-name');
249249
*
250250
* const inputName = new BemEntityName({ block: 'input' });
251251
* const buttonName = new BemEntityName({ block: 'button' });

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "bem-entity-name",
2+
"name": "@bem/entity-name",
33
"version": "0.0.2",
44
"description": "BEM entity name representation",
55
"license": "MPL-2.0",

0 commit comments

Comments
 (0)