Skip to content

Commit 791b2e5

Browse files
committed
release: v2.0.0
1 parent 45322d0 commit 791b2e5

36 files changed

+4149
-3085
lines changed

.eslintignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
dist
3+
reactComponentLib

.eslintrc.js

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
module.exports = {
2-
env: {
3-
browser: true,
4-
es6: true,
5-
node: true,
6-
},
7-
extends: 'airbnb-base',
8-
globals: {
9-
Atomics: 'readonly',
10-
SharedArrayBuffer: 'readonly',
11-
},
2+
parser: '@typescript-eslint/parser',
123
parserOptions: {
13-
ecmaVersion: 2018,
4+
ecmaVersion: 2020,
145
sourceType: 'module',
6+
ecmaFeatures: {
7+
jsx: true,
8+
},
9+
},
10+
settings: {
11+
react: {
12+
version: 'detect',
13+
},
1514
},
15+
extends: [
16+
'plugin:react/recommended',
17+
'plugin:@typescript-eslint/recommended',
18+
'plugin:prettier/recommended',
19+
'plugin:react-hooks/recommended',
20+
],
1621
rules: {
22+
'@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_|^req|^next' }],
23+
'react/prop-types': 0,
24+
'no-console': 'error',
1725
},
1826
};

.gitignore

100755100644
Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1+
.DS_Store
12
node_modules
2-
/coverage/
3-
settings.json
4-
lib/get-class-names.js
3+
dist
4+
.rpt2_cache
5+
docs/src/latest/

.npmignore

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
1-
src
2-
test.js
3-
static/*
4-
.circleci/*
1+
/docs/
2+
/src/
3+
/.vscode/
4+
/build/
5+
/test/
6+
README.md
7+
.prettierrc
8+
.npmrc
9+
.npmignore
10+
.gitignore
11+
.eslintignore
12+
.eslintrc.js

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
registry = "https://registry.npmjs.com/"

.prettierignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/dist/
2+
/node_modules/
3+
/build/
4+
/docs/src/latest/
5+
/docs/build/

.prettierrc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
{
2+
"semi": true,
3+
"trailingComma": "all",
24
"singleQuote": true,
3-
"useTabs": false,
4-
"printWidth": 80
5-
}
5+
"printWidth": 120,
6+
"tabWidth": 2
7+
}

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"jira-plugin.workingProject": ""
3+
}

README.md

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@
2323

2424
Features:
2525

26-
* Support string arguments.
27-
* Support number arguments.
28-
* Support object arguments.
29-
* Support array arguments.
30-
* Support function arguments.
31-
* No dependency.
26+
- Support string arguments.
27+
- Support number arguments.
28+
- Support object arguments.
29+
- Support array arguments.
30+
- Support function arguments.
31+
- No dependency.
3232

3333
## Quickstart - CommonJS
3434

@@ -44,73 +44,76 @@ yarn add dynamic-class-list
4444

4545
Then require it in your module ...
4646

47-
4847
```javascript
49-
var getClassNames = require('dynamic-class-list').getClassNames; // deprecated
50-
var classList = require('dynamic-class-list').classList;
48+
var cl = require('dynamic-class-list').cl;
5149
```
5250

5351
## OR using ES6 imports
5452

55-
5653
```javascript
57-
import { getClassNames, classList } from 'dynamic-class-list';
54+
import { cl } from 'dynamic-class-list';
5855
```
5956

60-
Note that `getClassNames` is deprecated and will be removed in next major release. You should use `classList` moving forward.
61-
6257
## API
6358

6459
### Arguments as strings
6560

6661
```javascript
67-
6862
// As Arguments
69-
getClassNames('class1', 'class2'); // Output ==> "class1 class2"
70-
// OR
71-
classList('class1', 'class2'); // Output ==> "class1 class2"
63+
cl('class1', 'class2'); // Output ==> "class1 class2"
7264
```
7365

7466
### Arguments as an array of strings
7567

76-
7768
```javascript
78-
classList(['class1', 'class2']); // Output ==> "class1 class2"
69+
cl(['class1', 'class2']); // Output ==> "class1 class2"
7970

80-
classList([null, undefined, 3, 'class1', 'class2']); // Output ==> "3 class1 class2"
71+
cl([null, undefined, 3, 'class1', 'class2']); // Output ==> "3 class1 class2"
8172
```
8273

8374
### Arguments as an object
8475

8576
`Note that the key is used as the class if its value is truthy`
8677

8778
```javascript
88-
classList({class1: true, class2 : false}); // Output ==> "class1"
79+
cl({ class1: true, class2: false }); // Output ==> "class1"
8980

90-
classList({class1: undefined, class2 : null, class3: true, class4: false}); // Output ==> "class3"
81+
cl({ class1: undefined, class2: null, class3: true, class4: false }); // Output ==> "class3"
9182
```
9283

9384
Note that the function **must** return a boolean.
9485

9586
```javascript
96-
classList({
97-
class1: function() { return false; },
98-
class2 : function() { return true; }
87+
cl({
88+
class1: function () {
89+
return false;
90+
},
91+
class2: function () {
92+
return true;
93+
},
9994
});
10095

10196
// Output ==> "class2"
10297
```
10398

104-
### Hybrid Arguments
99+
### Mixed Arguments Types
105100

106101
```javascript
107-
classList('class1', 'class2', 2, null, undefined, ['class3', null, undefined, 4, 'class4'], {
108-
class5 : function() { return false; },
109-
class6 : function() { return true; },
110-
class7: undefined,
111-
class8: true,
112-
class9: false
102+
cl('class1', 'class2', 2, null, undefined, ['class3', null, undefined, 4, 'class4'], {
103+
class5: function () {
104+
return false;
105+
},
106+
class6: function () {
107+
return true;
108+
},
109+
class7: undefined,
110+
class8: true,
111+
class9: false,
113112
});
114113

115114
// Output ==> "class1 class2 2 class3 4 class4 class6 class8"
116115
```
116+
117+
## License
118+
119+
MIT © [tusharf5](https://github.com/tusharf5)

coverage/clover.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<coverage generated="1631445301264" clover="3.2.0">
3+
<project timestamp="1631445301264" name="All files">
4+
<metrics statements="1" coveredstatements="1" conditionals="23" coveredconditionals="23" methods="8" coveredmethods="8" elements="32" coveredelements="32" complexity="0" loc="1" ncloc="1" packages="1" files="1" classes="1"/>
5+
<file name="index.cjs.js" path="/Users/tusharf5/dev/github/oss/dynamic-class-list/dist/index.cjs.js">
6+
<metrics statements="1" coveredstatements="1" conditionals="23" coveredconditionals="23" methods="8" coveredmethods="8"/>
7+
<line num="1" count="39" type="cond" truecount="23" falsecount="0"/>
8+
</file>
9+
</project>
10+
</coverage>

0 commit comments

Comments
 (0)