coderdiaz · coderdiaz · Jul 7, 2019 · Jul 7, 2019 · Jul 7, 2019 · Jul 7, 2019
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,12 @@
+{
+  "presets": [
+    ["env", { "modules": false }]
+  ],
+  "env": {
+    "test": {
+      "presets": [
+        ["env", { "targets": { "node": "current" } }]
+      ]
+    }
+  }
+}
diff --git a/.editorconfig b/.editorconfig
@@ -6,4 +6,4 @@ indent_style = space
 indent_size = 2
 end_of_line = lf
 insert_final_newline = true
-trim_trailing_whitespace = true
+trim_trailing_whitespace = true
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,2 @@
-/dist
-/node_modules
+dist/
+node_modules/
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -14,4 +14,4 @@ module.exports = {
   parserOptions: {
     parser: 'babel-eslint',
   },
-};
+};
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,29 @@
+## Issue report
+
+## Current behavior
+<!-- Describe how the issue manifests. -->
+
+## Input Code
+<!-- REPL or Repo link if applicable: -->
+```js
+const your = (code) => here;
+```
+
+## Expected behavior
+<!-- A clear and concise description of what you expected to happen (or code). -->
+
+## Posible solution
+<!-- Only if you have suggestions on a fix for the bug -->
+
+## Environment
+<pre><code>
+Plugin version: X.Y.Z
+<!-- Check whether this is still an issue in the most recent version -->
+
+For tooling issue:
+- Node version: XX <!-- run `node --version` -->
+- Platform: <!-- Mac, Linux, Windows -->
+
+Others:
+<!-- Anything else relevant? Operating system version, IDE, package manager, etc. -->
+</pre></code>
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,32 @@
+## PR Checklist
+Please check if your PR fulfills the following requirements:
+
+- [ ] The commit message follows our guidelines: https://github.com/coderdiaz/vue-tiny-pagination/blob/master/CONTRIBUTING.md
+- [ ] Tests for the changes have been added (for bug fixes / features).
+- [ ] Docs have been added / updated (for bug fixes / features).
+
+## PR Type
+What kind of change does this PR introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+```
+[ ] Bugfixes
+[ ] Feature
+[ ] Code style update (formatting, local variables)
+[ ] Refactoring (no functional changes, no api changes)
+[ ] Build related changes
+[ ] CI related changes
+[ ] Other... Please describe:
+```
+
+## What is the current behavior?
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+## What is the new behaviour?
+
+## Does this PR introduce a breaking change?
+```
+[ ] Yes
+[ ] No
+```
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,13 @@
-.DS_Store
 node_modules/
 dist/
 coverage/
-npm-debug.log
 yarn-error.log
+npm-debug.log
+.DS_Store
 
-# Editor directories and files
+# Editor directories
 .idea
 *.suo
 *.ntvs*
 *.njsproj
-*.sln
+*.sln
diff --git a/.travis.yml b/.travis.yml
@@ -4,9 +4,8 @@ node_js:
   - 10
 cache:
   yarn: true
-  directories:
-    - node_modules
+  directories: node_modules
 install:
-  - yarn install
+  - yarn
 script:
   - yarn test:unit
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1 +1,48 @@
 ## Contribute
+We would love for you to contribute and help make it even better than it is todat! As a contributor, here are the guidelines we would like you to follow:
+
+## Development Setup
+You will need Node.js version +8.9.0.
+1. After clonning the repo, run:
+```bash
+$ npm i # or yarn install
+```
+
+### Commonly use NPM scripts
+```bash
+# build all packages
+$ npm run build
+
+# run full unit-tests suite
+$ npm run test:unit
+
+# run linter
+$ npm run lint
+```
+
+## Found a Bug?
+If you find a bug in source code, you can help us by submitting an issue to our GitHub repository. Even better, you can submit a Pull Request with a fix.
+
+## Missing a Feature?
+You can request a new feature by submitting an issue to our GitHub repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
+- For a **Major Feature**, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted in the project. For your issue name, please prefix your proposal with `[discussion]`, for example "[discussion]: your feature idea".
+- **Small Features** can be crafted and firectly submitted as a Pull Request.
+
+## Coding Rules
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+- All feature or bug fixes **must be tested** by one or more specs (unit-tests).
+- We follow [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript), but wrap all code at **100 characters**.
+
+## Commit Message Guidelines
+We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. But also, we use git commit messages to **generate the change log**.
+
+### Type
+Must be one of the following:
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).
+- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs).
+- **docs**: Documentation only changes.
+- **feature**: A new feature.
+- **bugfix**: A bug fix.
+- **refactor**: A code change that neither fixes a bug nor adds a feature.
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
+- **test**: Adding missing tests or correcting existing tests.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Javier Diaz Chamorro
+Copyright (c) 2018-2019 Javier Diaz Chamorro
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,12 +1,6 @@
 <p align="center">
-  <a href="https://github.com/coderdiaz/vue-tiny-pagination">
-    <img src="https://vuejs.org/images/logo.png" width="120">
-  </a>
-  <h2 align="center">&lt;vue-tiny-pagination /&gt;</h2>
-</p>
-
-<p align="center">
-  A Vue component for create a tiny pagination with Flexbox
+  <a href="#"><img src="logotype.png" width="380"></a>
+  <h4 align="center">A Vue component for create a tiny pagination with Flexbox</h4>
 </p>
 
 <p align="center">
@@ -15,71 +9,92 @@
     <a href="https://github.com/coderdiaz/vue-tiny-pagination/stargazers"><img src="https://img.shields.io/github/stars/coderdiaz/vue-tiny-pagination.svg?style=flat-square"></a>
     <a href="http://npmjs.com/package/vue-tiny-pagination"><img src="https://img.shields.io/npm/v/vue-tiny-pagination.svg?style=flat-square"></a>
     <a href="http://npmjs.com/package/vue-tiny-pagination"><img src="https://img.shields.io/npm/dm/vue-tiny-pagination.svg?style=flat-square"></a>
-    <a href="https://www.paypal.me/coderdiaz"><img src="https://img.shields.io/badge/invite-coffee-red.svg?style=flat-square"></a>
     <a href="https://travis-ci.org/coderdiaz/vue-tiny-pagination"><img src="https://travis-ci.org/coderdiaz/vue-tiny-pagination.svg?branch=master&style=flat-square"></a>
-</a>
+</p>
 
 ---
 
-### Install/Usage
-
-```
+## Install/Usage
+<!-- Replace the docs for usage the plugin -->
+```sh
+# Install with npm
 $ npm i -S vue-tiny-pagination
+
+# or yarn
+$ yarn add vue-tiny-pagination
 ```
 
 ```html
-<div id="#app">
+<div id="app">
   <tiny-pagination
     :total="currentTotal"
-    @tiny:change-page="changePage"></tiny-pagination>
+    @tiny:change-page="changePage" />
 </div>
 ```
 
-You can use **local registration**
-```javascript
-import {TinyPagination} from 'vue-tiny-pagination'
-
+You can use **Local Registration**:
+```js
+import { TinyPagination } from 'vue-tiny-pagination';
 new Vue({
   el: '#app',
   data() {
     return {
       currentTotal: 100,
-      currentPage: 1
-    }
+      currentPage: 1,
+    };
   },
   methods: {
     changePage (pagination) {
-      this.currentPage = pagination.page
-    }
+      this.currentPage = pagination.page;
+    },
   },
   components: {
-    TinyPagination
-  }
+    TinyPagination,
+  },
 });
 ```
-or **global registration**
-```javascript
-import TinyPagination from 'vue-tiny-pagination'
-Vue.use(TinyPagination)
-```
 
-### Usage in browser
+or **Global Registration**:
+```js
+import TinyPagination from 'vue-tiny-pagination';
+Vue.use(TinyPagination);
 
-In browser you can use Unpkg:
-```
-https://unpkg.com/vue-tiny-pagination@latest/dist/vue-tiny-pagination.js
+// or with a custom component name
+import { TinyPagination } from 'vue-tiny-pagination';
+Vue.component('custom-name', TinyPagination);
 ```
 
-Example in browser here: https://jsfiddle.net/coderdiaz/da7h5wnk/
-
-### Documentation
-
-For see the complete documentation go to the [official website](https://coderdiaz.me/vue-tiny-pagination).
-
-### Contributions
-All contributions are welcome send your PR and Issues.
+### Usage in browser
+<!-- Write an example for use the plugin in browser from CDN -->
+In browser you can use Unpkg, Jsdelivr, CDN.js, etc.
+```sh
+# Unpkg
+https://unpkg.com/vue-tiny-pagination@latest/dist/vue-tiny-pagination.js
 
-### License
-This is a open-source software licensed under the [MIT license](https://raw.githubusercontent.com/coderdiaz/vue-tiny-pagination/master/LICENSE)
+# JSDelivr
+https://cdn.jsdelivr.net/npm/vue-tiny-pagination@latest/dist/vue-tiny-pagination.min.js
+```
 
-##### Crafted by Javier Diaz
+## Documentation
+<!-- Add all documentation about the plugin: props, events, etc -->
+### Props
+|Name|Description|Type|Default|Required|
+|---|---|---|---|---|
+|total|A number of total items|Number|-|true|
+|page|Prop to set a default page|Number|1|false|
+|lang|Default language to show (Available: en, es)|String|en|false|
+|customClass|Prop to set a custom class.|String|""|false|
+|limits|Prop to set a default limits to page sizes.|Array|[10, 15, 20,50,100]|false|
+|showLimit|Prop to disable the limit selector|Boolean|true|false|
+
+### Events
+|Event|Description|
+|---|---|
+|tiny:change-page|Get the current page from pagination `payload: { page: 1 }`|
+|tiny:change-limit|Get the current limit from pagination `payload: { limit: 1 }`|
+
+## Community
+All feedback and suggestions are welcome!
+
+## License
+This is a open-source software licensed under the [MIT license](https://raw.githubusercontent.com/coderdiaz/vue-tiny-pagination/master/LICENSE)
diff --git a/babel.config.js b/babel.config.js
diff --git a/bili.config.ts b/bili.config.ts
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,4 +14,4 @@ module.exports = { @@
       parserOptions: {
         parser: 'babel-eslint',
       },
-    };
+    };