build: generates build 0.1.0

Author: caiangums

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Codevor - js-library-boilerplate
+Copyright (c) 2019 Codevor - js-is-empty
 
 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,34 +1,49 @@
-# js-library-boilerplate
+# 📭Empty Checker
 
 [![License][license-badge]][license-url] [![Travis CI][travis-badge]][travis-url] [![Coverage Status][coverage-badge]][coverage-url] [![Commitizen][commitizen-badge]][commitizen-url]
 
-> js-library-boilerplate-description.
+📭`js-is-empty` makes your empty checks for you. We have empty checks for
+
+- `Array`
+- `Object`
+- `String`
 
 ## Installation
 
-js-library-boilerplate is available on npm/yarn:
+`js-is-empty` is available on npm/yarn:
 
 ```bash
-$ npm install js-library-boilerplate --save
-$ yarn add js-library-boilerplate
+$ npm install @codevor/js-is-empty --save
+$ yarn add @codevor/js-is-empty
 ```
 
 ## Usage
 
 ### With ES6/import
 
 ```js
-import { sum } from 'js-library-boilerplate';
+import { isArrayEmpty, isObjectEmpty } from '@codevor/js-is-empty';
+
+const myEmptyArray = [];
+const person = { name: 'John Doe', age: 32 };
 
-sum(2, 2); // => 4
+isArrayEmpty(myEmptyArray); // => true
+isObjectEmpty(person); // => false
 ```
 
 ### With require
 
 ```js
-const sum = require('js-library-boilerplate').sum;
+const jsIsEmpty = require('@codevor/js-is-empty');
+
+const isArrayEmpty = jsIsEmpty.isArrayEmpty;
+const isObjectEmpty = jsIsEmpty.isObjectEmpty;
+
+const myEmptyArray = [];
+const person = { name: 'John Doe', age: 32 };
 
-sum(2, 2); // => 4
+isArrayEmpty(myEmptyArray); // => true
+isObjectEmpty(person); // => false
 ```
 
 ## Contributing
@@ -37,21 +52,21 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 
 ## Changelog
 
-This project adheres to [Semantic Versioning](https://semver.org/). Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/codevor/js-library-boilerplate/releases) page.
+This project adheres to [Semantic Versioning](https://semver.org/). Every release, along with the migration instructions, is documented on the Github [Releases](https://github.com/codevor/js-is-empty/releases) page.
 
 ## Bugs and Sugestions
 
-Report bugs or do suggestions using the [issues](https://github.com/codevor/js-library-boilerplate/issues).
+Report bugs or do suggestions using the [issues](https://github.com/codevor/js-is-empty/issues).
 
 ## License
 
 [MIT License](LICENSE) © [Codevor](https://github.com/codevor)
 
-[license-badge]: https://img.shields.io/github/license/codevor/js-library-boilerplate.svg
+[license-badge]: https://img.shields.io/github/license/codevor/js-is-empty.svg
 [license-url]: https://opensource.org/licenses/MIT
-[coverage-badge]: https://coveralls.io/repos/github/codevor/js-library-boilerplate/badge.svg?branch=master
-[coverage-url]: https://coveralls.io/github/codevor/js-library-boilerplate?branch=master
-[travis-badge]: https://travis-ci.org/codevor/js-library-boilerplate.svg?branch=master
-[travis-url]: https://travis-ci.org/codevor/js-library-boilerplate
+[coverage-badge]: https://coveralls.io/repos/github/codevor/js-is-empty/badge.svg?branch=master
+[coverage-url]: https://coveralls.io/github/codevor/js-is-empty?branch=master
+[travis-badge]: https://travis-ci.org/codevor/js-is-empty.svg?branch=master
+[travis-url]: https://travis-ci.org/codevor/js-is-empty
 [commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
 [commitizen-url]: http://commitizen.github.io/cz-cli/

package.json

@@ -1,9 +1,9 @@
 {
-  "name": "js-library-boilerplate",
+  "name": "@codevor/js-is-empty",
   "version": "0.1.0",
-  "description": "js-library-boilerplate-description",
-  "main": "dist/js-library-boilerplate.js",
-  "unpkg": "dist/js-library-boilerplate.min.js",
+  "description": "📭Basic empty checker",
+  "main": "dist/js-is-empty.js",
+  "unpkg": "dist/js-is-empty.min.js",
   "scripts": {
     "clean": "rimraf dist",
     "dev": "NODE_ENV=dev webpack --progress --colors --watch",
@@ -15,17 +15,20 @@
     "prepublish": "yarn lint && yarn test && yarn clean && yarn build:umd",
     "commit": "git-cz"
   },
-  "keywords": [],
-  "author": "Helder Burato Berto <helder.burato@gmail.com> (https://helder.dev/)",
+  "keywords": [
+    "Utils",
+    "Empty Checker"
+  ],
+  "author": "Ilê Caian <ile.caian@gmail.com> (https://ile.pink/)",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/codevor/js-library-boilerplate.git"
+    "url": "git+https://github.com/codevor/js-is-empty.git"
   },
   "bugs": {
-    "url": "https://github.com/codevor/js-library-boilerplate/issues"
+    "url": "https://github.com/codevor/js-is-empty/issues"
   },
-  "homepage": "https://github.com/codevor/js-library-boilerplate#readme",
+  "homepage": "https://github.com/codevor/js-is-empty#readme",
   "devDependencies": {
     "@babel/cli": "^7.6.4",
     "@babel/core": "^7.6.4",
@@ -50,5 +53,8 @@
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"
     }
+  },
+  "dependencies": {
+    "@codevor/js-is-type": "^0.1.1"
   }
 }

src/index.js

@@ -1,3 +1,3 @@
-export function sum(x, y) {
-  return x + y;
-}
+export { default as isArrayEmpty } from './is-array-empty';
+export { default as isObjectEmpty } from './is-object-empty';
+export { default as isStringEmpty } from './is-string-empty';

src/is-array-empty.js

@@ -0,0 +1,5 @@
+import { isArray } from '@codevor/js-is-type';
+
+const isArrayEmpty = value => isArray(value) && value.length === 0;
+
+export default isArrayEmpty;

src/is-object-empty.js

@@ -0,0 +1,7 @@
+import { isObject } from '@codevor/js-is-type';
+
+import isArrayEmpty from './is-array-empty';
+
+const isObjectEmpty = value => isObject(value) && isArrayEmpty(Object.keys(value));
+
+export default isObjectEmpty;

src/is-string-empty.js

@@ -0,0 +1,5 @@
+import { isString } from '@codevor/js-is-type';
+
+const isStringEmpty = value => isString(value) && value.length === 0;
+
+export default isStringEmpty;

tests/is-array-empty.test.js

@@ -0,0 +1,24 @@
+import { isArrayEmpty } from '../src';
+
+describe('isArrayEmpty()', () => {
+  const arrayEmptyValue = [];
+  const arrayValue = [4, true, 'test'];
+  const stringValue = 'This is a string';
+  const booleanValue = true;
+
+  test('correct empty array should be valid', () => {
+    expect(isArrayEmpty(arrayEmptyValue)).toBeTruthy();
+  });
+
+  test('correct array but not empty should be invalid', () => {
+    expect(isArrayEmpty(arrayValue)).toBeFalsy();
+  });
+
+  test('string value should be invalid', () => {
+    expect(isArrayEmpty(stringValue)).toBeFalsy();
+  });
+
+  test('boolean value should be invalid', () => {
+    expect(isArrayEmpty(booleanValue)).toBeFalsy();
+  });
+});

tests/is-object-empty.test.js

@@ -0,0 +1,24 @@
+import { isObjectEmpty } from '../src';
+
+describe('isObjectEmpty()', () => {
+  const objectEmptyValue = {};
+  const objectValue = { age: 23, name: 'John Doe' };
+  const stringValue = 'Test string';
+  const arrayValue = [];
+
+  test('correct empty object should be valid', () => {
+    expect(isObjectEmpty(objectEmptyValue)).toBeTruthy();
+  });
+
+  test('correct object, but non empty should be invalid', () => {
+    expect(isObjectEmpty(objectValue)).toBeFalsy();
+  });
+
+  test('string value should be invalid', () => {
+    expect(isObjectEmpty(stringValue)).toBeFalsy();
+  });
+
+  test('array is kind of object but is not empty', () => {
+    expect(isObjectEmpty(arrayValue)).toBeFalsy();
+  });
+});

tests/is-string-empty.test.js

@@ -0,0 +1,24 @@
+import { isStringEmpty } from '../src';
+
+describe('isStringEmpty()', () => {
+  const stringEmptyValue = '';
+  const stringValue = 'This is a string';
+  const numberValue = 2;
+  const arrayValue = ['a', 5, true];
+
+  test('correct empty string should be valid', () => {
+    expect(isStringEmpty(stringEmptyValue)).toBeTruthy();
+  });
+
+  test('correct string, but non empty should be invalid', () => {
+    expect(isStringEmpty(stringValue)).toBeFalsy();
+  });
+
+  test('numper value should be invalid', () => {
+    expect(isStringEmpty(numberValue)).toBeFalsy();
+  });
+
+  test('array value should be invalid', () => {
+    expect(isStringEmpty(arrayValue)).toBeFalsy();
+  });
+});